本文へスキップ

OpenAgent 設定オプション

OpenAgentがwhatap.confで認識するオプション一覧です。各オプションはデフォルト値、タイプ、動作説明の順に整理されています。オプション値はファイルを修正してから5秒以内に自動的にリロードされるため、ほとんどの場合エージェントの再起動は不要です。

本ドキュメントは以下の2つのカテゴリでオプションを分けて説明します。

  • 共通機能: すべてのOpenAgent使用環境で共通して使用されるオプション
  • OpenMetrics製品専用オプション: OpenMetricsプロジェクトを別途製品として運用する場合にのみ使用するオプション

共通機能​

debug​

  • デフォルト値: false
  • タイプ: boolean
  • 説明: グローバルデバッグモードを有効化します。log_levelが未設定の場合のみ適用され、ログレベルをDEBUGに昇格します。log_levelが指定されている場合は無視されます。
whatap.conf
debug=true

debug_tcpsend_enabled​

  • デフォルト値: false
  • タイプ: boolean
  • 説明: Proxyサーバーに送信されるTCPパックをデバッグします。実際のログが出力されるにはロガーがDEBUGレベルである必要があります（debug=trueまたはlog_level=DEBUG）。
whatap.conf
debug_tcpsend_enabled=true
log_level=DEBUG

debug_tcpsend_packs​

  • デフォルト値: CounterPack1
  • タイプ: string (カンマ区切り配列)
  • 説明: debug_tcpsend_enabled=trueの場合にProxyサーバーに送信されるPackの名前を設定します。値が反映されるにはdebug_tcpsend_enabled=trueとロガーDEBUGレベル（debug=trueまたはlog_level=DEBUG）の両方が必要です。
whatap.conf
debug_tcpsend_enabled=true
debug_tcpsend_packs=CounterPack1,ParamPack
log_level=DEBUG

log_level​

  • デフォルト値: INFO
  • タイプ: string
  • 説明: ログ出力レベルを設定します。許可される値はDEBUG、INFO、WARN、ERRORで、大文字小文字を区別しません。数値（0〜3）でも指定できます。
whatap.conf
log_level=INFO

log_keep_days​

  • デフォルト値: 7
  • タイプ: number
  • 説明: OpenAgentログファイルの保存期間（日単位）を設定します。指定した期間が過ぎたログファイルは自動的に削除されます。
whatap.conf
log_keep_days=14

scrape_interval​

  • デフォルト値: 60s
  • タイプ: string
  • 説明: スクレイピングのグローバルデフォルト周期を設定します。scrape_config.yamlのglobalIntervalとは別の下位互換キーです。
whatap.conf
scrape_interval=30s

scrape_timeout​

  • デフォルト値: なし
  • タイプ: string
  • 説明: スクレイピングのグローバルデフォルトタイムアウトを設定します。
whatap.conf
scrape_timeout=10s

OpenMetrics製品専用オプション​

以下のオプションはOpenMetricsプロジェクトが他のWhaTap製品と連携せず、別途製品として運用される場合にのみ使用します。デフォルト構成では設定する必要はありません。

whatap.oname​

  • デフォルト値: なし（未設定時は{type}-{ip2}-{ip3}-{process}パターンで自動生成）
  • タイプ: string
  • 説明: エージェントオブジェクト名（oname）を設定します。エイリアスwhatap.nameもサポートしており、両方のキーを同時に指定した場合はwhatap.onameが優先適用されます。
whatap.conf
whatap.oname=openmetrics-agent-01

whatap.okind​

  • デフォルト値: なし
  • タイプ: string
  • 説明: エージェントのokind（オブジェクト分類）を設定します。デフォルトオプション適用時にokind値を基準にグループ化されます。
whatap.conf
whatap.okind=openmetrics-prod

whatap.onode​

  • デフォルト値: なし
  • タイプ: string
  • 説明: エージェントのonode（オブジェクトノード）を設定します。ノード単位でエージェントをまとめて管理する際に使用します。
whatap.conf
whatap.onode=node-seoul-01

tag_counter_enabled​

  • デフォルト値: false
  • タイプ: boolean
  • 説明: OpenMetricsを製品として使用する場合、TagCountメトリクス情報をWhaTap収集サーバーに送信します。
whatap.conf
tag_counter_enabled=true
最終修正：