Syslog 基本設定

Syslogの基本設定を行います。

SYSLOGDISP

それぞれ必要の設定をはいにしてください。
その後、任意の項目に設定を書き込み保存ボタンを押してください。
次にそれぞれの設定項目の解説をおこないます。

機能の有効/無効

active

設定項目	設定値	説明
syslog 受信機能	有効/無効	有効にすると、Syslog を受信します。無効にすると、Syslog を受信しません。
自ホストの syslog	受け取る/受け取らない	本装置自身からの Syslog を受信するか否かを決定します。
ホスト名解決	有効/無効	Syslog受信時のホスト名の解決を行うか設定です。無効にすると外部からのSysloデータのホスト名はIPアドレスとして保存されます。(自ホスト等のEBSYSLOG自体が把握しているホスト名はIPアドレスとしては保存されません。) 有効にすると、IPアドレスからホスト名へと解決を試みます。

メール通知

mail

指定した文字列にマッチする文字列を含む Syslog メッセージを受信すると自動的にメールを送信する機能です。
設定項目は以下のとおりです。

設定項目	設定値	説明
メール通知を行う	はい/いいえ	メール通知機能の有効/無効を決定します。
監視対象文字列	文字列	設定値にマッチする文字列をメッセージに含むSyslogメッセージを受信すると自動的にメールを送信します。 ※ ホスト、Facility、Priority、プログラムはマッチングの対象にはなりません。 ※ 設定できる文字列はORやANDでの条件指定は出来ません。
SMTP サーバ：ポート	文字列	メールを送信する際に使用する SMTP サーバ及びポート番号を指定します。 SMTP Auth を用いる場合にはチェックボックスにチェックを入れてください。
ユーザ名/パスワード	文字列	SMTP Auth に用いるユーザ名/パスワードを指定します。
受信者メールアドレス	文字列	送信先のメールアドレスを指定します。
送信者メールアドレス	文字列	送信元のメールアドレスを指定します。
テストメール	`送信`ボタン	ボタンを押すとフォームに入力している情報を元にテストメールを送信します。

拡張メール通知

extend_mail

指定した条件にマッチする Syslog メッセージを受信すると自動的にメールを送信する機能です。
設定項目は以下のとおりです。

共通項目

設定項目	設定値	説明
拡張メール通知を行う	はい/いいえ	拡張メール通知機能の有効/無効を決定します。
SMTP サーバ：ポート	文字列	拡張メールを送信する際に使用する SMTP サーバ及びポート番号を指定します。 SMTP Auth を用いる場合にはチェックボックスにチェックを入れてください。
ユーザ名/パスワード	文字列	SMTP Auth に用いるユーザ名/パスワードを指定します。
受信者メールアドレス	文字列	送信先のメールアドレスを指定します。
送信者メールアドレス	文字列	送信元のメールアドレスを指定します。
テストメール	`送信`ボタン	ボタンを押すとフォームに入力している情報を元にテストメールを送信します。

拡張メール通知条件

条件追加 ボタンを押すことにより、条件を追加することができます。
全項目未設定の場合、拡張メール通知条件の設定として扱われません。

設定項目	設定値	説明
ホスト	文字列	拡張メール通知の送信対象とするホスト名(またはIPアドレス)を設定します。未設定の場合、ホスト名による送信対象の条件として用いません。
Priority	ボタン	拡張メール通知の送信対象とするPriorityを emerg / alert / crit / err / warn から設定します。未設定の場合、Priorityによる送信対象の条件として用いません。
メッセージ	文字列	設定値にマッチする文字列をメッセージに含むSyslogメッセージを受信すると自動的にメールを送信します。未設定の場合、メッセージマッチによる送信対象の条件として用いません。

SNMP Trap受信

mail

SNMP Trap を受信して Syslog として表示する機能です。設定項目は以下のとおりです。

設定項目	設定値	説明
SNMP Trap の受信を行う	はい/いいえ	SNMP Trap を受信するか否かを決定します。
snmp コミュニティ名	文字列	Trap を受信するコミュニティ名を指定します。

※最大 5 件まで登録できます。

リソース管理

mail

SNMP エージェント機能です。
設定項目は以下のとおりです。

設定項目	設定値	説明
SNMP エージェント	はい/いいえ	SNMP エージェント機能を有効にするか否かを決定します。
snmp コミュニティ名	文字列	SNMP エージェントのコミュニティ名を指定します。

Syslogメッセージ中継

mail

受信した Syslog メッセージを他の Syslog サーバに中継する機能です。
本機能を使用した場合であっても、本装置には受信した Syslog メッセージを保存します。

設定項目	設定値	説明
Syslog サーバへ転送する	はい/いいえ	Syslog サーバへ転送するか否かを決定します。
IP アドレス (Domain Name)	IP アドレス/ドメイン名	中継先のSyslogサーバのIPアドレスかドメイン名を指定します。
転送プロトコル	TCP(BSD)/UDP(BSD)/ Over TLS(BSD)/ TCP(IETF)/ Over TLS(IETF)	プロトコルを選択します。中継先のサーバが許容するプロトコルを選択してください。
ポート番号	数値	中継先のサーバの待ち受けポートを入力してください。 TCP(BSD)/UDP(BSD)時は通常514ポートとなります。TCP(IETF)は通常601ポートとなります。Over TLS時はBSD/IETF問わず通常6514ポートとなります。
メッセージプレフィックス	文字列	中継先のサーバにメッセージを転送する際に、メッセージの先頭に固定の文字列を付与する機能となります。
クライアント認証(TLS)する	はい / いいえ	Over TLSプロトコルにてメッセージ転送する先のSyslogサーバにてクライアント認証を行っている場合にはいを選択してください。本項目は転送プロトコルをOver TLS選択時に表示されます。
STRUCTURED-DATA設定	`追加`ボタン	IETF形式のSyslogとして転送する場合に、STRUCTURE-DATAを書き換え及び設定する機能です。`追加`ボタンを押すことにより設定フォームが追加されます。本項目は転送プロトコルをTCP(IETF)またはOver TLS(IETF)選択時に表示されます。
SD-ID	文字列	転送時に書き換え及び設定に用いるSTRUCTURED-DATAの識別子を指定します。
PARAM-NAME	文字列	転送時に書き換え及び設定に用いるSTRUCTURED-DATAの識別子に対する属性を指定します。
PARAME-VALUE	文字列	転送時に書き換え及び設定に用いるSTRUCTURED-DATAの識別子に対する属性値を指定します。

info

Over TLSプロトコルにて中継する場合には、以下の点に注意してください。
- 「IPアドレス(Domain Name)」はサーバー証明書に合わせる必要があります。そのため、サーバー証明書と一致するドメイン名を設定してください。また、設定したドメイン名の名前解決が行えない場合にはホスト追加にてホスト定義を追加してください。
- クライアント認証を行っているSyslogサーバへのメッセージ中継をする場合には、事前に証明書管理からクライアント証明書をアップロードしてください。

バックアップ送信

FTPサーバの場合	AWS S3の場合	Azure Blob Storageの場合

月初に前月のデータのバックアップを FTPサーバ/AWS S3/Azure Blob Storageのいずれかへ転送する機能です。
バックアップファイルの形式は MySQL のダンプファイルと同等です。
※ログが多すぎる場合、送信に失敗するケースがあるのでその場合はログを減らすかSyslogサーバーを増設してください。
設定項目は以下のとおりです。

