10.5. ログハンドラーの設定


ログハンドラーはキャプチャーしたメッセージの記録方法を定義します。

特定のログハンドラーを設定する場合は、該当するセクションを参照してください。

10.5.1. console ログハンドラーの設定

管理 CLI を使用して、JBoss EAP で console ログハンドラーを設定できます。または、管理コンソールから Configuration > Subsystems > Logging > Configuration に移動し、View をクリックしてから Handler > Console Handler を選択して設定することもできます。

次のタスクを実行して、console ログハンドラーを設定します。

  • 新しい console ログハンドラーの追加。
  • console ログハンドラーの設定。
  • console ログハンドラーのロガーへの割り当て。
重要

このログハンドラーをログプロファイル用に設定する場合は、/subsystem=logging/ ではなく、/subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ でコマンドを開始します。

さらに、マネージドドメインで実行している場合はコマンドの前に /profile=PROFILE_NAME を付けます。

前提条件

  • JBoss EAP が実行している。
  • 管理 CLI にアクセスできる。

手順

  1. 次のコマンドを使用して、console ログハンドラーを追加します。

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:add
  2. 必要に応じて、次の console ログハンドラー属性を 1 つ以上設定できます。

    • 次のコマンドを使用して、ハンドラーのログレベルを設定します。

      /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

      デフォルトは ALL です。

    • 次のコマンドを使用して、ハンドラーのターゲットを設定します。

      /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=target,value=TARGET)

      ターゲットには、System.outSystem.errconsole を使用できます。デフォルト System.out です。

    • 次のコマンドを使用して、ハンドラーのエンコーディング (utf-8 など) を設定します。

      /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    • 次のコマンドを使用して、ハンドラーのフォーマッター文字列を設定します。

      /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)

      たとえば、デフォルトの書式設定文字列は %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n です。FORMAT 値は引用符で囲みます。

      注記

      保存されたフォーマッター を参照する場合は named-formatter 属性を使用します。

    • 次のコマンドを使用して自動フラッシュを設定します。

      /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)

      書き込み後に、毎回自動的にフラッシュするかどうかを設定します。デフォルト値は true です。

    • 次のコマンドを使用してフィルター式を設定します。

      /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

      ハンドラーのログメッセージをフィルタリングする式を指定します。コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、フィルター式 not(match("WFLY")) を作成するには、FILTER_EXPRESSION 変数を "not(match(\"WFLY\"))" に置き換えます。

  3. 次のコマンドを使用して、console ログハンドラーをロガーに割り当てます。

    /subsystem=logging/root-logger=ROOT:add-handler(name=CONSOLE_HANDLER_NAME)

    ログハンドラーをアクティブ化するには、console ログハンドラーをルートロガーまたはその他のロガーに割り当てます。

  4. 必要に応じて、次のコマンドで remove 操作を使用してログハンドラーを削除できます。

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:remove
    注記

    ログ設定で不要になったログハンドラーは削除できます。ただし、ログハンドラーが現在ロガーまたは async ログハンドラーに割り当てられている場合は削除できません。

10.5.2. file ログハンドラーの設定

管理 CLI を使用して、JBoss EAP で file ログハンドラーを設定できます。または、管理コンソールから Configuration > Subsystems > Logging > Configuration に移動し、View をクリックしてから Handler > File Handler を選択して設定することもできます。

次のタスクを実行して、file ログハンドラーを設定します。

  • 新しい file ログハンドラーの追加。
  • file ログハンドラーの設定。
  • file ログハンドラーのロガーへの割り当て。
重要

このログハンドラーをログプロファイル用に設定する場合は、/subsystem=logging/ ではなく、/subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ でコマンドを開始します。

さらに、マネージドドメインで実行している場合はコマンドの前に /profile=PROFILE_NAME を付けます。

前提条件

  • JBoss EAP が実行している。
  • 管理 CLI にアクセスできる。

