Statsd Exporter

The statsd_exporter_config block configures the statsd_exporter integration, which is an embedded version of statsd_exporter. This allows for the collection of statsd metrics and exposing them as Prometheus metrics.

Full reference of options:

  1.   # Enables the statsd_exporter integration, allowing the Agent to automatically
  2.   # collect system metrics from the configured statsd server address
  3.   [enabled: <boolean> | default = false]
  5.   # Sets an explicit value for the instance label when the integration is
  6.   # self-scraped. Overrides inferred values.
  7.   #
  8.   # The default value for this integration is inferred from the agent hostname
  9.   # and HTTP listen port, delimited by a colon.
  10.   [instance: <string>]
  12.   # Automatically collect metrics from this integration. If disabled,
  13.   # the statsd_exporter integration will be run but not scraped and thus not
  14.   # remote-written. Metrics for the integration will be exposed at
  15.   # /integrations/statsd_exporter/metrics and can be scraped by an external
  16.   # process.
  17.   [scrape_integration: <boolean> | default = <integrations_config.scrape_integrations>]
  19.   # How often should the metrics be collected? Defaults to
  20.   # prometheus.global.scrape_interval.
  21.   [scrape_interval: <duration> | default = <global_config.scrape_interval>]
  23.   # The timeout before considering the scrape a failure. Defaults to
  24.   # prometheus.global.scrape_timeout.
  25.   [scrape_timeout: <duration> | default = <global_config.scrape_timeout>]
  27.   # Allows for relabeling labels on the target.
  28.   relabel_configs:
  29.     [- <relabel_config> ... ]
  31.   # Relabel metrics coming from the integration, allowing to drop series
  32.   # from the integration that you don't care about.
  33.   metric_relabel_configs:
  34.     [ - <relabel_config> ... ]
  36.   # How frequent to truncate the WAL for this integration.
  37.   [wal_truncate_frequency: <duration> | default = "60m"]
  39.   # Monitor the exporter itself and include those metrics in the results.
  40.   [include_exporter_metrics: <bool> | default = false]
  42.   #
  43.   # Exporter-specific configuration options
  44.   #
  46.   # The UDP address on which to receive statsd metric lines. An empty string
  47.   # will disable UDP collection.
  48.   [listen_udp: <string> | default = ":9125"]
  50.   # The TCP address on which to receive statsd metric lines. An empty string
  51.   # will disable TCP collection.
  52.   [listen_tcp: <string> | default = ":9125"]
  54.   # The Unixgram socket path to receive statsd metric lines. An empty string
  55.   # will disable unixgram collection.
  56.   [listen_unixgram: <string> | default = ""]
  58.   # The permission mode of the unixgram socket, when enabled.
  59.   [unix_socket_mode: <string> | default = "755"]
  61.   # An optional mapping config that can translate dot-separated StatsD metrics
  62.   # into labeled Prometheus metrics. For full instructions on how to write this
  63.   # object, see the official documentation from the statsd_exporter:
  64.   #
  65.   # https://github.com/prometheus/statsd_exporter#metric-mapping-and-configuration
  66.   #
  67.   # Note that a SIGHUP will not reload this config.
  68.   [mapping_config: <statsd_exporter.mapping_config>]
  70.   # Size (in bytes) of the operating system's transmit read buffer associated
  71.   # with the UDP or unixgram connection. Please make sure the kernel parameters
  72.   # net.core.rmem_max is set to a value greater than the value specified.
  73.   [read_buffer: <int> | default = 0]
  75.   # Maximum size of your metric mapping cache. Relies on least recently used
  76.   # replacement policy if max size is reached.
  77.   [cache_size: <int> | default = 1000]
  79.   # Metric mapping cache type. Valid values are "lru" and "random".
  80.   [cache_type: <string> | default = "lru"]
  82.   # Size of internal queue for processing events.
  83.   [event_queue_size: <int> | default = 10000]
  85.   # Number of events to hold in queue before flushing.
  86.   [event_flush_threshold: <int> | default = 1000]
  88.   # Number of events to hold in queue before flushing.
  89.   [event_flush_interval: <duration> | default = "200ms"]
  91.   # Parse DogStatsd style tags.
  92.   [parse_dogstatsd_tags: <bool> | default = true]
  94.   # Parse InfluxDB style tags.
  95.   [parse_influxdb_tags: <bool> | default = true]
  97.   # Parse Librato style tags.
  98.   [parse_librato_tags: <bool> | default = true]
  100.   # Parse SignalFX style tags.
  101.   [parse_signalfx_tags: <bool> | default = true]