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