ログ設定

このページでは、設定ファイルを用いてEMQXのログ動作を設定する方法を紹介します。EMQXのログはダッシュボードからも設定可能です。ダッシュボードで設定する場合は、左のナビゲーションメニューから Management -> Logging をクリックして設定できます。ログおよびダッシュボードの設定に関する詳細は、Logs and Observability - Logs を参照してください。

TIP

このページでは、設定項目に対応するダッシュボードUIのフィールドも紹介しています。
設定ファイルからログを設定する場合は、emqx.conf ではなく base.hocon の使用を推奨します。
emqx.conf に設定を記述すると、ダッシュボードでの変更が一時的なものとなり、EMQX再起動時に失われるためです。

EMQXは主に2つのログハンドラーをサポートしています：コンソールログとファイルログに加え、ログを常にファイルに出力するための専用の監査ログハンドラーも用意されています。

システムのデフォルトログハンドラーは環境変数 EMQX_DEFAULT_LOG_HANDLER で設定でき、以下の値を受け付けます。

• file：ログ出力をファイルに送る
• console：ログ出力をコンソールに送る

環境変数 EMQX_DEFAULT_LOG_HANDLER のデフォルトは console ですが、systemdの emqx.service ファイル経由で起動した場合は明示的に file に設定されます。

ファイルとしてログを出力する

EMQXのログ出力ディレクトリは環境変数 EMQX_LOG_DIR で決まり、RPMやDEBパッケージでインストールした場合は /var/log/emqx に設定されます。その他の場合はEMQXのインストールディレクトリ直下の log ディレクトリがログ出力先となります。

EMQXのDockerコンテナの場合、インストールディレクトリは /opt/emqx なので、ログディレクトリは /opt/emqx/log となります。

ログをファイル出力するには、ダッシュボードでログハンドラーを設定するか、以下のように base.hocon ファイルを直接編集します。

log {
  file {
    enable = true
    formatter = text
    level = warning
    path = "/var/log/emqx/emqx.log"
    rotation_count = 10
    rotation_size = 50MB
    time_offset = system
    timestamp_format = auto
  }
}

設定項目	ダッシュボードUI	説明	デフォルト値	選択可能な値
formatter	Log Formatter	ログのフォーマットを設定します。	text	text は自由形式テキスト。 json は構造化ログ用。
level	Log Level	現在のログハンドラーのログレベル、つまり記録したい最小ログレベルを設定します。	warning	debug, info, notice, warning, error, critical, alert, emergency
path	Log File Name	ログファイルのパスとファイル名を設定します。 デフォルトではEMQXインストールディレクトリの log フォルダ内の emqx.log に書き込みます。	emqx.log	--
rotation_count	Max Log Files Number	保存可能なログファイルの最大数を設定します。	10	1 - 2,048
rotation_size	Rotation Size	ログファイルの最大サイズを設定します。指定サイズに達するとローテーションされ、古いログはリネームされてアーカイブフォルダに移動されます。infinity に設定するとローテーションされません。	50MB	1 - infinity
time_offset	Time Offset	ログのタイムスタンプのUTCに対する時差を設定します。	system	--
timestamp_format	Timestamp Format	ログのタイムスタンプのフォーマットを設定します。	auto	auto: ログフォーマッターに応じて自動判別。テキストは rfc3339、JSONは epoch を使用。 epoch: マイクロ秒精度のUnixエポック形式。 rfc3339: RFC3339準拠の日時文字列形式。

コンソールにログを出力する

EMQXをDockerコンテナで起動すると、デフォルトのログハンドラーは console になります。
ログレベルやログフォーマットは以下の設定項目で変更可能です。

log {
  console {
    formatter = json
    level = warning
    time_offset = system
    timestamp_format = auto
  }
}

設定項目	ダッシュボードUI	説明	デフォルト値	選択可能な値
formatter	Log Formatter	ログのフォーマットを設定します。	text	text は自由形式テキスト。 json は構造化ログ用。
level	Log Level	現在のログハンドラーのログレベル、つまり記録したい最小ログレベルを設定します。	warning	debug, info, notice, warning, error, critical, alert, emergency
time_offset	Time Offset	ログのタイムスタンプのUTCに対する時差を設定します。	system	--
timestamp_format	Timestamp Format	ログのタイムスタンプのフォーマットを設定します。	auto	auto: ログフォーマッターに応じて自動判別。テキストは rfc3339、JSONは epoch を使用。 epoch: マイクロ秒精度のUnixエポック形式。 rfc3339: RFC3339準拠の日時文字列形式。

TIP

EMQXはより詳細なカスタマイズに対応した設定項目も提供しています。詳細は EMQX Enterprise Configuration Manual for Enterprise をご覧ください。