設定項目	設定値	説明
送信する	はい/いいえ	バックアップ送信するか否かを決定します。
バックアップ先	FTPサーバ/ AWS S3/ Azure Blob Storage	バックアップ先を選択します。
FTPサーバの場合
サーバ URL	文字列	FTP サーバの URL を指定します。以下の形式で入力してください。 ftp://<ドメインネームIP アドレス>/ディレクトリ名例 1)ftp://ftp.plathome.co.jp 例 2)ftp://ftp.plathome.co.jp/ftp/ ※ディレクトリを指定する場合は必ず最後に「/」を入れてください。また、ディレクトリはFTPユーザーのホームディレクトリからの相対パスで指定します。ルートディレクトリからの絶対パスで指定する場合は、以下のようにディレクトリの前のスラッシュを2個設定してください。 ftp://ftp.plathome.co.jp//mnt/ftp
FTP ユーザ名	文字列	FTP サーバにログインするためのユーザ名を指定します。
FTP パスワード	文字列	FTP サーバにログインするためのパスワードを指定します。
AWS S3の場合
アクセスキーID	文字列	AWS S3へアクセスするアクセスキーIDを指定します。
アクセスキー	文字列	AWS S3へアクセスするシークレットアクセスキーを指定します。
バケット	文字列	AWS S3へアクセスするバケット名を指定します。
リージョン	文字列	AWS S3へアクセスするリージョンを指定します。
中間パス	文字列	AWS S3にファイルを配置する際の中間パスを指定します。
Azure Blob Storeageの場合
ストレージアカウント	文字列	Azure Blob Storageへアクセスするストレージアカウントを指定します。
BLOBコンテナー	文字列	Azure Blob StorageへアクセスするBLOBコンテナー名を指定します。
アクセスキー	文字列	Azure Blob Storageへアクセスするアクセスキーを指定します。
中間パス	文字列	Azure Blob Storageにファイルを配置する際の中間パスを指定します。
設定確認	`確認`ボタン	ボタンを押すと入力パラメータを用いてテストファイルのアップロード確認を行います。

info

EasyBlocks Syslog 1.1.10以下の場合、FTPサーバのみバックアップ送信をサポートしています。
また、確認ボタンによる動作は接続確認までとなります。

CSVログ送信

FTPサーバの場合	AWS S3の場合	Azure Blob Storageの場合

前日の全データを CSV 形式にして FTP サーバ/AWS S3/Azure Blob Storageのいずれかに送信する機能です。
※ログが多すぎる場合、送信に失敗するケースがあるのでその場合はログを減らすかSyslogサーバーを増設してください。

設定項目	設定値	説明
送信する	はい/いいえ	CSVログを送信するか否かを決定します。
送信先	FTPサーバ/ AWS S3/ Azure Blob Storage	CSVログの送信先を選択します。
FTPサーバの場合
サーバ URL	文字列	FTP サーバの URL を指定します。以下の形式で入力してください。 ftp://<ドメインネームIP アドレス>/ディレクトリ名例 1)ftp://ftp.plathome.co.jp 例 2)ftp://ftp.plathome.co.jp/ftp/ ※ディレクトリを指定する場合は必ず最後に「/」を入れてください。また、ディレクトリはFTPユーザーのホームディレクトリからの相対パスで指定します。ルートディレクトリからの絶対パスで指定する場合は、以下のようにディレクトリの前のスラッシュを2個設定してください。 ftp://ftp.plathome.co.jp//mnt/ftp
FTP ユーザ名	文字列	FTP サーバにログインするためのユーザ名を指定します。
FTP パスワード	文字列	FTP サーバにログインするためのパスワードを指定します。
AWS S3の場合
アクセスキーID	文字列	AWS S3へアクセスするアクセスキーIDを指定します。
アクセスキー	文字列	AWS S3へアクセスするシークレットアクセスキーを指定します。
バケット	文字列	AWS S3へアクセスするバケット名を指定します。
リージョン	文字列	AWS S3へアクセスするリージョンを指定します。
中間パス	文字列	AWS S3にファイルを配置する際の中間パスを指定します。
Azure Blob Storeageの場合
ストレージアカウント	文字列	Azure Blob Storageへアクセスするストレージアカウントを指定します。
BLOBコンテナー	文字列	Azure Blob StorageへアクセスするBLOBコンテナー名を指定します。
アクセスキー	文字列	Azure Blob Storageへアクセスするアクセスキーを指定します。
中間パス	文字列	Azure Blob Storageにファイルを配置する際の中間パスを指定します。
設定確認	`確認`ボタン	ボタンを押すと入力パラメータを用いてテストファイルのアップロード確認を行います。