手順

  1. 次のコマンドを使用して、file ログハンドラーを追加します。

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH})
    注記

    file ログハンドラーを追加する場合、path および relative-to 属性で構成される file 属性を使用してファイルパスを指定します。path 属性を使用してファイル名が含まれるログファイルパスを設定します (例: my-log.log)。必要に応じて、relative-to 属性を使用して、パスが jboss.server.log.dir などの名前付きパスと相対していることを示します。

  2. 必要に応じて、次の file ログハンドラー属性を 1 つ以上設定できます。

    • 次のコマンドを使用して、ハンドラーのログレベルを設定します。

      /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

      デフォルトは ALL です。

    • 次のコマンドを使用して、ハンドラーの追記動作を設定します。

      /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=append,value=APPEND)

      サーバーの再起動時にファイルを上書きする場合は、append 属性を false に設定します。デフォルトでは、JBoss EAP はサーバーの再起動時に同じファイルにログメッセージを追記します。

    • 次のコマンドを使用して、ハンドラーのエンコーディング (utf-8 など) を設定します。

      /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    • 次のコマンドを使用して、ハンドラーのフォーマッター文字列を設定します。

      /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)

      たとえば、デフォルトの書式設定文字列は %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n です。FORMAT 値は引用符で囲みます。

      注記

      保存されたフォーマッター を参照する場合は named-formatter 属性を使用します。

    • 次のコマンドを使用して自動フラッシュを設定します。

      /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)

      書き込み後に、毎回自動的にフラッシュするかどうかを設定します。デフォルト値は true です。

    • 次のコマンドを使用してフィルター式を設定します。

      /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

      ハンドラーのログメッセージをフィルタリングする式を指定します。コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、フィルター式 not(match("WFLY")) を作成するには、FILTER_EXPRESSION 変数を "not(match(\"WFLY\"))" に置き換えます。

  3. 次のコマンドを使用して、file ログハンドラーをロガーに割り当てます。

    /subsystem=logging/root-logger=ROOT:add-handler(name=FILE_HANDLER_NAME)

    ログハンドラーをアクティブ化するには、file ログハンドラーをルートロガーまたはその他のロガーに割り当てます。

  4. 次のコマンドを使用して、file ログハンドラーを CATEGORY という名前の特定のロガーに割り当てます。

    /subsystem=logging/logger=CATEGORY:add-handler(name=FILE_HANDLER_NAME)

    CATEGORY は、ファイルログハンドラーを割り当てるロガーの名前に置き換えます。

  5. 必要に応じて、次のコマンドで remove 操作を使用してログハンドラーを削除できます。

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:remove
    注記

    ログ設定で不要になったログハンドラーは削除できます。ただし、ログハンドラーが現在ロガーまたは async ログハンドラーに割り当てられている場合は削除できません。

10.5.3. periodic rotating ログハンドラーの設定

管理 CLI を使用して、JBoss EAP で periodic rotating ログハンドラーを設定できます。または、管理コンソールから Configuration > Subsystems > Logging > Configuration に移動し、View をクリックしてから Handler > Periodic Handler を選択して設定することもできます。

次のタスクを実行して、periodic rotating ログハンドラーを設定します。

  • 新しい periodic rotating ログハンドラーの追加
  • periodic rotating ログハンドラーの設定
  • periodic rotating ログハンドラーのロガーへの割り当て
重要

このログハンドラーをログプロファイル用に設定する場合は、/subsystem=logging/ ではなく、/subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ でコマンドを開始します。

さらに、マネージドドメインで実行している場合はコマンドの前に /profile=PROFILE_NAME を付けます。

前提条件

  • JBoss EAP が実行している。
  • 管理 CLI にアクセスできる。

