Statsd

Configuration Options

Required Options

address(required)

The address to connect to. The address must include a port.

TypeSyntaxDefaultExample
stringliteral["92.12.333.224:5000"]
mode(required)

The type of socket to use.

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

A list of upstream source or transform IDs. Wildcards (*) are supported.

See configuration for more info.

TypeSyntaxDefaultExample
arrayliteral["my-source-or-transform-id","prefix-*"]
encoding(required)

Configures the encoding specific sink behavior.

TypeSyntaxDefaultExample
hashliteral[]
path(required)

The unix socket path. This should be the 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","socket"]

Advanced Options

buffer(optional)

Configures the sink specific buffer behavior.

TypeSyntaxDefaultExample
hashliteral[]
healthcheck(optional)

Health check options for the sink.

TypeSyntaxDefaultExample
hash[]
send_buffer_bytes(optional)

Configures the send buffer size using the SO_SNDBUF option on the socket.

TypeSyntaxDefaultExample
uint[65536]
keepalive(optional)

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

TypeSyntaxDefaultExample
hash[]
tls(optional)

Configures the TLS options for incoming connections.

TypeSyntaxDefaultExample
hashliteral[]
default_namespace(optional)

Used as a namespace for metrics that don't have it. A namespace will be prefixed to a metric's name.

TypeSyntaxDefaultExample
stringliteral["service"]

How it Works

State

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

Health checks

Health checks ensure that the downstream service is accessible and ready to accept data. This check is performed upon sink initialization. If the health check fails an error will be logged and Vector will proceed to start.

Transport Layer Security (TLS)

Vector uses OpenSSL for TLS protocols due to OpenSSL's maturity. You can enable and adjust TLS behavior using the tls.* options.