StatsD
Collect metrics emitted via StatsD protocol
Configuration
Example configurations
{
"sources": {
"my_source_id": {
"type": "statsd",
"address": "0.0.0.0:9000",
"mode": "tcp",
"path": "/path/to/socket"
}
}
}
[sources.my_source_id]
type = "statsd"
address = "0.0.0.0:9000"
mode = "tcp"
path = "/path/to/socket"
---
sources:
my_source_id:
type: statsd
address: 0.0.0.0:9000
mode: tcp
path: /path/to/socket
{
"sources": {
"my_source_id": {
"type": "statsd",
"address": "0.0.0.0:9000",
"mode": "tcp",
"path": "/path/to/socket",
"shutdown_timeout_secs": 30
}
}
}
[sources.my_source_id]
type = "statsd"
address = "0.0.0.0:9000"
mode = "tcp"
path = "/path/to/socket"
shutdown_timeout_secs = 30
---
sources:
my_source_id:
type: statsd
address: 0.0.0.0:9000
mode: tcp
path: /path/to/socket
shutdown_timeout_secs: 30
address
required string literalThe socket address to listen for connections on, or systemd{#N}
to use the Nth socket passed by
systemd socket activation.
If a socket address is used, it must include a port.
mode = "tcp" or mode = "udp"
connection_limit
optional uintmode = "tcp"
keepalive
optional objectkeepalive.time_secs
optional uintmode = "tcp"
mode
required string literal enumOption | Description |
---|---|
tcp | Listen on TCP. |
udp | Listen on UDP. |
unix | Listen on a Unix domain Socket (UDS). |
path
required string literalThe Unix socket path.
This should be an absolute path.
mode = "unix"
receive_buffer_bytes
optional uintmode = "tcp" or mode = "udp"
shutdown_timeout_secs
optional uint30
(seconds)mode = "tcp"
tls
optional objectsources
, adding metadata from the client certificate.tls.alpn_protocols
optional [string]Sets the list of supported ALPN protocols.
Declare the supported ALPN protocols, which are used during negotiation with peer. They are prioritized in the order that they are defined.
tls.ca_file
optional string literalAbsolute path to an additional CA certificate file.
The certificate must be in the DER or PEM (X.509) format. Additionally, the certificate can be provided as an inline string in PEM format.
tls.client_metadata_key
optional string literaltls.crt_file
optional string literalAbsolute path to a certificate file used to identify this server.
The certificate must be in DER, PEM (X.509), or PKCS#12 format. Additionally, the certificate can be provided as an inline string in PEM format.
If this is set, and is not a PKCS#12 archive, key_file
must also be set.
tls.enabled
optional boolWhether or not to require TLS for incoming or outgoing connections.
When enabled and used for incoming connections, an identity certificate is also required. See tls.crt_file
for
more information.
tls.key_file
optional string literalAbsolute path to a private key file used to identify this server.
The key must be in DER or PEM (PKCS#8) format. Additionally, the key can be provided as an inline string in PEM format.
tls.key_pass
optional string literalPassphrase used to unlock the encrypted key file.
This has no effect unless key_file
is set.
tls.verify_certificate
optional boolEnables certificate verification.
If enabled, certificates must not be expired and must be issued by a trusted issuer. This verification operates in a hierarchical manner, checking that the leaf certificate (the certificate presented by the client/server) is not only valid, but that the issuer of that certificate is also valid, and so on until the verification process reaches a root certificate.
Relevant for both incoming and outgoing connections.
Do NOT set this to false
unless you understand the risks of not verifying the validity of certificates.
tls.verify_hostname
optional boolEnables hostname verification.
If enabled, the hostname used to connect to the remote host must be present in the TLS certificate presented by the remote host, either as the Common Name or as an entry in the Subject Alternative Name extension.
Only relevant for outgoing connections.
Do NOT set this to false
unless you understand the risks of not verifying the remote hostname.
mode = "tcp"
Outputs
<component_id>
Output Data
Metrics
counter
counterdistribution
distributionTelemetry
Metrics
linkcomponent_discarded_events_total
countercomponent_id
instead. The value is the same as component_id
.component_errors_total
countercomponent_id
instead. The value is the same as component_id
.component_received_bytes_total
countercomponent_id
instead. The value is the same as component_id
.component_received_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.component_received_events_total
countercomponent_id
instead. The value is the same as component_id
.component_sent_event_bytes_total
countercomponent_id
instead. The value is the same as component_id
.component_sent_events_total
countercomponent_id
instead. The value is the same as component_id
.connection_errors_total
counterevents_in_total
countercomponent_received_events_total
instead.component_id
instead. The value is the same as component_id
.events_out_total
countercomponent_sent_events_total
instead.component_id
instead. The value is the same as component_id
.invalid_record_bytes_total
countercomponent_id
instead. The value is the same as component_id
.invalid_record_total
countercomponent_id
instead. The value is the same as component_id
.processed_bytes_total
countercomponent_id
instead. The value is the same as component_id
.processed_events_total
countercomponent_received_events_total
and
component_sent_events_total
metrics.component_id
instead. The value is the same as component_id
.source_lag_time_seconds
histogramcomponent_id
instead. The value is the same as component_id
.How it works
Timestamps
null
timestamp, which is a special
value indicating a realtime metric (i.e. not a historical metric). Normally, such
null
timestamps are substituted with the current time by downstream sinks or
third-party services during sending/ingestion. See the
metric data model page for more info.Transport Layer Security (TLS)
tls.*
options.