手順

  1. 次のコマンドを使用して、periodic rotating ログハンドラーを追加します。

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH},suffix=SUFFIX)
    注記

    periodic rotating ログハンドラーを追加する場合、path および relative-to 属性で構成される file 属性を使用してファイルパスを指定します。path 属性を使用してファイル名が含まれるログファイルパスを設定します (例: my-log.log)。必要に応じて、relative-to 属性を使用して、パスが jboss.server.log.dir などの名前付きパスと相対していることを示します。

    suffix 属性を使用してローテーションしたログの接尾辞を設定する必要もあります。接尾辞は、java.text.SimpleDateFormat が理解できる形式 (例: .yyyy-MM-dd-HH) に従う必要があります。ローテーションの周期は、この接尾辞を基に自動的に算出されます。

  2. 必要に応じて、次の periodic rotating ログハンドラー属性を 1 つ以上設定できます。

    • 次のコマンドを使用して、ハンドラーのログレベルを設定します。

      /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

      デフォルトは ALL です。

    • 次のコマンドを使用して、ハンドラーの追記動作を設定します。

      /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=append,value=APPEND)

      サーバーの再起動時にファイルを上書きする場合は、append 属性を false に設定します。デフォルトでは、JBoss EAP はサーバーの再起動時に同じファイルにログメッセージを追記します。

    • 次のコマンドを使用して、ハンドラーのエンコーディング (utf-8 など) を設定します。

      /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    • 次のコマンドを使用して、ハンドラーのフォーマッター文字列を設定します。

      /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)

      たとえば、デフォルトの書式設定文字列は %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n です。FORMAT 値は引用符で囲みます。

      注記

      保存されたフォーマッター を参照する場合は named-formatter 属性を使用します。

    • 次のコマンドを使用して自動フラッシュを設定します。

      /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)

      書き込み後に、毎回自動的にフラッシュするかどうかを設定します。デフォルト値は true です。

    • 次のコマンドを使用してフィルター式を設定します。

      /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

      ハンドラーのログメッセージをフィルタリングする式を指定します。コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、フィルター式 not(match("WFLY")) を作成するには、FILTER_EXPRESSION 変数を "not(match(\"WFLY\"))" に置き換えます。

  3. 次のコマンドを使用して、periodic rotating ログハンドラーをロガーに割り当てます。

    /subsystem=logging/root-logger=ROOT:add-handler(name=PERIODIC_HANDLER_NAME)

    ログハンドラーをアクティブ化するには、periodic rotating ログハンドラーをルートロガーまたはその他のロガーに割り当てます。

  4. 必要に応じて、次のコマンドで remove 操作を使用してログハンドラーを削除できます。

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:remove
    注記

    ログ設定で不要になったログハンドラーは削除できます。ただし、ログハンドラーが現在ロガーまたは async ログハンドラーに割り当てられている場合は削除できません。

10.5.4. size rotating ログハンドラーの設定

管理 CLI を使用して、JBoss EAP で size ログハンドラーを設定できます。または、管理コンソールから Configuration > Subsystems > Logging > Configuration に移動し、View をクリックしてから Handler > Size Handler を選択して設定することもできます。

次のタスクを実行して、size ログハンドラーを設定します。

  • 新しい size ログハンドラーの追加
  • size ログハンドラーの設定
  • size ログハンドラーのロガーへの割り当て
重要

このログハンドラーをログプロファイル用に設定する場合は、/subsystem=logging/ ではなく、/subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ でコマンドを開始します。

さらに、マネージドドメインで実行している場合はコマンドの前に /profile=PROFILE_NAME を付けます。

前提条件

  • JBoss EAP が実行している。
  • 管理 CLI にアクセスできる。

