Audit Log

Audit Log機能は、EMQXクラスターにおける重要な運用変更をリアルタイムで追跡することを可能にします。Audit Logを通じて、エンタープライズユーザーは誰がどの重要な操作を、どのように、いつ実行したかを簡単に確認できます。これは、エンタープライズユーザーが規制要件を遵守し、運用中のデータセキュリティ監査を確実に行うための重要なツールです。

EMQX Audit Logは、ダッシュボード、REST API、およびCLIからの変更関連操作の記録をサポートしています。例えば、ダッシュボードのユーザーログインやクライアント、アクセス制御、データ統合の変更などです。ダッシュボードおよびREST APIでは、メトリクス取得やクライアント一覧照会といった読み取り専用操作は記録されません。CLIコマンドは、データを変更するかどうかに関わらず記録されますが、CLIまたはErlangコンソールからの操作記録で説明する例外があります。

EMQXは、ダッシュボードビューとログシステムとの連携を提供し、エンタープライズがAudit Logを管理しやすい環境を整えています。これらの方法により、EMQXは柔軟かつ包括的なAudit Logのサポートを提供し、エンタープライズユーザーがニーズに応じて最適な管理・閲覧方法を選択できるようにしています。

Audit Logの有効化

Audit Log機能は、ダッシュボードおよび設定ファイルの両方から有効化および設定パラメータの調整が可能です。

ダッシュボードでのAudit Log有効化

ダッシュボードでAudit Logを有効化し、設定パラメータを変更するには、管理 -> ログ -> Audit Log、またはシステム -> Audit Logに移動します。

Audit Logに対して以下のオプションを設定できます：

• ログハンドラーの有効化：Audit Log処理プロセスの有効化・無効化。デフォルトで有効です。

• Audit Logファイル名：Audit Logファイルのパスと名前を指定します。デフォルトは${EMQX_LOG_DIR}/audit.logで、${EMQX_LOG_DIR}は変数であり、デフォルトは./logです。つまり最終的には./log/audit.log.1に保存されます。

• 最大ログファイル数：ローテーションされるログファイルの最大数。デフォルトは10です。

• ローテーションサイズ：ログファイルのサイズを設定し、指定サイズに達するとログファイルがローテーションされます。無効にするとログファイルは無制限に成長します。テキストボックスに値を入力し、ドロップダウンリストからMB、GB、KBなどの単位を選択できます。デフォルトは50MBです。

• キャッシュサイズ：データベースに保存される最大レコード数を決定し、ダッシュボードおよび/audit APIからアクセス・取得可能です。デフォルトは5000です。

  注意

  log.audit.max_filter_sizeは後方互換のためのエイリアスとして残されています。

• 高頻度リクエストの無視：パブリッシュ／サブスクライブやクライアントのキックアウトなど、高頻度リクエストを無視してAudit Logの洪水を防ぐかどうかを制御します。デフォルトで有効です。

• タイムスタンプ形式：ログエントリのタイムスタンプに使用する形式。選択肢は以下の通りです：

  • auto：ログフォーマッターに基づき最適な形式を自動選択。JSONはepoch、テキストはrfc3339。
  • epoch：マイクロ秒単位のUnixエポック時間。
  • rfc3339：RFC3339形式。

• タイムオフセット：ログエントリのタイムスタンプをフォーマットする際の時間オフセット。選択肢は以下の通りです：

  • system：ローカルシステムの時間オフセット。
  • utc：UTCの時間オフセット。
  • +-[hh]:[mm]：ユーザー指定の時間オフセット（例："-02:00"や"+00:00"）。

  デフォルトはsystemです。

• ペイロードエンコード：ログエントリ内のペイロードデータのエンコード方法。text、hex、hiddenから選択可能。デフォルトはtextです。

設定ファイルでのAudit Log有効化

base.hoconファイルのlog.audit以下に設定オプションを記述して、Audit Logを有効化および設定変更も可能です。例は以下の通りです。

log.audit {
  path = "./log/audit.log"
  rotation_count = 10
  rotation_size = 50MB
  cache_size = 5000
  ignore_high_frequency_request = true
  timestamp_format = auto
  time_offset = system
  payload_encode = text
}

ダッシュボードでのAudit Log閲覧

Audit Logを有効化すると、ダッシュボードのシステム -> Audit LogでAudit Logの内容を閲覧できます。

検索フィルター