info

EasyBlocks Syslog 1.1.10以下の場合、FTPサーバのみCSVログ送信をサポートしています。
また、確認ボタンによる動作は接続確認までとなります。

当月テーブル自動バックアップ送信

FTPサーバの場合	AWS S3の場合	Azure Blob Storageの場合

当月のテーブルデータを FTP サーバ/AWS S3/Azure Blob Storageのいずれかに送信する機能です。
月初以外に毎日バックアップされ、バックアップ先へ送信されます。

設定項目	設定値	説明
送信する	はい/いいえ	当月のデータの自動バックアップを送信するか否かを決定します。
バックアップ先	FTPサーバ/ AWS S3/ Azure Blob Storage	当月のデータの自動バックアップ先を選択します。
FTPサーバの場合
サーバ URL	文字列	FTP サーバの URL を指定します。以下の形式で入力してください。 ftp://<ドメインネームIP アドレス>/ディレクトリ名例 1)ftp://ftp.plathome.co.jp 例 2)ftp://ftp.plathome.co.jp/ftp/ ※ディレクトリを指定する場合は必ず最後に「/」を入れてください。また、ディレクトリはFTPユーザーのホームディレクトリからの相対パスで指定します。ルートディレクトリからの絶対パスで指定する場合は、以下のようにディレクトリの前のスラッシュを2個設定してください。 ftp://ftp.plathome.co.jp//mnt/ftp
FTP ユーザ名	文字列	FTP サーバにログインするためのユーザ名を指定します。
FTP パスワード	文字列	FTP サーバにログインするためのパスワードを指定します。
AWS S3の場合
アクセスキーID	文字列	AWS S3へアクセスするアクセスキーIDを指定します。
アクセスキー	文字列	AWS S3へアクセスするシークレットアクセスキーを指定します。
バケット	文字列	AWS S3へアクセスするバケット名を指定します。
リージョン	文字列	AWS S3へアクセスするリージョンを指定します。
中間パス	文字列	AWS S3にファイルを配置する際の中間パスを指定します。
Azure Blob Storeageの場合
ストレージアカウント	文字列	Azure Blob Storageへアクセスするストレージアカウントを指定します。
BLOBコンテナー	文字列	Azure Blob StorageへアクセスするBLOBコンテナー名を指定します。
アクセスキー	文字列	Azure Blob Storageへアクセスするアクセスキーを指定します。
中間パス	文字列	Azure Blob Storageにファイルを配置する際の中間パスを指定します。
設定確認	`確認`ボタン	ボタンを押すと入力パラメータを用いてテストファイルのアップロード確認を行います。

info

EasyBlocks Syslog 1.1.10以下の場合、FTPサーバのみ当月テーブルの自動バックアップ送信をサポートしています。
また、確認ボタンによる動作は接続確認までとなります。

FTPサーバ機能

mail

FTP を利用してダンプファイルのダウンロード・アップロードを行うためのFTPサーバー機能です。
PCにFTPクライアントを用意するとファイルのダウンロード・アップロードが可能になります。
※ 本機能はブラウザでアップロードできないサイズのダンプファイルをアップロードするための機能です。

設定項目	設定値	説明
有効にする	はい/いいえ	FTP サーバ機能の有効/無効。
パスワード	文字列	FTP サーバにログインするためのパスワードを指定します。

FTPクライアントの設定

ユーザー名： ftpuser
パスワード：設定したパスワード
接続先 IP アドレス : 本装置の設定された IP アドレス

info

Windows のエクスプローラから日本語のファイルのアップロードを行うと正常にファイルが取り扱えません。
そのため、FTP クライアントツール(Filezilla 等)を用いてください。
FTP のルートディレクトリには書き込み権限はありません。
そのため、filesディレクトリ配下にてファイル作成及びディレクトリ作成を行ってください。