手順

  1. 次のコマンドを使用して、size ログハンドラーを追加します。

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH})
    注記

    size ログハンドラーを追加する場合、path および relative-to 属性で構成される file 属性を使用してファイルパスを指定します。path 属性を使用してファイル名が含まれるログファイルパスを設定します (例: my-log.log)。必要に応じて、relative-to 属性を使用して、パスが jboss.server.log.dir などの名前付きパスと相対していることを示します。

  2. 必要に応じて、次の size ログハンドラー属性を 1 つ以上設定できます。

    • 次のコマンドを使用して、ハンドラーのログレベルを設定します。

      /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

      デフォルトは ALL です。

    • 次のコマンドを使用して、ローテーションされたログの接尾辞を設定します。

      /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=suffix, value=SUFFIX)
      注記

      指定する場合、接尾辞は java.text.SimpleDateFormat が理解できる形式 (例: .yyyy-MM-dd-HH) に従う必要があります。size-rotating-file-handler の場合、接尾辞はオプションです。これは、ローテーション期間そのものではなく、ファイルがローテーションされた日時を示します。

    • 次のコマンドを使用して、ハンドラーのエンコーディング (utf-8 など) を設定します。

      /subsystem=logging/size-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    • 次のコマンドを使用して、ローテーションサイズを設定します。

      /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=rotate-size, value=ROTATE_SIZE)

      ローテーション前の最大ファイルサイズを設定します。デフォルトは 2 メガバイトを意味する 2m です。

    • 次のコマンドを使用して、保持するバックアップログの最大数を設定します。

      /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=max-backup-index, value=MAX_BACKUPS)

      保持するバックアップの数を指定します。デフォルトは 1 です。

      注記

      ローテーションは、接尾辞ではなくサイズ制限に基づいて発生します。接尾辞が定義されている場合、ローテーションされたファイルにその接尾辞が追加されますが、それらのファイルは削除されません。ローテーション中に、サイズ制限に達したファイルのみが削除されます。

    • 次のコマンドを使用して、起動時にログをローテーションするかどうかを設定します。

      /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=rotate-on-boot, value=ROTATE_ON_BOOT)

      デフォルトでは、サーバーの再起動時に新しいログファイルは作成されません。サーバーの再起動時にログをローテーションするには、これを true に設定します。

    • 次のコマンドを使用して、ハンドラーの追記動作を設定します。

      /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=append,value=APPEND)

      サーバーの再起動時にファイルを上書きする場合は、append 属性を false に設定します。デフォルトでは、JBoss EAP はサーバーの再起動時に同じファイルにログメッセージを追記します。

    • 次のコマンドを使用して、ハンドラーのエンコーディング (utf-8 など) を設定します。

      /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    • 次のコマンドを使用して、ハンドラーのフォーマッター文字列を設定します。

      /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)

      たとえば、デフォルトの書式設定文字列は %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n です。FORMAT 値は引用符で囲みます。

      注記

      保存されたフォーマッター を参照する場合は named-formatter 属性を使用します。

    • 次のコマンドを使用して自動フラッシュを設定します。

      /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)

      書き込み後に、毎回自動的にフラッシュするかどうかを設定します。デフォルト値は true です。

    • 次のコマンドを使用してフィルター式を設定します。

      /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

      ハンドラーのログメッセージをフィルタリングする式を指定します。コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、フィルター式 not(match("WFLY")) を作成するには、FILTER_EXPRESSION 変数を "not(match(\"WFLY\"))" に置き換えます。

  3. 次のコマンドを使用して、size ログハンドラーをロガーに割り当てます。

    /subsystem=logging/root-logger=ROOT:add-handler(name=SIZE_HANDLER_NAME)

    ログハンドラーをアクティブ化するには、size ログハンドラーをルートロガーまたはその他のロガーに割り当てます。

  4. 必要に応じて、次のコマンドで remove 操作を使用してログハンドラーを削除できます。

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:remove
    注記

    ログ設定で不要になったログハンドラーは削除できます。ただし、ログハンドラーが現在ロガーまたは async ログハンドラーに割り当てられている場合は削除できません。

10.5.5. periodic size rotating ログハンドラーの設定

管理 CLI を使用して、JBoss EAP で periodic size ログハンドラーを設定できます。または、管理コンソールから Configuration > Subsystems > Logging > Configuration に移動し、View をクリックしてから Handler > Periodic Size Handler を選択して設定することもできます。

次のタスクを実行して、periodic size ログハンドラーを設定します。

  • 新しい periodic size ログハンドラーの追加
  • periodic size ログハンドラーの設定
  • periodic size ログハンドラーのロガーへの割り当て
重要

このログハンドラーをログプロファイル用に設定する場合は、/subsystem=logging/ ではなく、/subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ でコマンドを開始します。

さらに、マネージドドメインで実行している場合はコマンドの前に /profile=PROFILE_NAME を付けます。

前提条件

  • JBoss EAP が実行している。
  • 管理 CLI にアクセスできる。

