11.3.5. CLI での周期ログハンドラーの設定

周期ログハンドラーは、CLI で追加、削除、および編集できます。
周期ログハンドラーを設定するために実行する主なタスクは以下のとおりです。
  • 周期ログハンドラーの設定を表示します。
  • 新しい周期ログハンドラーを追加します。
  • ハンドラーのログレベルを設定します。
  • ハンドラーの追加動作を設定します。
  • ハンドラーが自動フラッシュを使用するかどうかを設定します。
  • ハンドラーの出力に使用されるエンコーディングを設定します。
  • ログハンドラーが書き込むファイルを指定します。
  • ハンドラーの出力に使用されるフォーマッターを設定します。
  • ローテーションされるログの接尾辞の設定
  • 周期ログハンドラーを削除します。
これらの各タスクについては以下で説明されています。
周期ローテーションファイルログハンドラー設定の表示
次の構文で read-resource 操作を使用します。
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:read-resource 
HANDLER をファイルログハンドラーの名前と置き換えます。

例11.29 read-resource 操作の使用

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:read-resource
{
    "outcome" => "success",
    "result" => {
        "append" => true,
        "autoflush" => true,
        "encoding" => undefined,
        "file" => {
            "path" => "daily-debug.log",
            "relative-to" => "jboss.server.log.dir"
        },
        "filter" => undefined,
        "formatter" => "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n",
        "level" => undefined
    }
}
[standalone@localhost:9999 /]
新しい周期ローテーションファイルログハンドラーの追加
次の構文で add 操作を使用します。
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:add(file={"path"=>"PATH", "relative-to"=>"DIR"}, suffix="SUFFIX") 
HANDLER をログハンドラーの名前と置き換えます。PATH をログが書き込まれるファイルのファイル名と置き換えます。DIR をファイルが存在するディレクトリーの名前と置き換えます。DIR の値をパス変数に指定できます。SUFFIX を、使用するファイルローテーション接尾辞と置き換えます。

例11.30 新しいハンドラーの追加

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:add(file={"path"=>"daily-debug.log", "relative-to"=>"jboss.server.log.dir"}, suffix=".yyyy.MM.dd")
{"outcome" => "success"}
[standalone@localhost:9999 /]
ログレベルの設定
次の構文で change-log-level 操作を使用します。
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:change-log-level(level="LEVEL") 
HANDLER を周期ログハンドラーの名前と置き換えます。LEVEL を、設定するログレベルと置き換えます。

例11.31 ログレベルの設定

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:change-log-level(level="DEBUG")
{"outcome" => "success"}
[standalone@localhost:9999 /]
追加動作の設定
次の構文で write-attribute 操作を使用します。
 /subsystem=logging/periodic-rotating-handler=HANDLER:write-attribute(name="append", value="BOOLEAN") 
HANDLER を周期ログハンドラーの名前と置き換えます。アプリケーション・サーバーが起動されるたびに新しいログファイルを作成する必要がある場合は、BOOLEANfalse と置き換えます。アプリケーションサーバーが同じファイルを使用し続ける必要がある場合は、BOOLEANtrue に置き換えます。
この変更を反映するには、JBoss Enterprise Application Platform 6 を再起動する必要があります。

例11.32 追加動作の設定

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:write-attribute(name="append", value="true")
{
    "outcome" => "success",
    "response-headers" => {
        "operation-requires-reload" => true,
        "process-state" => "reload-required"
    }
}
[standalone@localhost:9999 /]
自動フラッシュの設定
次の構文で write-attribute 操作を使用します。
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:write-attribute(name="autoflush", value="BOOLEAN") 
HANDLER を周期ログハンドラーの名前と置き換えます。このハンドラーがすぐに出力を書き込む場合は、BOOLEANtrue に置き換えます。
この変更を反映するには、JBoss Enterprise Application Platform 6 を再起動する必要があります。

例11.33 自動フラッシュ動作の設定

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:write-attribute(name="autoflush", value="false")
{
    "outcome" => "success",
    "response-headers" => {"process-state" => "reload-required"}
}
[standalone@localhost:9999 /]
エンコーディングの設定
次の構文で write-attribute 操作を使用します。
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:write-attribute(name="encoding", value="ENCODING") 
HANDLER を周期ログハンドラーの名前と置き換えます。ENCODING を必要な文字エンコーディングシステムの名前と置き換えます。

例11.34 エンコーディングの設定

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:write-attribute(name="encoding", value="utf-8")     
{"outcome" => "success"}
[standalone@localhost:9999 /]
ログハンドラーが書き込むファイルの変更
次の構文で change-file 操作を使用します。
 /subsystem=logging/periodic-rotating-file-handle=HANDLER:change-file(file={"path"=>"PATH", "relative-to"=>"DIR"}) 
HANDLER を周期ログハンドラーの名前と置き換えます。PATH をログが書き込まれるファイルのファイル名と置き換えます。DIR をファイルが存在するディレクトリーの名前と置き換えます。DIR の値をパス変数に指定できます。

例11.35 ログハンドラーが書き込むファイルの変更

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handle=HOURLY_DEBUG:change-file(file={"path"=>"daily-debug.log", "relative-to"=>"jboss.server.log.dir"})
{"outcome" => "success"}
[standalone@localhost:9999 /]
フォーマッターの設定
次の構文で write-attribute 操作を使用します。
 /subsystem=logging/periodic-rotating-file-handle=HANDLER:write-attribute(name="formatter", value="FORMAT") 
HANDLER を周期ログハンドラーの名前と置き換えます。FORMAT を必要なフォーマッター文字列に置き換えます。

例11.36 フォーマッターの設定

[standalone@l/subsystem=logging/periodic-rotating-file-handle=HOURLY_DEBUG:write-attribute(name="formatter", value="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"))
{"outcome" => "success"}
[standalone@localhost:9999 /]
ローテーションされるログの接尾辞の設定
次の構文で write-attribute 操作を使用します。
 /subsystem=logging/periodic-rotating-file-handle=HANDLER:write-attribute(name="suffix", value="SUFFIX") 
HANDLER をコンソールログハンドラーの名前と置き換えます。SUFFIX を必要なフォーマッター文字列に置き換えます。

例11.37

[standalone@l/subsystem=logging/periodic-rotating-file-handle=HOURLY_DEBUG:write-attribute(name="suffix", value=".yyyy-MM-dd-HH"))
{"outcome" => "success"}
[standalone@localhost:9999 /]
周期ログハンドラーの削除
次の構文で remove 操作を使用します。
 /subsystem=logging/periodic-rotating-file-handler=HANDLER:remove 
HANDLER を周期ログハンドラーの名前と置き換えます。

例11.38 周期ログハンドラーの削除

[standalone@localhost:9999 /] /subsystem=logging/periodic-rotating-file-handler=HOURLY_DEBUG:remove
{"outcome" => "success"}
[standalone@localhost:9999 /]