Red Hat Training
A Red Hat training course is available for Red Hat JBoss Enterprise Application Platform
12.3.4. CLI でのファイルログハンドラーの設定
ファイルログハンドラーは CLI で追加、削除、および編集できます。
File ログハンドラーを設定するために実行する主なタスクは以下のとおりです。
- 新しいファイルログハンドラーの追加
- ファイルログハンドラーの設定表示
- ハンドラーのログレベルの設定
- ハンドラーの追加動作の設定
- ハンドラーによる自動フラッシュ使用の有無を設定
- ハンドラーの出力に使用されるエンコーディングの設定
- ログハンドラーが書き込むファイルの指定
- ハンドラーの出力に使用されるフォーマッターの設定
- ファイルログハンドラーの削除
重要
ログハンドラーをスタンドアロンシステムのロギングプロファイルに設定する場合、設定パスのルートは
/subsystem=logging/
ではなく /subsystem=logging/logging-profile=NAME/
になります。
管理対象ドメインでは、使用するプロファイルを指定する必要があります。管理対象ドメインの設定パスの先頭にプロファイル名を追加する必要があります。
/subsystem=logging/
は /profile=NAME/subsystem=logging/
に置き換えます。
- ファイルログハンドラーの追加
- 以下の構文で add 操作を使用します。PATH を、ログが書き込まれるファイルのファイル名に置き換えます。DIR は、ファイルが存在するディレクトリー名に置き換えます。DIR の値はパス変数になります。
/subsystem=logging/file-handler=HANDLER:add(file={"path"=>"PATH", "relative-to"=>"DIR"})
例12.22 ファイルログハンドラーの追加
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:add(file={"path"=>"accounts.log", "relative-to"=>"jboss.server.log.dir"}) {"outcome" => "success"}
- ファイルログハンドラー設定の表示
- 以下の構文で read-resource 操作を使用します。HANDLER をファイルログハンドラーの名前に置き換えます。
/subsystem=logging/file-handler=HANDLER:read-resource
例12.23 read-resource 操作の使用
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:read-resource { "outcome" => "success", "result" => { "append" => true, "autoflush" => true, "enabled" => true, "encoding" => undefined, "file" => { "path" => "accounts.log", "relative-to" => "jboss.server.log.dir" }, "filter" => undefined, "filter-spec" => undefined, "formatter" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n", "level" => "ALL", "name" => "accounts_log", "named-formatter" => undefined } }
- ログレベルの設定
- 次の構文で write-attribute 操作を使用します。HANDLER をファイルログハンドラーの名前に置き換えます。LOG_LEVEL_VALUE を設定するログレベルに置き換えます。
/subsystem=logging/file-handler=HANDLER:write-attribute(name="level", value="LOG_LEVEL_VALUE")
例12.24 ログレベルの変更
/subsystem=logging/file-handler=accounts_log:write-attribute(name="level", value="DEBUG") {"outcome" => "success"}
- 追加動作の設定
- 次の構文で write-attribute 操作を使用します。HANDLER をファイルログハンドラーの名前に置き換えます。アプリケーションサーバーが起動されるたびに新しいログファイルを作成する必要がある場合は、BOOLEAN を false に置き換えます。アプリケーションサーバーが同じファイルを使用し続ける必要がある場合は、BOOLEAN を
true
に置き換えます。/subsystem=logging/file-handler=HANDLER:write-attribute(name="append", value="BOOLEAN")
例12.25 追加プロパティーの変更
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:write-attribute(name="append", value="true") { "outcome" => "success", "response-headers" => { "operation-requires-reload" => true, "process-state" => "reload-required" } }
この変更を反映するには、JBoss EAP 6 を再起動する必要があります。 - 自動フラッシュの設定
- 次の構文で write-attribute 操作を使用します。HANDLER をファイルログハンドラーの名前に置き換えます。このハンドラーが出力をすぐに書き込む場合は、BOOLEAN を
true
に置き換えます。/subsystem=logging/file-handler=HANDLER:write-attribute(name="autoflush", value="BOOLEAN")
例12.26 自動フラッシュプロパティーの変更
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:write-attribute(name="autoflush", value="false") {"outcome" => "success"}
- エンコーディングの設定
- 次の構文で write-attribute 操作を使用します。HANDLER をファイルログハンドラーの名前に置き換えます。ENCODING を、必要な文字エンコーディングシステムの名前に置き換えます。
/subsystem=logging/file-handler=HANDLER:write-attribute(name="encoding", value="ENCODING")
例12.27 エンコーディングの設定
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:write-attribute(name="encoding", value="utf-8") {"outcome" => "success"}
- ログハンドラーが書き込むファイルの変更
- 次の構文で write-attribute 操作を使用します。PATH を、ログが書き込まれるファイルのファイル名に置き換えます。DIR は、ファイルが存在するディレクトリー名に置き換えます。DIR の値はパス変数になります。
/subsystem=logging/file-handler=HANDLER:write-attribute(name="file", value={"path"=>"PATH", "relative-to"=>"DIR"})
例12.28 ログハンドラーが書き込むファイルの変更
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:write-attribute(name="file", value={"path"=>"accounts-debug.log", "relative-to"=>"jboss.server.log.dir"}) {"outcome" => "success"}
- フォーマッターの設定
- 次の構文で write-attribute 操作を使用します。HANDLER をファイルログハンドラーの名前に置き換えます。FORMAT は必要なフォーマッター文字列に置き換えます。
/subsystem=logging/file-handler=HANDLER:write-attribute(name="formatter", value="FORMAT")
例12.29 フォーマッターの設定
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:write-attribute(name="formatter", value="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n") {"outcome" => "success"}
- File ログハンドラーの削除
- 以下の構文で remove 操作を使用します。HANDLER を、削除するファイルログハンドラーの名前に置き換えます。
/subsystem=logging/file-handler=HANDLER:remove
例12.30 File ログハンドラーの削除
[standalone@localhost:9999 /] /subsystem=logging/file-handler=accounts_log:remove {"outcome" => "success"}
ログハンドラーは、ログカテゴリーまたは非同期ログハンドラーによって参照されていない場合にのみ削除できます。