手順

  1. 次のコマンドを使用して、periodic size ログハンドラーを追加します。

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH},suffix=SUFFIX)
    注記

    periodic size ログハンドラーを追加する場合、path および relative-to 属性で構成される file 属性を使用してファイルパスを指定します。path 属性を使用してファイル名が含まれるログファイルパスを設定します (例: my-log.log)。必要に応じて、relative-to 属性を使用して、パスが jboss.server.log.dir などの名前付きパスと相対していることを示します。

    suffix 属性を使用してローテーションしたログの接尾辞を設定する必要もあります。接尾辞は、java.text.SimpleDateFormat が理解できる形式 (例: .yyyy-MM-dd-HH) に従う必要があります。ローテーションの周期は、この接尾辞を基に自動的に算出されます。

  2. 必要に応じて、次の periodic size ログハンドラー属性を 1 つ以上設定できます。

    • 次のコマンドを使用して、ハンドラーのログレベルを設定します。

      /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

      デフォルトは ALL です。

    • 次のコマンドを使用して、ローテーションサイズを設定します。

      /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=rotate-size, value=ROTATE_SIZE)

      ローテーション前の最大ファイルサイズを設定します。デフォルトは 2 メガバイトを意味する 2m です。

    • 次のコマンドを使用して、保持するバックアップログの最大数を設定します。

      /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=max-backup-index, value=MAX_BACKUPS)

      保持するバックアップの数を指定します。デフォルトは 1 です。

      注記

      接尾辞を使用してローテーションした場合、ローテーションされたファイルは削除されません。ローテーション時にサイズ制限に達したファイルのみがローテーション中に削除されます。

    • 次のコマンドを使用して、起動時にログをローテーションするかどうかを設定します。

      /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=rotate-on-boot, value=ROTATE_ON_BOOT)

      デフォルトでは、サーバーの再起動時に新しいログファイルは作成されません。サーバーの再起動時にログをローテーションするには、これを true に設定します。

    • 次のコマンドを使用して、ハンドラーの追記動作を設定します。

      /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=append,value=APPEND)

      サーバーの再起動時にファイルを上書きする場合は、append 属性を false に設定します。デフォルトでは、JBoss EAP はサーバーの再起動時に同じファイルにログメッセージを追記します。

    • 次のコマンドを使用して、ハンドラーのエンコーディング (utf-8 など) を設定します。

      /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    • 次のコマンドを使用して、ハンドラーのフォーマッター文字列を設定します。

      /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)

      たとえば、デフォルトの書式設定文字列は %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n です。FORMAT 値は引用符で囲みます。

      注記

      保存されたフォーマッター を参照する場合は named-formatter 属性を使用します。

    • 次のコマンドを使用して自動フラッシュを設定します。

      /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)

      書き込み後に、毎回自動的にフラッシュするかどうかを設定します。デフォルト値は true です。

    • 次のコマンドを使用してフィルター式を設定します。

      /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

      ハンドラーのログメッセージをフィルタリングする式を指定します。コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、フィルター式 not(match("WFLY")) を作成するには、FILTER_EXPRESSION 変数を "not(match(\"WFLY\"))" に置き換えます。

  3. 次のコマンドを使用して、periodic size ログハンドラーをロガーに割り当てます。

    /subsystem=logging/root-logger=ROOT:add-handler(name=PERIODIC_SIZE_HANDLER_NAME)

    ログハンドラーをアクティブ化するには、periodic size ログハンドラーをルートロガーまたはその他のロガーに割り当てます。

  4. 必要に応じて、次のコマンドで remove 操作を使用してログハンドラーを削除できます。

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:remove
    注記

    ログ設定で不要になったログハンドラーは削除できます。ただし、ログハンドラーが現在ロガーまたは async ログハンドラーに割り当てられている場合は削除できません。

10.5.6. Syslog ハンドラーの設定

管理 CLI を使用して、JBoss EAP で syslog ログハンドラーを設定できます。このハンドラーは、RFC-3164 または RFC-5424 のいずれかの Syslog プロトコルをサポートするリモートロギングサーバーにメッセージを送信します。または、管理コンソールから Configuration > Subsystems > Logging > Configuration に移動し、View をクリックしてから Handler > Syslog Handler を選択して設定することもできます。

次のタスクを実行して、syslog ログハンドラーを設定します。

  • 新しい syslog ハンドラーの追加
  • syslog ハンドラーの設定
  • syslog ハンドラーのロガーへの割り当て
重要

このログハンドラーをログプロファイル用に設定する場合は、/subsystem=logging/ ではなく、/subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ でコマンドを開始します。

さらに、マネージドドメインで実行している場合はコマンドの前に /profile=PROFILE_NAME を付けます。

前提条件

  • JBoss EAP が実行している。
  • 管理 CLI にアクセスできる。

手順

  1. 次のコマンドを使用して、syslog ハンドラーを追加します。

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:add
  2. 必要に応じて、次の syslog ハンドラー属性を 1 つ以上設定できます。

    • 次のコマンドを使用して、ハンドラーのログレベルを設定します。

      /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

      デフォルトは ALL です。

    • 次のコマンドを使用して、ロギングのアプリケーション名を設定します。

      /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=app-name,value=APP_NAME)

      デフォルトのアプリケーション名は java です。

    • 次のコマンドを使用して、syslog サーバーのアドレスを設定します。

      /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=server-address,value=SERVER_ADDRESS)

      デフォルトのアドレスは localhost です。

    • 次のコマンドを使用して、syslog サーバーのポートを設定します。

      /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=port,value=PORT)

      デフォルトのポートは 514 です。

    • 次のコマンドを使用して、RFC 仕様に従って syslog 形式を設定します。

      /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=syslog-format,value=SYSLOG_FORMAT)

      デフォルトの形式は RFC5424 です。

    • 次のコマンドを使用して、syslog ペイロードメッセージをフォーマットする named-formatter 属性を指定します。

      /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=named-formatter, value=FORMATTER_NAME)
  3. 次のコマンドを使用して、syslog ハンドラーをロガーに割り当てます。

    /subsystem=logging/root-logger=ROOT:add-handler(name=SYSLOG_HANDLER_NAME)

    ログハンドラーをアクティブ化するには、syslog ハンドラーをルートロガーまたはその他のロガーに割り当てます。

  4. 必要に応じて、次のコマンドで remove 操作を使用してログハンドラーを削除できます。

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:remove
    注記

    ログ設定で不要になったログハンドラーは削除できます。ただし、ログハンドラーが現在ロガーまたは async ログハンドラーに割り当てられている場合は削除できません。

