agent.yml

---
platform:

  # enabled: boolean, specifies if exporting data to Metrika Platform
  # is enabled. Default: true.
  enabled: true

  # api_key: authentication key for the Metrika platform
  api_key: <api_key>

  # batch_n: integer, the maximum number of metrics/events to be emitted at
  # each publish operation to the platform.
  batch_n: 1000

  # max_publish_interval: duration, the maximum interval to wait between two
  # consecutive publish operations to the platform.
  max_publish_interval: 15s
  
  # transport_timeout: duration, configures the timeout for publish
  # operations to the platform.
  transport_timeout: 10s

  # addr: string, network address of the platform for publishing
  addr: <platform_addr>

  # uri: string, platform publishing endpoint
  uri: /

buffer:

  # max_heap_alloc: integer, the maximum bytes of allocated heap objects as reported
  # by Go's runtime memstats, that are allowed by the agent before it starts
  # dropping metrics (default: 50MB).
  max_heap_alloc: 52428800

  # min_buffer_size: integer, the number of messages accepted into the buffer
  # regardless of max_heap_alloc value. 
  min_buffer_size: 2500

  # ttl: duration, a Time-To-Live for any buffered data. Data will never expire
  # for zero TTL values and stay in the buffer until they are evicted for publishing.
  ttl: 0s

runtime:

  logging:

    # outputs: list of outputs for runtime logs.
    #
    # Possible values are one of the standard I/O streams # (i.e stdout, stderr)
    # or a full/relative path to a filename (i.e logs/agent.log).
    outputs:
      - stdout

    # level: logging level for runtime logs.
    #
    # Possible values are: info (recommended), warning, debug, error.
    level: info

  # disable_fingerprint_validation: disables fingerprint validation on startup.
  #
  # Fingerprint validation is enabled by default and the agent will exit
  # immediately if checksums of the newly retrieved hostname and the cached do
  # not match. Checksum is cached under $HOME/.cache/metrikad/fingerprint.
  disable_fingerprint_validation: false

  # http_addr: string, network address to listen for HTTP requests to.
  #  - Get Prometheus metrics about the agent's runtime (GET /metrics).
  #  - Update its logging level (PUT /loglvl).
  #
  # Default value is empty string which disables HTTP across the agent. Enabling
  # any agent local endpoints, requires setting this value (i.e. 127.0.0.1:9999)
  http_addr:

  # metrics_enabled: bool, enable prometheus /metrics endpoint. Default is false.
  metrics_enabled: false

  # host_header_validation_enabled: bool, enables host header validation against
  # values listed under runtime.allowed_hosts. When disabled, runtime.allowed_hosts
  # is ignored. Default is true.
  host_header_validation_enabled: true

  # allowed_hosts: list[string], list of allowed Host HTTP headers to check when
  # validating HTTP requests processed by the agent such as /metrics. Use
  # comma-separated format when configuring this with an environment variable.
  # Ignored when runtime.host_header_validation_enabled is false.
  allowed_hosts:
    - 127.0.0.1

  # sampling_interval: duration, default interval used by Watchers that use
  # polling for collecting metrics/events.
  sampling_interval: 15s

  # exporters: map[string]object, list of exporters to be enabled on agent startup.
  # The exporter constructor must be registered first in internal/pkg/contrib.
  exporters: {}

  # watchers: list[object], list of watchers to be enabled on agent startup.
  # The watcher constructor name must be registered first in the pkg/collector.
  watchers:
    - type: prometheus.proc.cpu
    - type: prometheus.proc.net.netstat_linux
    - type: prometheus.proc.net.arp_linux
    - type: prometheus.proc.stat_linux
    - type: prometheus.proc.conntrack_linux
    - type: prometheus.proc.diskstats
    - type: prometheus.proc.entropy
    - type: prometheus.proc.filefd
    - type: prometheus.proc.filesystem
    - type: prometheus.proc.loadavg
    - type: prometheus.proc.meminfo
    - type: prometheus.proc.netclass
    - type: prometheus.proc.netdev
    - type: prometheus.proc.sockstat
    - type: prometheus.proc.textfile
    - type: prometheus.time
    - type: prometheus.uname
    - type: prometheus.vmstat

  # ntp_server : string, address of the NTP server to use for time synchronization.
  ntp_server: pool.ntp.org

discovery:
  # deactivated: bool, deactivates node discovery completely. Default: false.
  deactivated: false

  systemd:
    # deactivated: bool, explicitly disables systemd discovery. Default is false. Note, on startup, the
    # agent will check if metrikad user is in systemd-journal group, and if not will automatically deactivate
    # systemd discovery. This is to ensure the agent ignores systemd discovery path for installations
    # run with --no-systemd-journal-grp flag.
    deactivated: false

    # glob: list[string], pattern used in systemctl list-units command. Use whitespace (" ") delimiter to
    # specify a list of patterns when configuring with an environment variable.
    # For syntax, see https://www.freedesktop.org/software/systemd/man/systemctl.html#Parameter%20Syntax.
    glob:

  docker:
    # deactivated: bool, explicitly disables docker discovery
    deactivated: false

    # regex: list[string], RE2 regular expressions to match for running containers. Use comma (",") delimiter
    # to specify a list of patterns when configuring with an environment variable.
    # For syntax, see: https://github.com/google/re2/wiki/Syntax.
    regex: