StatsD

<dependency>
    <groupId>io.quarkiverse.micrometer.registry</groupId>
    <artifactId>quarkus-micrometer-registry-statsd</artifactId>
</dependency>

Configuration

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

quarkus.micrometer.export.statsd.enabled

Support for export to StatsD.

Support for StatsD will be enabled if Micrometer support is enabled, the Statsd registry extension is enabled and either this value is true, or this value is unset and quarkus.micrometer.registry-enabled-default is true.

Environment variable: QUARKUS_MICROMETER_EXPORT_STATSD_ENABLED

boolean

quarkus.micrometer.export.statsd.default-registry

By default, this extension will create a StatsD MeterRegistry instance.

Use this attribute to veto the creation of the default StatsD MeterRegistry.

Environment variable: QUARKUS_MICROMETER_EXPORT_STATSD_DEFAULT_REGISTRY

boolean

true

quarkus.micrometer.export.statsd

StatsD registry configuration properties.

A property source for configuration of the StatsD MeterRegistry, see https://micrometer.io/docs/registry/statsD.

Available values:

Property=Default

Description

flavor=datadog

Specify the flavor of the StatsD line protocol. The original StatsD line protocol specification is etsy. The default value is datadog.

host=localhost

The host name of the StatsD agent.

maxPacketLength=1400

Adjust the packet length to keep the payload within your network’s MTU.

port=8125

The port of the StatsD agent`.

protocol=UDP

The protocol of the connection to the agent (UDP or TCP).

publish=true

By default, gathered metrics will be published to StatsD when the MeterRegistry is enabled. Use this attribute to selectively disable publication of metrics in some environments.

step=1m

The interval at which metrics are sent to StatsD Monitoring. The default is 1 minute.

Other Micrometer configuration attributes can also be specified.

As mentioned in the Micrometer StatsD documentation, if you want to customize the metrics sink, do so by providing your own StatsDMeterRegistry instance using a CDI @Produces method.

Environment variable: QUARKUS_MICROMETER_EXPORT_STATSD

Map<String,String>