10.5.7. socket ログハンドラーの設定

管理 CLI を使用して、JBoss EAP で socket ログハンドラーを設定できます。ハンドラーは TCP または UDP ソケットを介してメッセージを送信します。または、管理コンソールから Configuration > Subsystems > Logging > Configuration に移動し、View をクリックしてから Handler > Socket Handler を選択して設定することもできます。

注記

サーバーが管理者専用モードで起動すると、ログメッセージは破棄されます。

次のタスクを実行して、socket ログハンドラーを設定します。

  • ソケットバインディングの追加
  • ログフォーマッターの追加
  • socket ログハンドラーの追加
  • 設定の構成
  • socket ログハンドラーのロガーへの割り当て
重要

このログハンドラーをログプロファイル用に設定する場合は、/subsystem=logging/ ではなく、/subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ でコマンドを開始します。

さらに、マネージドドメインで実行している場合はコマンドの前に /profile=PROFILE_NAME を付けます。

前提条件

  • JBoss EAP が実行している。
  • 管理 CLI にアクセスできる。

手順

  1. 次のコマンドを使用して、ソケットバインディングを追加します。

    /socket-binding-group=SOCKET_BINDING_GROUP/remote-destination-outbound-socket-binding=SOCKET_BINDING_NAME:add(host=HOST, port=PORT)
    注記

    使用する ソケットバインディング として、remote-destination-outbound-socket-binding または local-destination-outbound-socket-binding を定義できます。

  2. 次のコマンドを使用して、使用する ログフォーマッタ (JSON フォーマッターなど) を追加します。

    /subsystem=logging/json-formatter=FORMATTER:add
  3. 次のコマンドを使用して、使用するソケットバインディングとフォーマッターを指定して、ソケットログハンドラーを追加します。

    /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:add(outbound-socket-binding-ref=SOCKET_BINDING_NAME,named-formatter=FORMATTER)
  4. 必要に応じて、次の socket ログハンドラー属性を 1 つ以上設定できます。

    • 次のコマンドを使用してプロトコルを設定します。

      /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=protocol,value=PROTOCOL)

      デフォルトのプロトコルは TCP です。

    • 次のコマンドを使用して、ハンドラーのログレベルを設定します。

      /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

      デフォルトは ALL です。

      注記

      サーバーの起動中、socket ログハンドラーによって処理されるログメッセージは、ソケットバインディングが設定され、logging サブシステムが初期化されるまでキューに置かれます。ログレベルを低く (TRACEDEBUG など) 設定すると、起動時に大量のメモリーが消費される可能性があります。

    • 次のコマンドを使用して、ハンドラーのエンコーディング (utf-8 など) を設定します。

      /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    • 次のコマンドを使用して自動フラッシュを設定します。

      /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)

      書き込み後に、毎回自動的にフラッシュするかどうかを設定します。デフォルト値は true です。

    • 次のコマンドを使用してフィルター式を設定します。

      /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

      ハンドラーのログメッセージをフィルタリングする式を指定します。コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、フィルター式 not(match("WFLY")) を作成するには、FILTER_EXPRESSION 変数を "not(match(\"WFLY\"))" に置き換えます。

  5. 次のコマンドを使用して、socket ログハンドラーをロガーに割り当てます。

    /subsystem=logging/root-logger=ROOT:add-handler(name=SOCKET_HANDLER_NAME)

    ログハンドラーをアクティブ化するには、socket ログハンドラーをルートロガーまたはその他のロガーに割り当てます。

  6. 必要に応じて、次のコマンドで remove 操作を使用して socket ログハンドラーを削除できます。

    /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:remove
    注記

    ログ設定で不要になったログハンドラーは削除できます。ただし、ログハンドラーが現在ロガーまたは async ログハンドラーに割り当てられている場合は削除できません。

