A.3. 管理インターフェース監査ロギングリファレンス
ロガー属性のリファレンス
管理インターフェース監査ロギングを有効または無効にする他に、以下の ロガー 設定属性を使用できます。
- log-boot
trueに設定すると、サーバーの起動時に管理操作が監査ログに含まれます。そうでない場合はfalseになります。デフォルト:true- log-read-only
trueに設定すると、すべての操作が監査ログに記録されます。falseに設定すると、モデルを変更する操作のみがログに記録されます。デフォルト:false。
ログフォーマッター属性のリファレンス
フォーマッターはログエントリーの形式を指定します。JSON 形式でログエントリーを出力する 1 つのフォーマッターのみを使用できます。
例A.1 ログレコードにタイムスタンプを含めます。
/core-service=management/access=audit/json-formatter=json-formatter:write-attribute(name=include-date,value=true)
ログフォーマッター属性
- include-date
- フォーマットされたログレコードにタイムスタンプが含まれるかどうかを定義するブール値。デフォルト:
true - date-separator
- 日付と残りのフォーマットされたログメッセージを分離するために使用する文字を含む文字列。
include-date=falseの場合は無視されます。デフォルト:-(これはスペース、その後にハイフン、その後にスペースが続く) - date-format
- java.text.SimpleDateFormat が理解しているタイムスタンプに使用する日付形式。
include-date=falseの場合は無視されます。デフォルト:yyyy-MM-dd HH:mm:ss - compact
trueの場合、JSON を 1 行にフォーマットします。新しい行が含まれる値が存在する可能性があるため、レコード全体を 1 行にするのが重要な場合は、escape-new-lineまたはescape-control-charactersをtrueに設定します。デフォルト:false。- escape-control-characters
trueの場合、すべての制御文字(10 進値が 32 の ASCII エントリー)を 8 進の ASCII コードでエスケープします。たとえば、新しい行は#012になります。trueの場合、escape-new-line=falseを上書きします。デフォルト:false。- escape-new-line
trueの場合は、新しい行を 8 進の ASCII コードでエスケープします(例:#012)。デフォルト:false。
管理インターフェースの監査ログファイルハンドラー属性リファレンス
ファイルハンドラーは、監査ログレコードがファイルに出力されるパラメーターを指定します。具体的には、ファイルのフォーマッター、ファイル名、およびパスを定義します。
ファイルハンドラーの属性
- formatter
- ログレコードをフォーマットするために使用する JSON フォーマッターの名前。デフォルト:
json-formatter。 - path
- 監査ログファイルのパス。デフォルト:
audit-log.log - relative-to
- 以前指定された別のパスの名前、またはシステムによって提供される標準的なパスの 1 つ。
relative-toを指定すると、path 属性の値はこの属性によって指定されたパスに対する相対値とみなされます。デフォルト:jboss.server.data.dir - failure-count
- ハンドラーが初期化された後に発生したロギング失敗数。デフォルト: 0
- max-failure-count
- このハンドラーを無効化する前の最大ロギング失敗数。デフォルト: 10
- disabled-due-to-failure
- ロギングの失敗によりこのハンドラーが無効になっている場合は、値を
trueにします。デフォルト:false。
管理インターフェースの Syslog ハンドラー属性リファレンス
syslog ハンドラーは、監査ログエントリーが syslog サーバーへ送信されるパラメーターを指定します。特に、syslog サーバーのホスト名と syslog サーバーがリッスンするポートを指定します。
/core-service=management/access=audit/syslog-handler=mysyslog:read-resource-description(recursive=true)
syslog ハンドラーの属性
- app-name
- RFC-5424 のセクション 6.2.5 で定義された syslog レコードに追加するアプリケーション名。指定されない場合、デフォルト値は製品の名前になります。
- disabled-due-to-failure
- ロギングの失敗によりこのハンドラーが無効になっている場合は、値を
trueにします。デフォルト:false。 - facility
- RFC-5424 のセクション 6.2.1 と RFC-3164 のセクション 4.1.1 で定義された syslog ロギングに使用する機能。
- failure-count
- ハンドラーが初期化された後に発生したロギング失敗数。デフォルト:
0 - formatter
- ログレコードのフォーマットに使用するフォーマッターの名前。デフォルト:
json-formatter。 - max-failure-count
- このハンドラーを無効化する前の最大ロギング失敗数。デフォルト:
10 - max-length
- ヘッダーを含むログメッセージの最大長(バイト単位)。未定義の場合、デフォルト値は
1024バイト (syslog-formatがRFC3164の場合) または2048バイト (syslog-formatがRFC5424の場合) になります。 - protocol
- syslog ハンドラーに使用するプロトコル。
udp、tcp、またはtlsのいずれか 1 つである必要があります。 - reconnect-timeout
- JBoss EAP 6.4 から利用できます。syslog サーバーへの再接続を試行する前に待機する秒数。イベント接続が失われます。デフォルト:
-1(無効) - syslog-format
- syslog 形式: RFC-5424 または RFC-3164デフォルト:
RFC-5424 - truncate
- ヘッダーを含むメッセージの長さ(バイト単位)が
max-length属性の値よりも大きい場合は、そのメッセージを省略するかどうか。falseに設定すると分割され、同じヘッダー値で送信されます。デフォルト:false。