A.17. ログハンドラーの属性

注記

これらの表は、管理モデルで使用される属性名を示しています (管理 CLI を使用している場合など)。XML で使用される名前は管理モデルの名前と異なる場合があるため、XML で使用される要素を EAP_HOME/docs/schema/jboss-as-logging_6_0.xsd のスキーマ定義ファイルで確認してください。

表A.31 Console ログハンドラーの属性

属性	説明
autoflush	`true` に設定すると、ログメッセージは受信直後にハンドラー割り当てファイルに送信されます。
enabled	`true` に設定された場合、ハンドラーが有効になり、通常とおり機能します。`false` に設定された場合、ログメッセージの処理時にハンドラーが無視されます。
encoding	出力に使用する文字エンコーディングスキーム。
filter	簡単なフィルタータイプを定義します。`filter-spec` が導入されたため非推奨になりました。
filter-spec	フィルターを定義する式の値。式 `not(match("WFLY.*")` はパターンに一致しないフィルターを定義します。
formatter	このログハンドラーで使用するログフォーマッター。
level	ログハンドラーが記録するログメッセージの最低レベル。
name	ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため非推奨になりました。
named-formatter	ハンドラーで使用する定義されたフォーマッターの名前。
target	ログハンドラーの出力が送信されるシステム出力ストリーム。以下の 1 つになります。 `System.err`: ログハンドラーの出力はシステムエラーストリームに送信されます。 `System.out`: ログハンドラーの出力は標準出力ストリームに送信されます。 `console`: ログハンドラーの出力は `java.io.PrintWriter` クラスに送信されます。

表A.32 File ログハンドラーの属性

属性	説明
append	`true` に設定された場合、このハンドラーが書き込んだすべてのメッセージがファイル (すでに存在する場合) に追加されます。`false` に設定された場合、アプリケーションサーバーが起動されるたびに、新しいファイルが作成されます。
autoflush	`true` に設定すると、ログメッセージは受信直後にハンドラー割り当てファイルに送信されます。
enabled	`true` に設定された場合、ハンドラーが有効になり、通常とおり機能します。`false` に設定された場合、ログメッセージの処理時にハンドラーが無視されます。
encoding	出力に使用する文字エンコーディングスキーム。
file	このログハンドラーの出力が書き込まれるファイルを表すオブジェクト。このオブジェクトには、`relative-to` と `path` の 2 つの設定プロパティーが含まれます。
filter	簡単なフィルタータイプを定義します。`filter-spec` が導入されたため非推奨になりました。
filter-spec	フィルターを定義する式の値。式 `not(match("WFLY.*")` はパターンに一致しないフィルターを定義します。
formatter	このログハンドラーで使用するログフォーマッター。
level	ログハンドラーが記録するログメッセージの最低レベル。
name	ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため非推奨になりました。
named-formatter	ハンドラーで使用する定義されたフォーマッターの名前。

表A.33 Periodic ログハンドラーの属性

属性	説明
append	`true` に設定された場合、このハンドラーが書き込んだすべてのメッセージがファイル (すでに存在する場合) に追加されます。`false` に設定された場合、アプリケーションサーバーが起動されるたびに、新しいファイルが作成されます。
autoflush	`true` に設定すると、ログメッセージは受信直後にハンドラー割り当てファイルに送信されます。
enabled	`true` に設定された場合、ハンドラーが有効になり、通常とおり機能します。`false` に設定された場合、ログメッセージの処理時にハンドラーが無視されます。
encoding	出力に使用する文字エンコーディングスキーム。
file	このログハンドラーの出力が書き込まれるファイルを表すオブジェクト。このオブジェクトには、`relative-to` と `path` の 2 つの設定プロパティーが含まれます。
filter	簡単なフィルタータイプを定義します。`filter-spec` が導入されたため非推奨になりました。
filter-spec	フィルターを定義する式の値。式 `not(match("WFLY.*")` はパターンに一致しないフィルターを定義します。
formatter	このログハンドラーで使用するログフォーマッター。
level	ログハンドラーが記録するログメッセージの最低レベル。
name	ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため非推奨になりました。
named-formatter	ハンドラーで使用する定義されたフォーマッターの名前。
suffix	この文字列はローテーションログに追加される接尾辞に含まれます。`suffix` の書式は、ドット (`.`) の後に `SimpleDateFormat` クラスが解析できる日付の文字列を追加したものです。

表A.34 Size ログハンドラーの属性