10.5.7.1. SSL/TLS 経由でソケットログメッセージを送信する

SSL_TCP プロトコルを使用してソケット経由でログメッセージを送信するように socket ログハンドラーを設定できます。このセットアップには、キーストア、信頼マネージャー、クライアント SSL コンテキストなど、elytron サブシステムの主要コンポーネントの設定が含まれます。この設定により、ルートロガーからのログメッセージは、JSON フォーマッターによってフォーマットされ、指定されたソケットを介して安全に送信されます。

前提条件

  • JBoss EAP が実行している。

手順

  1. 次のステップを実行して、Elytron の設定を行います。

    1. 次のコマンドを使用して、キーストアを追加します。

      /subsystem=elytron/key-store=log-server-ks:add(path=/path/to/keystore.jks, type=JKS, credential-reference={clear-text=mypassword})
    2. 次のコマンドを使用して、信頼マネージャーを追加します。

      /subsystem=elytron/trust-manager=log-server-tm:add(key-store=log-server-ks)
    3. 次のコマンドを使用して、クライアント SSL コンテキストを追加します。

      /subsystem=elytron/client-ssl-context=log-server-context:add(trust-manager=log-server-tm, protocols=["TLSv1.2"])
  2. 次のコマンドを使用して、ソケットバインディングを追加します。

    /socket-binding-group=standard-sockets/remote-destination-outbound-socket-binding=log-server:add(host=localhost, port=4560)
  3. 次のコマンドを使用して、JSON フォーマッターを追加します。

    /subsystem=logging/json-formatter=json:add
  4. 次のコマンドを使用して、socket ログハンドラーを追加します。

    /subsystem=logging/socket-handler=log-server-handler:add(named-formatter=json, level=INFO, outbound-socket-binding-ref=log-server, protocol=SSL_TCP, ssl-context=log-server-context)
  5. 次のコマンドを使用して、ログハンドラーをルートロガーに割り当てます。

    /subsystem=logging/root-logger=ROOT:add-handler(name=log-server-handler)

10.5.8. custom ログハンドラーの設定

管理 CLI を使用して、JBoss EAP で custom ログハンドラーを設定できます。または、管理コンソールから Configuration > Subsystems > Logging > Configuration に移動し、View をクリックしてから Handler > Custom Handler を選択して設定することもできます。

次のタスクを実行して、custom ログハンドラーを設定します。

  • 新しい custom ログハンドラーの追加
  • custom ログハンドラーの設定
  • custom ログハンドラーのロガーへの割り当て
重要

このログハンドラーをログプロファイル用に設定する場合は、/subsystem=logging/ ではなく、/subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ でコマンドを開始します。

さらに、マネージドドメインで実行している場合はコマンドの前に /profile=PROFILE_NAME を付けます。

前提条件

  • JBoss EAP が実行している。
  • 管理 CLI にアクセスできる。

手順

  1. 次のコマンドを使用して、custom ログハンドラーを追加します。

    /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:add(class=CLASS_NAME,module=MODULE_NAME)
    注記

    custom ログハンドラーを追加する場合は、ハンドラーの Java クラスとそれが含まれる JBoss EAP モジュールを指定します。クラスは java.util.logging.Handler を拡張する必要があります。

    カスタムロガーが含まれる モジュールを作成した ことを確認してください。作成されていない場合、このコマンドは失敗します。

  2. 必要に応じて、次の custom ログハンドラー属性を 1 つ以上設定できます。

    • 次のコマンドを使用して、ハンドラーのログレベルを設定します。

      /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

      デフォルトは ALL です。

    • 次のコマンドを使用して、ログハンドラーのプロパティーを設定します。

      /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=properties.PROPERTY_NAME,value=PROPERTY_VALUE)

      setter メソッドを使用してプロパティーにアクセスできなければなりません。

    • 次のコマンドを使用して、ハンドラーのエンコーディング (utf-8 など) を設定します。

      /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    • 次のコマンドを使用して、ハンドラーのフォーマッター文字列を設定します。

      /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)

      たとえば、デフォルトの書式設定文字列は %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n です。FORMAT 値は引用符で囲みます。

      注記

      保存されたフォーマッター を参照する場合は named-formatter 属性を使用します。

    • 次のコマンドを使用してフィルター式を設定します。

      /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

      ハンドラーのログメッセージをフィルタリングする式を指定します。コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、フィルター式 not(match("WFLY")) を作成するには、FILTER_EXPRESSION 変数を "not(match(\"WFLY\"))" に置き換えます。

  3. 次のコマンドを使用して、custom ログハンドラーをロガーに割り当てます。

    /subsystem=logging/root-logger=ROOT:add-handler(name=CUSTOM_HANDLER_NAME)

    ログハンドラーをアクティブ化するには、ハンドラーをルートロガーまたはその他のロガーに割り当てます。

  4. 次のコマンドを使用して、custom ログハンドラーを CATEGORY という名前の特定のロガーに割り当てます。

    /subsystem=logging/logger=CATEGORY:add-handler(name=CUSTOM_HANDLER_NAME)

    CATEGORY は、custom ログハンドラーを割り当てるロガーの名前に置き換えます。

  5. 必要に応じて、次のコマンドで remove 操作を使用して custom ログハンドラーを削除できます。

    /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:remove
    注記

    ログ設定で不要になったログハンドラーは削除できます。ただし、ログハンドラーが現在ロガーまたは async ログハンドラーに割り当てられている場合は削除できません。

