StatsD

Configuration Options

Required Options

address(required)

The address to listen for connections on, or systemd#N to use the Nth socket passed by systemd socket activation. If an address is used it must include a port.

TypeSyntaxDefaultExample
stringliteral["0.0.0.0:8125","systemd","systemd#3"]
mode(required)

The type of socket to use.

TypeSyntaxDefaultExample
stringliteral["tcp","udp","unix"]
path(required)

The unix socket path. This should be an absolute path.

TypeSyntaxDefaultExample
stringliteral["/path/to/socket"]
type(required)

The component type. This is a required field for all components and tells Vector which component to use.

TypeSyntaxDefaultExample
stringliteral["statsd"]

Advanced Options

receive_buffer_bytes(optional)

Configures the receive buffer size using the SO_RCVBUF option on the socket.

TypeSyntaxDefaultExample
uint[65536]
keepalive(optional)

Configures the TCP keepalive behavior for the connection to the source.

TypeSyntaxDefaultExample
hash[]
shutdown_timeout_secs(optional)

The timeout before a connection is forcefully closed during shutdown.

TypeSyntaxDefaultExample
uint30

How it Works

Timestamps

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

State

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

Context

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