Skip to content

statsd.md

Latest commit

 

History

History
138 lines (100 loc) · 3.72 KB

statsd.md

File metadata and controls

138 lines (100 loc) · 3.72 KB

StatsD

{% hint style="info" %} Supported event types: logs metrics {% endhint %}

The StatsD input plugin lets you receive metrics using the StatsD protocol.

Configuration parameters

The plugin supports the following configuration parameters:

Key Description Default
listen Specify the network interface to bind. 0.0.0.0
metrics Ingest as metric events rather than log events. off
port Specify the UDP port to listen for incoming connections. 8125
threaded Indicates whether to run this input in its own thread. false

When enabling Metrics On, Fluent Bit will also handle metrics from the DogStatsD protocol. The internal record in Fluent Bit will be handled as a metric type for downstream processing.

The full format of DogStatsD of metrics isn't supported.

Including key-value format of tags is supported: <METRIC_NAME>:<VALUE>|<TYPE>|@<SAMPLE_RATE>|#<TAG_KEY_1>:<TAG_VALUE_1>

Events and ServiceChecks formats aren't supported with Metrics On.

Configuration example

Here is a configuration example.

{% tabs %} {% tab title="fluent-bit.yaml" %}

pipeline:
  inputs:
    - name: statsd
      listen: 0.0.0.0
      port: 8125
      
  outputs:
    - name: stdout
      match: '*'

{% endtab %} {% tab title="fluent-bit.conf" %}

[INPUT]
  Name   statsd
  Listen 0.0.0.0
  Port   8125

[OUTPUT]
  Name   stdout
  Match  *

{% endtab %} {% endtabs %}

Now you can input metrics through the UDP port as follows:

echo "click:10|c|@0.1" | nc -q0 -u 127.0.0.1 8125

echo "active:99|g"     | nc -q0 -u 127.0.0.1 8125

Fluent Bit will produce the following records:

...
[0] statsd.0: [1574905088.971380537, {"type"=>"counter", "bucket"=>"click", "value"=>10.000000, "sample_rate"=>0.100000}]
[0] statsd.0: [1574905141.863344517, {"type"=>"gauge", "bucket"=>"active", "value"=>99.000000, "incremental"=>0}]
...

Metrics setup

Here is a configuration example for metrics setup.

{% tabs %} {% tab title="fluent-bit.yaml" %}

pipeline:
  inputs:
    - name: statsd
      listen: 0.0.0.0
      port: 8125
      metrics: on
      
  outputs:
    - name: stdout
      match: '*'

{% endtab %} {% tab title="fluent-bit.conf" %}

[INPUT]
  Name   statsd
  Listen 0.0.0.0
  Port   8125
  Metrics on

[OUTPUT]
  Name   stdout
  Match  *

{% endtab %} {% endtabs %}

Now you can input metrics as metrics type of events through the UDP port as follows:

echo "click:+10|c|@0.01|#hello:tag"              | nc -q0 -u 127.0.0.1 8125

echo "active:+99|g|@0.01"                        | nc -q0 -u 127.0.0.1 8125

echo "inactive:29|g|@0.0125|#hi:from_fluent-bit" | nc -q0 -u 127.0.0.1 8125

Fluent Bit will produce the following metrics events:

...
2025-01-09T11:40:26.562424694Z click{incremental="true",hello="tag"} = 1000
2025-01-09T11:40:28.591477424Z active{incremental="true"} = 9900
2025-01-09T11:40:31.593118033Z inactive{hi="from_fluent-bit"} = 2320
...