StatsD

Collect metrics emitted via StatsD protocol

status: stable role: aggregator delivery: best effort acknowledgements: no egress: stream state: stateless output: metrics
Page source Edit this page

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",
      "permit_origin": [
        "192.168.0.0/16"
      ],
      "sanitize": true,
      "shutdown_timeout_secs": 30
    }
  }
}
[sources.my_source_id]
type = "statsd"
address = "0.0.0.0:9000"
mode = "tcp"
path = "/path/to/socket"
permit_origin = [ "192.168.0.0/16" ]
sanitize = true
shutdown_timeout_secs = 30

sources:
  my_source_id:
    type: statsd
    address: 0.0.0.0:9000
    mode: tcp
    path: /path/to/socket
    permit_origin:
      - 192.168.0.0/16
    sanitize: true
    shutdown_timeout_secs: 30

address

required string literal

The 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.

Examples 
"0.0.0.0:9000"
"systemd"
"systemd#3"
Relevant when: mode = "tcp" or mode = "udp"

connection_limit

optional uint
The maximum number of TCP connections that are allowed at any given time.
Relevant when: mode = "tcp"

keepalive

optional object
TCP keepalive settings for socket-based components.

keepalive.time_secs

optional uint
The time to wait before starting to send TCP keepalive probes on an idle connection.
Relevant when: mode = "tcp"

mode

required string literal enum
The type of socket to use.
Examples 
"tcp"
"udp"
"unix"
Enum options string literal
OptionDescription
tcpListen on TCP.
udpListen on UDP.
unixListen on a Unix domain Socket (UDS).

path

required string literal

The Unix socket path.

This should be an absolute path.

Examples 
"/path/to/socket"
Relevant when: mode = "unix"

permit_origin

optional [string]
List of allowed origin IP networks. IP addresses must be in CIDR notation.
Array string literal
Examples 
[
  "192.168.0.0/16",
  "127.0.0.1/32",
  "::1/128",
  "9876:9ca3:99ab::23/128"
]
Relevant when: mode = "tcp"

receive_buffer_bytes

optional uint
The size of the receive buffer used for each connection.
Relevant when: mode = "tcp" or mode = "udp"

sanitize

optional bool

Whether or not to sanitize incoming statsd key names. When “true”, keys are sanitized by:

  • “/” is replaced with “-”
  • All whitespace is replaced with “_”
  • All non alphanumeric characters (A-Z, a-z, 0-9, _, or -) are removed.
default: true

shutdown_timeout_secs

optional uint
The timeout before a connection is forcefully closed during shutdown.
default: 30 (seconds)
Relevant when: mode = "tcp"

tls

optional object
TlsEnableableConfig for sources, 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 literal

Absolute 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.

Examples 
"/path/to/certificate_authority.crt"

tls.client_metadata_key

optional string literal
Event field for client certificate metadata.

tls.crt_file

optional string literal

Absolute 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.

Examples 
"/path/to/host_certificate.crt"

tls.enabled

optional bool

Whether 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 literal

Absolute 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.

Examples 
"/path/to/host_certificate.key"

tls.key_pass

optional string literal

Passphrase used to unlock the encrypted key file.

This has no effect unless key_file is set.

Examples 
"${KEY_PASS_ENV_VAR}"
"PassWord1"

tls.server_name

optional string literal

Server name to use when using Server Name Indication (SNI).

Only relevant for outgoing connections.

Examples 
"www.example.com"

tls.verify_certificate

optional bool

Enables certificate verification. For components that create a server, this requires that the client connections have a valid client certificate. For components that initiate requests, this validates that the upstream has a valid certificate.

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.

Do NOT set this to false unless you understand the risks of not verifying the validity of certificates.

tls.verify_hostname

optional bool

Enables 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.

Relevant when: mode = "tcp"

Outputs

<component_id>

Default output stream of the component. Use this component’s ID as an input to downstream transforms and sinks.

Output Data

Metrics

counter

counter
A single value that can be incremented or reset to a zero value but not decremented.
* optional
Any tags present on the metric.

distribution

distribution
A distribution represents a distribution of sampled values. It is used with services that support global histograms and summaries.
* optional
Any tags present on the metric.

gauge

gauge
A gauge represents a point-in-time value that can increase and decrease. Vector’s internal gauge type represents changes to that value. Gauges should be used to track fluctuations in values, like current memory or CPU usage.
* optional
Any tags present on the metric.

set

gauge
A set represents an array of unique values.
* optional
Any tags present on the metric.

Telemetry

Metrics

link

component_discarded_events_total

counter
The number of events dropped by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
intentional
True if the events were discarded intentionally, like a filter transform, or false if due to an error.
pid optional
The process ID of the Vector instance.

component_errors_total

counter
The total number of errors encountered by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
error_type
The type of the error
host optional
The hostname of the system Vector is running on.
pid optional
The process ID of the Vector instance.
stage
The stage within the component at which the error occurred.

component_received_bytes

histogram
The size in bytes of each event received by the source.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_received_bytes_total

counter
The number of raw bytes accepted by this component from source origins.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_received_event_bytes_total

counter
The number of event bytes accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_received_events_count

histogram

A histogram of the number of events passed in each internal batch in Vector’s internal topology.

Note that this is separate than sink-level batching. It is mostly useful for low level debugging performance issues in Vector due to small internal batches.

component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_received_events_total

counter
The number of events accepted by this component either from tagged origins like file and uri, or cumulatively from other origins.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
container_name optional
The name of the container from which the data originated.
file optional
The file from which the data originated.
host optional
The hostname of the system Vector is running on.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the data originated.
peer_path optional
The pathname from which the data originated.
pid optional
The process ID of the Vector instance.
pod_name optional
The name of the pod from which the data originated.
uri optional
The sanitized URI from which the data originated.

component_sent_event_bytes_total

counter
The total number of event bytes emitted by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
output optional
The specific output of the component.
pid optional
The process ID of the Vector instance.

component_sent_events_total

counter
The total number of events emitted by this component.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
output optional
The specific output of the component.
pid optional
The process ID of the Vector instance.

source_lag_time_seconds

histogram
The difference between the timestamp recorded in each event and the time when it was ingested, expressed as fractional seconds.
component_id
The Vector component ID.
component_kind
The Vector component kind.
component_type
The Vector component type.
host optional
The hostname of the system Vector is running on.
pid optional
The process ID of the Vector instance.

How it works

Context

By default, the statsd source augments events with helpful context keys.

State

This component is stateless, meaning its behavior is consistent across each input.

Timestamps

The StatsD protocol doesn’t provide support for sending metric timestamps. You may notice that each parsed metric is assigned a 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.

StatsD timings

Incoming timings are emitted as distributions. Timings in milliseconds (ms) are converted to seconds (s).

Transport Layer Security (TLS)

Vector uses OpenSSL for TLS protocols due to OpenSSL’s maturity. You can enable and adjust TLS behavior via the tls.* options and/or via an OpenSSL configuration file. The file location defaults to /usr/local/ssl/openssl.cnf or can be specified with the OPENSSL_CONF environment variable.
Sidebar