属性	説明
append	`true` に設定された場合、このハンドラーが書き込んだすべてのメッセージがファイル (すでに存在する場合) に追加されます。`false` に設定された場合、アプリケーションサーバーが起動されるたびに、新しいファイルが作成されます。
autoflush	`true` に設定すると、ログメッセージは受信直後にハンドラー割り当てファイルに送信されます。
enabled	`true` に設定された場合、ハンドラーが有効になり、通常とおり機能します。`false` に設定された場合、ログメッセージの処理時にハンドラーが無視されます。
encoding	出力に使用する文字エンコーディングスキーム。
file	このログハンドラーの出力が書き込まれるファイルを表すオブジェクト。このオブジェクトには、`relative-to` と `path` の 2 つの設定プロパティーが含まれます。
filter	簡単なフィルタータイプを定義します。`filter-spec` が導入されたため非推奨になりました。
filter-spec	フィルターを定義する式の値。式 `not(match("WFLY.*")` はパターンに一致しないフィルターを定義します。
formatter	このログハンドラーで使用するログフォーマッター。
level	ログハンドラーが記録するログメッセージの最低レベル。
max-backup-index	保持するローテーションログの最大数。この数に達すると、古いログが再使用されます。デフォルト値は `1` です。 `suffix` 属性が使用された場合は、ローテーションログファイルの接尾辞がローテーションアルゴリズムに含まれます。ログファイルがローテーションされると、名前が `name`+`suffix` で始まる最も古いファイルが削除され、残りのローテーションログファイルの数値接尾辞が増分され、新しくローテーションされたログファイルに数値接尾辞 `1` が提供されます。
name	ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため非推奨になりました。
named-formatter	ハンドラーで使用する定義されたフォーマッターの名前。
rotate-on-boot	`true` に設定されると、新しいログファイルがサーバーの起動時に作成されます。デフォルトは `false` です。
rotate-size	ログファイルがローテーションされる前に到達できる最大サイズです。数字に追加された単一の文字はサイズ単位を示します。バイトの場合は `b`、キロバイトの場合は `k`、メガバイトの場合は `m`、ギガバイトの場合は `g` になります。たとえば、50 メガバイトの場合は、`50m` になります。
suffix	この文字列はローテーションログに追加される接尾辞に含まれます。`suffix` の書式は、ドット (`.`) の後に `SimpleDateFormat` クラスが解析できる日付の文字列を追加したものです。

表A.35 Periodic Size ログハンドラーの属性

属性	説明
append	`true` に設定された場合、このハンドラーが書き込んだすべてのメッセージがファイル (すでに存在する場合) に追加されます。`false` に設定された場合、アプリケーションサーバーが起動されるたびに、新しいファイルが作成されます。
autoflush	`true` に設定すると、ログメッセージは受信直後にハンドラー割り当てファイルに送信されます。
enabled	`true` に設定された場合、ハンドラーが有効になり、通常とおり機能します。`false` に設定された場合、ログメッセージの処理時にハンドラーが無視されます。
encoding	出力に使用する文字エンコーディングスキーム。
file	このログハンドラーの出力が書き込まれるファイルを表すオブジェクト。このオブジェクトには、`relative-to` と `path` の 2 つの設定プロパティーが含まれます。
filter-spec	フィルターを定義する式の値。式 `not(match("WFLY.*")` はパターンに一致しないフィルターを定義します。
formatter	このログハンドラーで使用するログフォーマッター。
level	ログハンドラーが記録するログメッセージの最低レベル。
max-backup-index	保持するローテーションログの最大数。この数に達すると、古いログが再使用されます。デフォルト値は `1` です。 `suffix` 属性が使用された場合は、ローテーションログファイルの接尾辞がローテーションアルゴリズムに含まれます。ログファイルがローテーションされると、名前が `name`+`suffix` で始まる最も古いファイルが削除され、残りのローテーションログファイルの数値接尾辞が増分され、新しくローテーションされたログファイルに数値接尾辞 `1` が提供されます。
name	ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため非推奨になりました。
named-formatter	ハンドラーで使用する定義されたフォーマッターの名前。
rotate-on-boot	`true` に設定されると、新しいログファイルがサーバーの起動時に作成されます。デフォルトは `false` です。
rotate-size	ログファイルがローテーションされる前に到達できる最大サイズです。数字に追加された単一の文字はサイズ単位を示します。バイトの場合は `b`、キロバイトの場合は `k`、メガバイトの場合は `m`、ギガバイトの場合は `g` になります。たとえば、50 メガバイトの場合は、`50m` になります。
suffix	この文字列はローテーションログに追加される接尾辞に含まれます。`suffix` の書式は、ドット (`.`) の後に `SimpleDateFormat` クラスが解析できる日付の文字列を追加したものです。