フィルタリンク件数表示機能

mail

フィルタリング実施時に対象となった件数を表示する機能です。

設定項目	設定値	説明
件数表示機能を有効にする	はい/いいえ	フィルタリング後の件数表示機能の有効/無効。

info

本機能を有効にした場合、件数取得に時間がかかり表示までの描写に時間がかかることがあります。
本機能を使用したい場合にのみ、適用してください。

CSVエクスポートAPI機能

csv_export_api

APIによるCSVエクスポート機能です。
検索条件等によって抽出用の条件を設定し、APIを実行することができます。

設定項目	設定値	説明
エクスポートAPI機能を有効にする	はい/いいえ	APIによるCSVのエクスポート機能を有効にする場合に有効としてください。

リクエストURL

http://<EBSYSLOGのIPアドレス>:880/apps/syslog/export_csv.php
または
https://<EBSYSLOGのIPアドレス>:4430/apps/syslog/export_csv.php

リクエスト

リクエストメソッドはPOSTです。または、リクエストデータ形式はJSONです。

JSONキー	必須/オプション	データ型	内容
name	必須	文字列	WEB UIの管理者ユーザー名。
password	必須	文字列	WEB UIの管理者ユーザーに対するパスワード。
table	必須	文字列	参照するデータテーブル名の指定。全体、年月、年月日のいずれかの指定となります。全体のデータを参照する場合には、logsを指定してください。 2023年8月のデータを参照する場合には、logs_202308を指定してください。 2023年8月10日のデータを参照する場合には、logs_20230810を指定してください。
limit	オプション	Integer	取得時の最大件数を指定します。未指定時は全ての件数を取得します。取得データが大量な場合、他のプロセスへの影響が出る恐れがありますの件数を絞って取得することを推奨します。
condition	オプション	オブジェクト	検索条件の指定となります。

検索条件リクエストデータ

condition内のデータの指定です。
以下の全てのパラメータはオプションデータとなります。

JSONキー	データ型	内容
datetime	配列	取得対象とするSYSLOGデータの検索対象日時の指定となります。1データまたは2データでの指定となります。 1データ目は検索開始日時指定となります。また、2データ目は検索終了日時指定となります。指定例 : [ "2023/08/04" , "2023/08/07" ]
host	文字列	取得対象とするSYSLOGデータのホスト名を指定します。
program	文字列	取得対象とするSYSLOGデータのプログラム名を指定します。
facility	配列	取得対象とするSYSLOGデータのfacilityを指定します。指定例 : [ "info" ]
priority	配列	取得対象とするSYSLOGデータのpriorityを指定します。指定例 : [ "local3" , "local4" ]
msg	文字列	取得対象とするSYSLOGデータに含まれる文字列を指定します。
exmsg	文字列	取得対象外するSYSLOGデータに含まれる文字列を指定します。

リクエスト例

cURLコマンドでのアクセス例です。

# curl -X POST -H 'Content-type: application/json' --data '{ "name" : "admin" , "password" : "admin" , "table" : "logs_202308" , "limit" : 100 , "condition" : { "host" : "172.16.7.183" , "exmsg" : "DHCP" , "priority" : [ "info" ] , "facility" : [ "local7" ] } }' http://192.168.10.30:880/apps/syslog/export_csv.php > ./filterd.csv 

info

自己署名証明書を用いている場合のHTTPSプロトコルでのAPI実行は-kオプションを使用してください。

Zabbixトラッパー連携

zabbix_trapper

指定した条件にマッチする Syslog メッセージを受信すると自動的にZabbixサーバーへを送信する機能です。

info

本機能を使用する場合、事前にZabbix設定を実施してください。
対象のSyslogメッセージを送信する為、Zabbixサーバー側のアイテムは以下としてください。
- タイプ : Zabbixトラッパー
- データ型 : 文字列またはログまたはテキスト

