本文へスキップ

エージェントログの設定

Javaアプリケーション環境で発生するログデータをエージェントを通じて管理する方法を案内します。ログファイルのパスと名前の設定、保存期間の設定、ログのモニタリング、ユーザー定義型のログ追跡の活性化方法などが含まれます。ログ管理のための様々な設定オプションを提供し、システムの効率的なログ管理をサポートします。

パスおよび名前設定​

エージェントログのパスと名前は、whatap.confファイルで設定できます。log_rootの既定値として_${WHATAP_HOME}/logs_パスを使用します。

whatap.conf
log_root=whatap/logs
log_name=whatap

ログ管理オプション​

whatap.confファイルにログ関連オプションを作成し、ログ内容を管理することができます。

whatap.conf
watchlog_enabled=true
log_rotation_enabled=true
log_oname_enabled=true
log_keep_days=7

  • watchlog_enabled Boolean

    既定値false

    値がtrueの場合、ログモニタリングを有効にします。

  • watchlog_check_interval Int

    既定値2000

    ログをモニタリングする間隔です。一定の間隔でログファイルに記録を追加したことを確認します。

  • watchlog_read_count Int

    既定値8

    ログを読み取る最大回数です。一度にwatchlog_buffer_sizeを読み取ります。

  • watchlog_buffer_size Int

    既定値131072(128k)

    ログを一度に読み取るログのサイズです。

  • watchlog.LOGKEY

    1つのログファイルをモニタリングするための設定です。file名を入力し、モニタリングした複数のwordをコンマ(,)で区切って設定します。check_interval間隔でログをモニタリングし、キーワードを見つけたら警告します。一度警告が出ればsilentほど警告を止めます。

    • watchlog.LOGKEY.enabled Boolean既定値true
    • watchlog.LOGKEY.file String
    • watchlog.LOGKEY.words String
    • watchlog.LOGKEY.silent Int既定値10000
    • watchlog.LOGKEY.check_interval Int既定値1000

  • log_root String

    既定値 ${WHATAP_HOME}/logs

    エージェントログのパスを設定します。

  • log_datasource_lookup_enabled Boolean

    既定値 true

    InitialContext Lookup時のDataSourceの場合、ログを記録する機能を有効にします。

  • log_rotation_enabled Boolean

    既定値 true

    エージェントログファイルを日付ごとに保存する機能を有効にします。ログファイル名は、whatap-yyyymmdd.log形式で保存します。値がfalseの場合、ログファイル名はwhatap.log形式で保存されます。

  • log_keep_days Int

    既定値7

    ログファイルの保存期間を設定します。log_rotation_enabledの値がtrueの場合にのみ動作します。

  • log_oname_enabled Boolean

    既定値false

    値がtrueの場合は、各ログごとにエージェント名を追加します。

ログシンク(LogSink)​

whatap.agent-2.1.0以降のバージョンからは、アプリケーションサーバーを統合モニタリングするログシンク(LogSink)機能を提供します。

注意

LogSinkオプションはwhatap.agent-2.1.0以降で使用できます。

ログモニタリング機能の有効化​

  • logsink_enabled Boolean

    既定値false

    ログモニタリング機能を有効にします。

  • logsink_trace_enabled Boolean

    既定値false

    LogにトランザクションIDを挿入して、トランザクショントレースのログタブの表示有無を指定します。

フレームワークログ内容の収集​

フレームワークで収集されるログをモニタリングするためには、モジュールからログをインターセプトするための設定とプラグインを追加する必要があります。フレームワークで収集されるログの基本カテゴリ名をAppLogに設定します。既定値は、hooklog_enabledオプションの設定と同じです。

  • hooklog_enabled Boolean

    既定値logsink_enabled

    ログ追跡を有効にするかどうかを設定します。

    ノート

    • Javaエージェント2.2.4バージョン以降では、アプリケーションの再起動なしでオプションの変更が適用されます。

    • Javaエージェントバージョン2.2.4未満ではhooklog_enabledの値を変更すると再起動が必要です。hooklog_enabledの既定値はlogsink_enabledです。そのためlogsink_enabled=trueに設定し、Javaアプリケーションを再起動すると、hooklog_enabledがtrueに設定されます。

  • hooklog_custom_methods String

    カスタムログを登録します。特定のログフレームワークの内容を収集します。サイトで個別に作成したログモジュールのログを追跡する際に利用してください。

    Java
    package io.home.test;

    public class MyLog {  
      public void customLog(String log) { ... }
    }
    whatap.conf
    hooklog_custom_methods=io.home.test.MyLog.customLog

特定のログAppender除外を設定する​

特定のログappenderを除外するエージェントオプションを案内します。次に提供するエージェントオプションにより、モニタリング対象から特定appenderを除外できます。

  • ignore_logback_appender_set String Java Agent v2.2.28 or later

    logback-1.2.8を追跡する際に特定appenderを除外するエージェントオプションです。例えば、CONSOLEとACCESS_APPENDERを除外するには、次の例を参照します。

    whatap.conf
    weaving=logback-1.2.8
    # example: ignore 'CONSOLE', 'ACCESS_APPENDER' appender
    ignore_logback_appender_set=CONSOLE,ACCESS_APPENDER
    ノート

    • このエージェントオプションを適用する場合、weaving=logback-1.2.8オプションを追加適用する必要があります。

    • ACCESS_APPENDERは例示として用いた値です。ユーザー環境に合わせたappender名前を指定する必要があります。

  • ignore_log4j_appender_set String Java Agent v2.2.28 or later

    log4j-2.17を追跡する際に、特定appenderを除外するエージェント オプションです。 例えば、CONSOLEとACCESS_APPENDERを除外するには、次の例を参照します。

    whatap.conf
    weaving=log4j-2.17
    # example: ignore 'CONSOLE', 'ACCESS_APPENDER' appender
    ignore_log4j_appender_set=CONSOLE,ACCESS_APPENDER
    ノート

    • このエージェントオプションを適用する場合、weaving=log4j-2.17オプションを追加適用する必要があります。

    • ACCESS_APPENDERは例示として用いた値です。ユーザー環境に合わせたappender名前を指定する必要があります。