表A.36 syslog ハンドラーの属性

属性	説明
app-name	メッセージを RFC5424 形式でフォーマットするときに使用されるアプリケーション名。デフォルトのアプリケーション名は `java` です。
enabled	`true` に設定された場合、ハンドラーが有効になり、通常とおり機能します。`false` に設定された場合、ログメッセージの処理時にハンドラーが無視されます。
facility	RFC-5424 および RFC-3164 によって定義される機能。
hostname	メッセージ送信元のホストの名前。たとえば、アプリケーションサーバーが実行されているホストの名前になります。
level	ログハンドラーが記録するログメッセージの最低レベル。
port	syslog サーバーがリッスンしているポート。
server-address	syslog サーバーのアドレス。
syslog-format	RFC 仕様にしたがってログメッセージをフォーマットします。
named-formatter	syslog ペイロードのメッセージをフォーマットします。この属性を使用すると、必要に応じてメッセージをカスタマイズできます。

表A.37 Socket ログハンドラーの属性

属性	説明
autoflush	毎回書き込み後に自動的にフラッシュを行うかどうか。
block-on-reconnect	`true` に設定すると、再接続の試行時に書き込みメソッドがブロックされます。非同期ハンドラーの使用時のみ `true` に設定することが推奨されます。
enabled	`true` に設定された場合、ハンドラーが有効になり、通常とおり機能します。`false` に設定された場合、ログメッセージの処理時にハンドラーが無視されます。
encoding	このハンドラーによって使用される文字エンコーディング。
filter-spec	フィルターを定義する式の値。式 `not(match("WFLY.*")` はパターンに一致しないフィルターを定義します。
level	ログハンドラーが記録するログメッセージの最低レベル。
named-formatter	ハンドラーで使用する定義されたフォーマッターの名前。
outbound-socket-binding-ref	ソケット接続のアウトバウンドソケットバインディングへの参照。
protocol	ソケットが通信すべきプロトコル。使用できる値は `TCP`、`UDP`、および `SSL_TCP` です。
ssl-context	定義された SSL コンテキストへの参照。これは、`protocol` が `SSL_TCP` に設定された場合のみ使用されます。

表A.38 Custom ログハンドラーの属性

属性	説明
class	使用されるロギングハンドラークラス。
enabled	`true` に設定された場合、ハンドラーが有効になり、通常とおり機能します。`false` に設定された場合、ログメッセージの処理時にハンドラーが無視されます。
encoding	出力に使用する文字エンコーディングスキーム。
filter	簡単なフィルタータイプを定義します。`filter-spec` が導入されたため非推奨になりました。
filter-spec	フィルターを定義する式の値。式 `not(match("WFLY.*")` はパターンに一致しないフィルターを定義します。
formatter	このログハンドラーで使用するログフォーマッター。
level	ログハンドラーが記録するログメッセージの最低レベル。
module	ロギングハンドラーが依存するモジュール。
name	ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため非推奨になりました。
named-formatter	ハンドラーで使用する定義されたフォーマッターの名前。
properties	ロギングハンドラーに使用されるプロパティー。

表A.39 Async ログハンドラーの属性

属性	説明
enabled	`true` に設定された場合、ハンドラーが有効になり、通常とおり機能します。`false` に設定された場合、ログメッセージの処理時にハンドラーが無視されます。
filter	簡単なフィルタータイプを定義します。`filter-spec` が導入されたため非推奨になりました。
filter-spec	フィルターを定義する式の値。式 `not(match("WFLY.*")` はパターンに一致しないフィルターを定義します。
level	ログハンドラーが記録するログメッセージの最低レベル。
name	ログハンドラーの名前。ハンドラーのアドレスに名前が含まれるため非推奨になりました。
overflow-action	キューの長さを超えたときにこのハンドラーがどのように応答するかを示します。これは `BLOCK` または `DISCARD` に設定できます。`BLOCK` により、キューでスペースが利用可能になるまでロギングアプリケーションが待機します。これは、非同期でないログハンドラーと同じ動作です。`DISCARD` により、ロギングアプリケーションは動作し続けますが、ログメッセージは削除されます。
queue-length	サブハンドラーが応答するときに、このハンドラーが保持するログメッセージの最大数。
subhandlers	この async ハンドラーがログメッセージを渡すログハンドラーの一覧。

Select Your Language

Infrastructure and Management

Cloud Computing

Storage

Runtimes

Integration and Automation

A.17. ログハンドラーの属性

Language and Page Formatting Options

A.17. ログハンドラーの属性