Skip to main content

OpenAgent Configuration Options

This is the list of options recognized by OpenAgent in whatap.conf. Each option is organized in the order of default value, type, and behavior description. Option values are automatically reloaded within 5 seconds after modifying the file, so agent restarts are not required in most cases.

This document categorizes options into the following two categories.

  • Common features: Options commonly used in all OpenAgent environments
  • OpenMetrics product-only options: Options used only when operating an OpenMetrics project as a standalone product

Common features​

debug​

  • Default: false
  • Type: boolean
  • Description: Enables global debug mode. Applied only when log_level is not set, promoting the log level to DEBUG. Ignored if log_level is specified.
whatap.conf
debug=true

debug_tcpsend_enabled​

  • Default: false
  • Type: boolean
  • Description: Debugs TCP packs transmitted to the Proxy server. For actual logs to be output, the logger must be at DEBUG level (debug=true or log_level=DEBUG).
whatap.conf
debug_tcpsend_enabled=true
log_level=DEBUG

debug_tcpsend_packs​

  • Default: CounterPack1
  • Type: string (comma-separated array)
  • Description: Sets the name of Packs to be transmitted to the Proxy server when debug_tcpsend_enabled=true. Both debug_tcpsend_enabled=true and logger DEBUG level (debug=true or log_level=DEBUG) are required for the value to take effect.
whatap.conf
debug_tcpsend_enabled=true
debug_tcpsend_packs=CounterPack1,ParamPack
log_level=DEBUG

log_level​

  • Default: INFO
  • Type: string
  • Description: Sets the log output level. Allowed values are DEBUG, INFO, WARN, and ERROR, case-insensitive. Numeric values (0 ~ 3) can also be specified.
whatap.conf
log_level=INFO

log_keep_days​

  • Default: 7
  • Type: number
  • Description: Sets the retention period (in days) for OpenAgent log files. Log files older than the specified period are automatically deleted.
whatap.conf
log_keep_days=14

scrape_interval​

  • Default: 60s
  • Type: string
  • Description: Sets the global default scraping interval. This is a backward-compatible key separate from globalInterval in scrape_config.yaml.
whatap.conf
scrape_interval=30s

scrape_timeout​

  • Default: None
  • Type: string
  • Description: Sets the global default scraping timeout.
whatap.conf
scrape_timeout=10s

OpenMetrics product-only options​

The following options are used only when the OpenMetrics project is operated as a standalone product without integration with other WhaTap products. They do not need to be configured in the default setup.

whatap.oname​

  • Default: None (auto-generated with {type}-{ip2}-{ip3}-{process} pattern when not set)
  • Type: string
  • Description: Sets the agent object name (oname). The alias whatap.name is also supported; if both keys are specified simultaneously, whatap.oname takes priority.
whatap.conf
whatap.oname=openmetrics-agent-01

whatap.okind​

  • Default: None
  • Type: string
  • Description: Sets the okind (object classification) of the agent. When applying default options, agents are grouped based on the okind value.
whatap.conf
whatap.okind=openmetrics-prod

whatap.onode​

  • Default: None
  • Type: string
  • Description: Sets the onode (object node) of the agent. Used when managing agents grouped by node unit.
whatap.conf
whatap.onode=node-seoul-01

tag_counter_enabled​

  • Default: false
  • Type: boolean
  • Description: When using OpenMetrics as a product, sends TagCount metric information to the WhaTap collection server.
whatap.conf
tag_counter_enabled=true
Last updated on