ログ操作のフィルタリングおよび検索が可能で、サポートされる検索キーワードは以下の通りです：

• 開始時間 - 終了時間：操作が発生した時間範囲。
• ソースタイプ：操作を実行した方法。選択肢はDashboard、REST API、CLI、Erlang Consoleです。ここでErlang Consoleは通常EMQの現地技術サポート時に使用されるErlang Shellコンソールを指します。
• オペレーター：ダッシュボードのユーザー名またはREST API呼び出しに使用されたキー名。操作方法がDashboardまたはREST APIの場合のみ有効です。
• IP：ダッシュボードユーザーまたはREST APIを呼び出したクライアントの送信元IP。操作方法がDashboardまたはREST APIの場合のみ表示されます。
• 操作名：Audit Logでサポートされる操作名のドロップダウンリストから選択。
• 操作結果：成功または失敗から選択。

リストの説明

表示されるAudit Logリストの各列の説明は以下の通りです：

• 操作時間：操作が行われた時間。
• 情報：
  • DashboardまたはREST APIの場合は操作名を表示。
  • CLIおよびコンソールの場合は実行されたコマンドを記録。
• オペレーター：操作方法および対応するオペレーター。CLIおよびコンソール操作の場合、オペレーターはコマンドが実行されたEMQXノード名です。
• IP：ダッシュボードユーザーまたはREST APIを呼び出したクライアントの送信元IP。操作方法がDashboardまたはREST APIの場合のみ表示されます。
• 操作結果：成功または失敗。失敗にはフォーム検証失敗やリソース削除不可などのケースが含まれます。DashboardまたはREST APIの操作方法のみ表示され、CLIおよびコンソールは操作結果を記録できません。

ログファイルでのAudit Log閲覧

Audit LogがEMQXで有効化されている場合、変更関連操作は./log/audit.log.1ファイルにログ形式で保存されます。これによりエンタープライズユーザーはAudit Logの詳細分析や既存のログ管理システムへの統合を容易に行え、コンプライアンスやデータセキュリティ要件を満たせます。

注意

コマンドライン操作のAudit Logには機密情報が含まれる可能性があるため、ログコレクターに送信する際は注意が必要です。ログ内容のフィルタリングや暗号化通信の利用など、不正な情報漏洩を防ぐ対策を推奨します。

Audit Logに含まれるフィールドは、操作記録のソースによって異なります。

ダッシュボードまたはREST APIからの操作記録

ダッシュボードまたはREST API操作を記録するAudit Logには、操作ユーザー、操作対象、操作結果の情報が含まれます。ログメッセージのフォーマット例は以下の通りです。

{"time":1702604675872987,"level":"info","source_ip":"127.0.0.1","operation_type":"mqtt","operation_result":"success","http_status_code":204,"http_method":"delete","operation_id":"/mqtt/retainer/message/:topic","duration_ms":4,"auth_type":"jwt_token","from":"dashboard","source":"admin","node":"emqx@127.0.0.1","http_request":{"method":"delete","headers":{"user-agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36","sec-fetch-site":"same-origin","sec-fetch-mode":"cors","sec-fetch-dest":"empty","sec-ch-ua-platform":"\"macOS\"","sec-ch-ua-mobile":"?0","sec-ch-ua":"\"Google Chrome\";v=\"119\", \"Chromium\";v=\"119\", \"Not?A_Brand\";v=\"24\"","referer":"http://localhost:18083/","origin":"http://localhost:18083","host":"localhost:18083","connection":"keep-alive","authorization":"******","accept-language":"zh-CN,zh;q=0.9,zh-TW;q=0.8,en;q=0.7","accept-encoding":"gzip, deflate, br","accept":"*/*"},"body":{},"bindings":{"topic":"$SYS/brokers/emqx@127.0.0.1/version"}}}

以下の表は、ダッシュボードまたはREST API操作によって生成されるAudit Logエントリに現れる可能性のあるフィールドを説明しています。