設定項目は以下のとおりです。

共通項目

設定項目	設定値	説明
Zabbixトラッパー連携する	はい/いいえ	Zabbixトラッパー連携機能の有効/無効を決定します。
重複制御	はい/いいえ	Zabbix登録ホスト - Zabbixアイテムキー毎に完全同一のメッセージを送信後から指定時間のあいだは送信しない機能です。
重複制御時間(秒)	数値	重複制御機能にて用いる制御時間を秒単位で指定します。
有効期限制御	はい/いいえ	Zabbixサーバーがダウンしている状態等において、送信に失敗したデータの内の指定時間以上前のデータを削除する機能です。
有効時間(秒)	数値	有効期限機能にて用いる制御時間を秒単位で指定します。

Zabbixトラッパー通知条件

トラッパー条件追加 ボタンを押すことにより、条件を追加することができます。
ホスト / Priority / メッセージのいずれも未設定の場合、トラッパー通知条件の設定として扱われません。

設定項目	設定値	説明
ホスト	文字列	Zabbixトラッパー通知の送信対象とするホスト名(またはIPアドレス)を設定します。未設定の場合、ホスト名による送信対象の条件として用いません。
Priority	ボタン	Zabbixトラッパー通知の送信対象とするPriorityを emerg / alert / crit / err / warn から設定します。未設定の場合、Priorityによる送信対象の条件として用いません。
メッセージ	文字列	設定値にマッチする文字列をメッセージに含むSyslogメッセージを受信すると自動的にZabbixトラッパーとして送信します。未設定の場合、メッセージマッチによる送信対象の条件として用いません。
Zabbix登録ホスト	文字列	Zabbixトラッパー通知によるデータ格納先のホストを選択します。本項目はZabbix設定にて登録したホスト情報が表示されます。
Zabbixアイテムキー	文字列	Zabbixトラッパー通知によるデータ格納先のホストに対するアイテムのキーを入力します。

以下のような通知条件設定の場合、送信元IPアドレスが172.16.7.200の受信SyslogメッセージはZabbixサーバーへホスト[test_server]/アイテムキー[item.test]のデータとして送信されます。

zabbix_trapper_cond

処理エラー通知機能

mail

CSVログ送信やバックアップ送信の失敗、起動時の DB 破損等が発生した場合にエラー通知のメールを送信する機能です。

設定項目	設定値	説明
処理エラーメール通知を行う	はい/いいえ	処理エラーメール通知機能の有効/無効を決定します。
SMTP サーバ：ポート	文字列	メールを送信する際に使用する SMTP サーバ及びポート番号を指定します。 SMTP Auth を用いる場合にはチェックボックスにチェックを入れてください。
ユーザ名/パスワード	文字列	SMTP Auth に用いるユーザ名/パスワードを指定します。
受信者メールアドレス	文字列	送信先のメールアドレスを指定します。
送信者メールアドレス	文字列	送信元のメールアドレスを指定します。
テストメール	`送信`ボタン	ボタンを押すとフォームに入力している情報を元にテストメールを送信します。

機能の有効/無効#

メール通知#

拡張メール通知#

SNMP Trap受信#

リソース管理#

Syslogメッセージ中継#

info

バックアップ送信#

info

CSVログ送信#

info

当月テーブル自動バックアップ送信#

info

FTPサーバ機能#

FTPクライアントの設定#

info

フィルタリンク件数表示機能#

info

CSVエクスポートAPI機能#

info

Zabbixトラッパー連携#

info

処理エラー通知機能#

機能の有効/無効

メール通知

拡張メール通知

SNMP Trap受信

リソース管理

Syslogメッセージ中継

バックアップ送信

CSVログ送信

当月テーブル自動バックアップ送信

FTPサーバ機能

FTPクライアントの設定

フィルタリンク件数表示機能

CSVエクスポートAPI機能

Zabbixトラッパー連携

処理エラー通知機能