10.5.9. async ログハンドラーの設定

管理 CLI を使用して、JBoss EAP で async ログハンドラーを設定できます。または、管理コンソールから Configuration > Subsystems > Logging > Configuration に移動し、View をクリックしてから Handler > Async Handler を選択して設定することもできます。

次のタスクを実行して、async ログハンドラーを設定します。

  • 新しい非同期ログハンドラーの追加
  • サブハンドラーの async ログハンドラーへの追加
  • async ログハンドラーの設定
  • async ログハンドラーのロガーへの割り当て
重要

このログハンドラーをログプロファイル用に設定する場合は、/subsystem=logging/ ではなく、/subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ でコマンドを開始します。

さらに、マネージドドメインで実行している場合はコマンドの前に /profile=PROFILE_NAME を付けます。

前提条件

  • JBoss EAP が実行している。
  • 管理 CLI にアクセスできる。

手順

  1. 次のコマンドを使用して、async ログハンドラーを追加します。

    /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:add(queue-length=QUEUE_LENGTH)
    注記

    async ログハンドラーを追加する場合は、キューの長さを指定します。これは、指定された任意の時点でキューに保持できるログ要求の最大数です。

  2. 次のコマンドを使用してサブハンドラーを追加します。

    /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:add-handler(name=HANDLER_NAME)
    注記

    1 つ以上のハンドラーを async ログハンドラーのサブハンドラーとして追加できます。ハンドラーが設定内にすでに存在している必要があります。そうでない場合、このコマンドは失敗します。

  3. 必要に応じて、次の async ログハンドラー属性を 1 つ以上設定できます。

    • 次のコマンドを使用して、ハンドラーのログレベルを設定します。

      /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:write-attribute(name=level,value=LEVEL)

      デフォルトは ALL です。

    • 次のコマンドを使用して、オーバーフローアクションを設定します。

      /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:write-attribute(name=overflow-action,value=OVERFLOW_ACTION)

      デフォルト値は BLOCK です。これは、キューがいっぱいの場合にスレッドがブロックされることを意味します。この値を DISCARD に変更すると、キューがいっぱいになった場合に、新しいメッセージを収容するために最も古いログメッセージが削除されます。

    • 次のコマンドを使用してフィルター式を設定します。

      /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)

      ハンドラーのログメッセージをフィルタリングする式を指定します。コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、フィルター式 not(match("WFLY")) を作成するには、FILTER_EXPRESSION 変数を "not(match(\"WFLY\"))" に置き換えます。

  4. 次のコマンドを使用して、async ログハンドラーをロガーに割り当てます。

    /subsystem=logging/root-logger=ROOT:add-handler(name=ASYNC_HANDLER_NAME)

    ログハンドラーをアクティブ化するには、async ログハンドラーをルートロガーまたはその他のロガーに割り当てます。

  5. 必要に応じて、次のコマンドで remove 操作を使用して async ログハンドラーを削除できます。

    /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:remove
    注記

    ログ設定で不要になったログハンドラーは削除できます。ただし、ログハンドラーが現在ロガーに割り当てられている場合は削除できません。

Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2026 Red Hat
トップに戻る