フィールド名	型	説明
time	整数	ログ記録のタイムスタンプ（マイクロ秒単位）。
level	文字列	ログレベル。
source_ip	文字列	操作の送信元IPアドレス。
operation_type	文字列	操作の機能モジュール。REST APIのタグに対応。
operation_result	文字列	操作結果。successは成功、failureは失敗を示します。
http_status_code	整数	HTTPレスポンスのステータスコード。
http_method	文字列	HTTPリクエストメソッド。
duration_ms	整数	操作の実行時間（ミリ秒単位）。
auth_type	文字列	認証タイプ。認証に使用された方法やメカニズムを示し、jwt_token（ダッシュボード）またはapi_key（REST API）で固定。
from	文字列	リクエストの送信元。dashboard、rest_apiはそれぞれダッシュボード、REST APIを示します。cli、erlang_consoleの場合はCLIまたはErlang Shellからの操作であり、このログ構造は該当しません。
source	文字列	操作を実行したダッシュボードのユーザー名またはAPIキー名。
node	文字列	ノード名。操作が実行されたノードまたはサーバーを示します。
operation_id	文字列	リクエストのREST APIパス。REST APIを参照してください。
http_request	オブジェクト	HTTPリクエストの詳細。
http_request.method	文字列	HTTPリクエストメソッド。post、put、deleteのいずれか。
http_request.bindings	オブジェクト	operation_id内のプレースホルダーに対応するパスパラメータの値。
http_request.headers	オブジェクト	HTTPリクエストヘッダー。機密情報と認識されるキーの値はマスクされています。
http_request.body	オブジェクト	HTTPリクエストボディ。機密情報と認識されるキーの値はマスクされています。
http_request.query_string	オブジェクト	任意。解析済みのURLクエリパラメータ。クエリパラメータがない場合は省略。機密情報はマスク。
http_request.namespace	文字列	任意。操作対象として解決されたネームスペース。グローバルネームスペースの場合はglobal。

ネームスペースとクエリパラメータ

EMQX 6.3.1以降、監査対象のダッシュボードおよびREST APIリクエストの非空クエリパラメータはhttp_request.query_stringに含まれます。ターゲットネームスペースを解決する操作では、nsまたはnamespaceクエリパラメータの有無にかかわらず、解決済みのネームスペースがhttp_request.namespaceに記録されます。以下はグローバル管理者が明示的にns2を対象とした例です。

{
  "http_request": {
    "method": "put",
    "bindings": {"name": "test"},
    "query_string": {"ns": "ns2"},
    "namespace": "ns2"
  }
}

ネームスペース管理者が自身のネームスペース内のリソースをクエリパラメータなしで対象とした場合、http_request.query_stringは省略されますが、http_request.namespaceには解決済みネームスペースが含まれます。

認証、認可、コネクター、ブリッジ、ルール、トレース、データバックアップ、A2Aレジストリ、トピックメトリクスに関わるネームスペース操作では、解決済みターゲットネームスペースが記録されます。その他のネームスペースを解決しないエンドポイントではhttp_request.namespaceは省略されます。

CLIまたはErlangコンソールからの操作記録

すべてのCLIコマンドはAudit Logに記録されます。読み取り専用コマンド（例：emqx ctl status）も含まれます。ただし例外として、トップレベルの使用方法表示は記録されません。つまり、コマンドなしでemqx ctlを実行した場合や認識されないコマンドを実行した場合は、利用可能なコマンド一覧が表示されますが記録されません。無効な引数を受け取り自身の使用方法を表示するコマンド（例：emqx ctl status bad-arg）は、そのコマンドの呼び出しとして記録されます。

CLIまたはErlangコンソール操作を記録するAudit Logには、実行されたコマンド、呼び出しパラメータなどの情報が含まれます。ログメッセージのフォーマット例は以下の通りです。

{"time":1695866030977555,"level":"info","msg":"from_cli","from": "cli","node":"emqx@127.0.0.1","duration_ms":0,"cmd":"retainer","args":["clean", "t/1"]}

以下の表は上記ログメッセージサンプルに含まれるフィールドを示します。

フィールド名	型	説明
time	整数	ログ記録のタイムスタンプ（マイクロ秒単位）。
level	文字列	ログレベル。
msg	文字列	操作の説明。
from	文字列	リクエストの送信元。cli、erlang_consoleはそれぞれCLI、Erlang Shellを示します。dashboard、rest_apiの場合はダッシュボードまたはREST API操作であり、このログ構造は該当しません。
node	文字列	操作が実行されたノードまたはサーバーのノード名。
duration_ms	整数	操作の実行時間（ミリ秒単位）。
cmd	文字列	実行された具体的なコマンド操作。対応コマンドはCLIを参照してください。
args	配列	コマンドに付随する追加パラメータ。複数パラメータは配列で区切られます。