prometheus.exporter.statsd
The prometheus.exporter.statsd
component embeds
statsd_exporter for collecting StatsD-style metrics and exporting them as Prometheus metrics.
Usage
prometheus.exporter.statsd "LABEL" {
}
Arguments
The following arguments can be used to configure the exporter’s behavior. All arguments are optional. Omitted fields take their default values.
At least one of listen_udp
, listen_tcp
, or listen_unixgram
should be enabled.
Refer to the statsd_exporter
documentation more information about the mapping config file
.
Make sure the kernel parameter net.core.rmem_max
is set to a value greater than the value specified in read_buffer
.
Blocks
The prometheus.exporter.statsd
component doesn’t support any blocks, and is configured fully through arguments.
Exported fields
The following fields are exported and can be referenced by other components.
For example, the targets
can either be passed to a discovery.relabel
component to rewrite the targets’ label sets or to a prometheus.scrape
component that collects the exposed metrics.
The exported targets use the configured in-memory traffic address specified by the run command.
Component health
prometheus.exporter.statsd
is only reported as unhealthy if given an invalid configuration.
In those cases, exported fields retain their last healthy values.
Debug information
prometheus.exporter.statsd
doesn’t expose any component-specific debug information.
Debug metrics
prometheus.exporter.statsd
doesn’t expose any component-specific debug metrics.
Example
This example uses a prometheus.scrape
component to collect metrics from prometheus.exporter.statsd
:
Replace the following:
PROMETHEUS_REMOTE_WRITE_URL
: The URL of the Prometheus remote_write-compatible server to send metrics to.USERNAME
: The username to use for authentication to theremote_write
API.PASSWORD
: The password to use for authentication to theremote_write
API.
Compatible components
prometheus.exporter.statsd
has exports that can be consumed by the following components:
- Components that consume Targets
Note
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.