当記事では、ログフォワーダー「okurun.jar」についての説明を記載します。

更新履歴

2021/2/12

• バージョン1.0.0リリースしました。

2021/11/29

• バージョン1.1.0リリースしました。
• 『TCPとUDPによるログ送信時のログメッセージ長について」という項目を追加しました。
• 『「okurun.jar」の使用方法について』に「okurun.jar」のバージョン確認方法並びに新たなOPTIONについての記載を追加しました。

更新内容

バージョン1.0.0

• 新規公開しました。機能については《「okurun.jar」の使用方法について》を参照してください。

バージョン1.1.0

• TCPにてメッセージを送信する時、1KB以上であっても同一のSOCKETで送信出来るようになりました。
• TCPにてメッセージを送信する時、1KB以上のメッセージであっても分割せずに1つのメッセージとして送信出来るようになりました。
• UDPにてメッセージを送信する時、メッセージの最大サイズを「-maxbuffer 」OPTIONにて変更出来るようになりました。

「okurun.jar」とは

「okurun.jar」はLogStare社にて開発した無償ログフォワーダーツールになります。

「okurun.jar」の使用方法について

「okurun.jar」の使用方法は下記になります。

# java -jar okurun.jar -h
Free Syslog Forwarding Tool "okurun.jar" by LogStare Inc.

!!! WARNING !!!
Please note that we cannot answer any questions concerning use of this tool.
Unauthorized reproduction prohibited.
Please use it at your own risk.

Usage: java -jar okurun.jar [target_file] [encoding] [protocol:(tcp|udp)] [targetIp] [port] [level] [facility] [header:(Y:N)] [ignoreEmpty:(Y:N)]
  - target_file => monitoring target file path
  - encoding => UTF-8: file encoding
  - level => DEBUG|INFO|NOTICE|WARN|ERROR|CRITICAL|ALERT|EMERGENCY
  - facility => KERN|USER|MAIL|DAEMON|AUTH|SYSLOG|LPR|NEWS|UUCP|CRON|AUTHPRIV|FTP|LOCAL0~LOCAL7
  - header => Y: Generate the header part contains a timestamp and an indication of the hostname or IP address of the device
  - ignoreEmpty => Y: Ignore empty line or spaces only

「okurun.jar」の各パラメータについて、詳細は下記の通りです。

• target_file:syslogとして転送したいメッセージを書き出すファイルをフルパスで指定します。
• encoding:メッセージの文字コードを指定します。通常は「UTF-8」を指定します。
• protocol:転送プロトコルを指定します。tcpもしくはudpを指定します。
• targetIp:転送先のサーバIPを指定します。
• port:ポート番号を指定します。通常は「514」を指定します。
• level:syslogのプライオリティを指定します。
• facility:syslogのファシリティを指定します。
• header:メッセージの先頭にsyslogヘッダーを付与するかを選択します。「Y」なら付与し、「N」なら付与しません。

ヘッダーを付与した場合

Jan 25 07:11:05 ip-172-31-18-94.ap-northeast-1.compute.internal {"host":{"host":"Zabbix server","name":"Zabbix server"},"groups":["Zabbix servers"],"applications":["CPU"],"itemid":29164,"name":"CPU guest nice time","clock":1611558664,"ns":510793391,"value":0.000000,"type":0}

ヘッダーを付与しない場合

{"host":{"host":"Zabbix server","name":"Zabbix server"},"groups":["Zabbix servers"],"applications":["Disk xvda"],"itemid":33061,"name":"xvda: Disk read request avg waiting time (r_await)","clock":1611554581,"ns":526226803,"value":1.020376,"type":0}

• ignoreEmpty:ファイルに書きこまれたメッセージが空文字もしくはNULLの場合に処理をスキップするかを選択します。通常は「N」にて問題ございません。
• -maxbuffer:UDPでのメッセージ送信における最大メッセージサイズを指定します。指定しない場合は1020バイト(1024バイト-ヘッダサイズ4バイト)です。最大4096バイトまで指定出来ます。なお、OPTIONとして4096バイトを指定した場合でもヘッダサイズ4バイト分が含まれますので、実際は4092バイトまで1行のログメッセージとして送信出来ます。下記は最大メッセージサイズとして2048バイトを指定する場合のコマンド例になります。

java -jar okurun.jar /home/syslog-gen/okurun/test.txt UTF-8 udp 192.168.0.2 514 debug syslog N N -maxbuffer 2048

「okurun.jar」のバージョン確認方法は下記になります。

# java -jar okurun.jar -v
Copyright (C) LogStare Inc. All Rights Reserved.
https://www.logstare.com/ 
version 1.1.0

TCPとUDPによるログ送信時のログメッセージ長について

「okurun.jar」の具体的な利用例について

「okurun.jar」の利用例につきましては以下の記事をご参照ください。

WindowsのIISアクセスログをLSCにて収集する方法
Microsoft Defender ファイアウォールのログをLSCにて収集する方法
Windows Server DNSのデバッグログをLSCにて収集する方法

「okurun.jar」の入手方法について

「okurun.jar」は下記よりダウンロードできます。

免責事項

本ツールをダウンロードした時点で下記事項に同意したものとみなします。ダウンロード前に必ず下記事項をご確認ください。

• 「okurun.jar」は無償にてLogStare社より提供しておりますが、著作権は放棄しておらず著作権はLogStare社に帰属しています。
• 「okurun.jar」に含まれるプログラムコードは日本国著作権法により保護されています。
• 「okurun.jar」の改変、修正は禁止しております。
• 「okurun.jar」を使用したことによって生じたすべての障害・損害・不具合等（一次的、二次的に関わらず）に対して、LogStare社は一切の責任を負いません。LogStare社環境にて動作検証は行っておりますが、「okurun.jar」の動作保証は致しません。
• 「okurun.jar」について、許可なく第三者への再配布を実施することは出来ません。
• 「okurun.jar」について、LogStare社は一切のサポートは実施いたしません。
• 「okurun.jar」について、法令や条例、公序良俗に反する使用、他人に迷惑となるような使用等は一切認めておりません。
• 「okurun.jar」について、提供を停止する場合があります。提供の停止によるいかなる損害もLogStare社は一切の責任を負いません。

以上でログフォワーダー「okurun.jar」についての説明は終了となります。

記載されている会社名、システム名、製品名は一般に各社の登録商標または商標です。

当社製品以外のサードパーティ製品の設定内容につきましては、弊社サポート対象外となります。