12.7. ログフォーマッターの設定
ログフォーマッターはハンドラーでのログメッセージの形式を定義します。名前付きパターンフォーマッタ または カスタムログフォーマッタ を設定できます。
12.7.1. 名前付きパターンフォーマッタを設定する
ログハンドラーすべてで使用できる名前付きパターンフォーマッターを作成して、ログメッセージをフォーマットすることができます。
ここでは、管理 CLI を使用してカスタムログフォーマッターを設定する方法を説明します。設定 タブから ログ サブシステムに移動し、フォーマッタ タブを選択して、左側のメニューから パターン を選択することで、管理コンソールを使用してログフォーマッタを設定することもできます。
ロギングプロファイルにこのログフォーマッターを設定する場合、 コマンドの最初は /subsystem=logging/ ではなく /subsystem=logging/logging-profile= になります。
LOGGING_PROFILE_NAME/
さらに、マネージドドメインで実行している場合はコマンドの前に /profile=PROFILE_NAME を付けます。
名前付きフォーマッタを作成する
パターンフォーマッターを定義するとき、ログメッセージのフォーマットに使用するパターン文字列を指定します。パターン構文の詳細は、ログフォーマッタを 参照してください。
/subsystem=logging/pattern-formatter=PATTERN_FORMATTER_NAME:add(pattern=PATTERN_STRING)
また、カラーマップを定義してログレベルごとに色を割り当てることもできます。形式は LEVEL:COLOR のコンマ区切りリストです。
-
有効なレベル:
finest、finer、fine、config、trace、debug、info、warning、warn、error、fatal、severe -
有効な色:
black、green、red、yellow、blue、magenta、cyan、white、brightblack、brightred、brightgreen、brightblue、brightyellow、brightmagenta、brightcyan、brightwhite
/subsystem=logging/pattern-formatter=PATTERN_FORMATTER_NAME:write-attribute(name=color-map,value="LEVEL:COLOR,LEVEL:COLOR")
名前付きフォーマッタをログハンドラーに割り当てる
以下の管理 CLI コマンドは、Periodic Rotating ファイルハンドラーによって使用されるカスタムフォーマッターを割り当てます。
/subsystem=logging/periodic-rotating-file-handler=FILE_HANDLER_NAME:write-attribute(name=named-formatter,value=PATTERN_FORMATTER_NAME)
12.7.2. Custom ログフォーマッターの設定
ログハンドラーすべてで使用できるカスタムログフォーマッターを作成して、ログメッセージをフォーマットすることができます。
ここでは、管理 CLI を使用してカスタムログフォーマッターを設定する方法を説明します。管理コンソールを使用してログフォーマッタを設定することもできます。設定 タブから ログ記録 サブシステムに移動し、フォーマッタ タブを選択して、左側のメニューから カスタム を選択します。
Custom ログフォーマッターの設定
ロギングプロファイルにこのログフォーマッターを設定する場合、 コマンドの最初は /subsystem=logging/ ではなく /subsystem=logging/logging-profile= になります。
LOGGING_PROFILE_NAME/
さらに、マネージドドメインで実行している場合はコマンドの前に /profile=PROFILE_NAME を付けます。
カスタムログフォーマッターを追加します。
カスタムログフォーマッターを追加する場合、フォーマッターの Java クラスとフォーマッターが含まれる JBoss EAP モジュールを指定する必要があります。クラスは
java.util.logging.Formatterを拡張する必要があります。注記すでに、カスタムフォーマッターが含まれるモジュールが作成されている必要があります。 作成されていないと、このコマンドの実行に失敗します。
/subsystem=logging/custom-formatter=CUSTOM_FORMATTER_NAME:add(class=CLASS_NAME, module=MODULE_NAME)
ログフォーマッターに必要なプロパティーを設定します。
setter メソッドを使用してプロパティーにアクセスできなければなりません。
/subsystem=logging/custom-formatter=CUSTOM_FORMATTER_NAME:write-attribute(name=properties.PROPERTY_NAME,value=PROPERTY_VALUE)
カスタムフォーマッターをログハンドラーに割り当てます。
以下の管理 CLI コマンドは、Periodic Rotating ファイルハンドラーによって使用されるカスタムフォーマッターを割り当てます。
/subsystem=logging/periodic-rotating-file-handler=FILE_HANDLER_NAME:write-attribute(name=named-formatter, value=CUSTOM_FORMATTER_NAME)
カスタム XML フォーマッターの例
以下の例は、カスタム XML フォーマッターを設定します。org.jboss.logmanager モジュールに提供される java.util.logging.XMLFormatter クラスを使用し、Console ログハンドラーに割り当てます。
/subsystem=logging/custom-formatter=custom-xml-formatter:add(class=java.util.logging.XMLFormatter, module=org.jboss.logmanager) /subsystem=logging/console-handler=CONSOLE:write-attribute(name=named-formatter, value=custom-xml-formatter)
このフォーマッターを使用するログメッセージは以下のようにフォーマットされます。
<record> <date>2016-03-23T12:58:13</date> <millis>1458752293091</millis> <sequence>93963</sequence> <logger>org.jboss.as</logger> <level>INFO</level> <class>org.jboss.as.server.BootstrapListener</class> <method>logAdminConsole</method> <thread>22</thread> <message>WFLYSRV0051: Admin console listening on http://%s:%d</message> <param>127.0.0.1</param> <param>9990</param> </record>
