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


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

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

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

管理 CLI を使用すると、JBoss EAP でコンソールログハンドラーを設定できます。または、管理コンソールから設定を設定するには、Configuration > Subsystems > Logging > Configuration と選択し、表示 をクリックして 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 の値は引用符で囲みます。

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

      /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)

      ハンドラーのログメッセージをフィルターする式の指定コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、FILTER_EXPRESSION 変数を "not (match (\"WFLY\")) " に置き換え、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 と選択し、表示 をクリックして 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 の値は引用符で囲みます。

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

      /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)

      ハンドラーのログメッセージをフィルターする式の指定コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、FILTER_EXPRESSION 変数を "not (match (\"WFLY\")) " に置き換え、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 と選択し、表示 をクリックして Handler > Periodic Handler を選択します。

以下のタスクを実行して、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 属性を使用してローテーションログの接尾辞を設定する必要があります。接尾辞は、.yyyy-MM-dd-HH のように java.text.SimpleDateFormat が理解できる形式に従う必要があります。ローテーション期間はこの接尾辞を基に自動的に算出されます。

  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 の値は引用符で囲みます。

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

      /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)

      ハンドラーのログメッセージをフィルターする式の指定コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、FILTER_EXPRESSION 変数を "not (match (\"WFLY\")) " に置き換え、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 と選択し、表示 をクリックして 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)
      注記

      指定されている場合、接尾辞は .yyyy-MM-dd-HH のように java.text.SimpleDateFormat が理解できる形式に従う必要があります。接尾辞は 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 の値は引用符で囲みます。

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

      /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)

      ハンドラーのログメッセージをフィルターする式の指定コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、FILTER_EXPRESSION 変数を "not (match (\"WFLY\")) " に置き換え、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 rotating ログハンドラーを設定できます。または、管理コンソールからこれらの設定を設定するには、Configuration > Subsystems > Logging > Configuration と選択し、表示 をクリックして 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 属性を使用してローテーションログの接尾辞を設定する必要があります。接尾辞は、.yyyy-MM-dd-HH のように java.text.SimpleDateFormat が理解できる形式に従う必要があります。ローテーション期間はこの接尾辞を基に自動的に算出されます。

  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 の値は引用符で囲みます。

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

      /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)

      ハンドラーのログメッセージをフィルターする式の指定コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、FILTER_EXPRESSION 変数を "not (match (\"WFLY\")) " に置き換え、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 ハンドラーを設定できます。このハンドラーは、Syslog プロトコルをサポートするリモートロギングサーバーに RFC-3164 または RFC-5424 のメッセージを送信します。または、管理コンソールから設定を行うには、Configuration > Subsystems > Logging > Configuration と選択し、表示 をクリックして 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 と選択し、表示 をクリックして Handler > Socket Handler と選択します。

注記

サーバーが admin-only モードで起動すると、ログメッセージを破棄します。

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. 以下のコマンドを使用して、ソケットバインディングとフォーマッターを指定して、Socket ログハンドラーを追加します。

    /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)

      ハンドラーのログメッセージをフィルターする式の指定コンマと引用符をエスケープし、式を引用符で囲みます。たとえば、FILTER_EXPRESSION 変数を "not (match (\"WFLY\")) " に置き換え、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. カスタムログハンドラーの設定

管理 CLI を使用すると、JBoss EAP でカスタムログハンドラーを設定できます。または、管理コンソールから設定を行うには、Configuration > Subsystems > Logging > Configuration と選択し、表示 をクリックして Handler > Custom Handler と選択します。

以下のタスクを実行して、カスタムログハンドラーを設定できます。

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

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

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

前提条件

  • JBoss EAP が実行中である。
  • 管理 CLI にアクセスできる。

手順

  1. 以下のコマンドを使用してカスタムログハンドラーを追加します。

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

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

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

  2. 必要に応じて、以下のカスタムログハンドラー属性を 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 の値は引用符で囲みます。

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

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

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

  3. 以下のコマンドを使用してカスタムログハンドラーをロガーに割り当てます。

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

    ログハンドラーを有効にするには、ハンドラーをルートロガーまたはその他のロガーに割り当てます。

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

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

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

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

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

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

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

管理 CLI を使用すると、JBoss EAP で Async ログハンドラーを設定できます。または、管理コンソールから設定する場合は、Configuration > Subsystems > Logging > Configuration と選択し、表示 をクリックして 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)

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

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

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

    ログハンドラーを有効にするには、Async ログハンドラーをルートロガーまたはその他のロガーに割り当てます。

  5. 必要に応じて、以下のコマンドで remove 操作を使用すると非同期ログハンドラーを削除できます。

    /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
トップに戻る