Skip to content

Pipeline: input: statsd: style #1825

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 1, 2025
Merged

Pipeline: input: statsd: style #1825

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99b143d
Pipeline: input: statsd: style
esmerel Jul 1, 2025
a5289d7
Update pipeline/inputs/statsd.md
esmerel Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 50 additions & 45 deletions pipeline/inputs/statsd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,48 @@
# StatsD

The **statsd** input plugin allows you to receive metrics via StatsD protocol.
The _StatsD_ input plugin lets you receive metrics using the StatsD protocol.

Content:

* [Configuration Parameters](statsd.md#config)
* [Configuration Examples](statsd.md#config_example)

## Configuration Parameters <a id="config"></a>
## Configuration parameters

The plugin supports the following configuration parameters:

| Key | Description | Default |
| :--- | :--- | :--- |
| Listen | Listener network interface. | 0.0.0.0 |
| Port | UDP port where listening for connections | 8125 |
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
| Metrics | Ingested record will be marked as a metric record rather than a log record. | `off` |

Note: When enabling `Metrics On`, we will also handle metrics from the DogStatsD protocol and the internal record in Fluent Bit will be handled as a metric type for downstream processing.
[The full format of DogStatsD of metrics](https://docs.datadoghq.com/developers/dogstatsd/datagram_shell/?tab=metrics#the-dogstatsd-protocol) is not supported.
Including key-value format of tags as below is supported:
| `Listen` | Listener network interface. | `0.0.0.0` |
| `Port` | UDP port that listens for connections. | `8125` |
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
| `Metrics` | Ingested record will be marked as a metric record rather than a log record. | `off` |

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](https://docs.datadoghq.com/developers/dogstatsd/datagram_shell/?tab=metrics#the-dogstatsd-protocol) isn't supported.

Including key-value format of tags is supported:
`<METRIC_NAME>:<VALUE>|<TYPE>|@<SAMPLE_RATE>|#<TAG_KEY_1>:<TAG_VALUE_1>`
[Events](https://docs.datadoghq.com/developers/dogstatsd/datagram_shell/?tab=events#the-dogstatsd-protocol) and [ServiceChecks](https://docs.datadoghq.com/developers/dogstatsd/datagram_shell/?tab=servicechecks#the-dogstatsd-protocol) formats are not supported yet with `Metrics On`.

## Configuration Examples <a id="config_example"></a>
[Events](https://docs.datadoghq.com/developers/dogstatsd/datagram_shell/?tab=events#the-dogstatsd-protocol) and [ServiceChecks](https://docs.datadoghq.com/developers/dogstatsd/datagram_shell/?tab=servicechecks#the-dogstatsd-protocol) formats aren't supported with `Metrics On`.

## Configuration example

Here is a configuration example.

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

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

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

```python
[INPUT]
Name statsd
Expand All @@ -40,19 +53,7 @@ Here is a configuration example.
Name stdout
Match *
```
{% endtab %}

{% tab title="fluent-bit.yaml" %}
```yaml
pipeline:
inputs:
- name: statsd
listen: 0.0.0.0
port: 8125
outputs:
- name: stdout
match: '*'
```
{% endtab %}
{% endtabs %}

Expand All @@ -70,26 +71,14 @@ Fluent Bit will produce the following records:
[0] statsd.0: [1574905141.863344517, {"type"=>"gauge", "bucket"=>"active", "value"=>99.000000, "incremental"=>0}]
```

## Metrics Setup
## Metrics setup

Here is a configuration example for metrics setup.

{% tabs %}
{% tab title="fluent-bit.conf" %}
```python
[INPUT]
Name statsd
Listen 0.0.0.0
Port 8125
Metrics On

[OUTPUT]
Name stdout
Match *
```
{% endtab %}

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

```yaml
pipeline:
inputs:
Expand All @@ -101,6 +90,22 @@ pipeline:
- name: stdout
match: '*'
```

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

```python
[INPUT]
Name statsd
Listen 0.0.0.0
Port 8125
Metrics On

[OUTPUT]
Name stdout
Match *
```

{% endtab %}
{% endtabs %}

Expand All @@ -112,9 +117,9 @@ 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 procude the following metrics events:
Fluent Bit will produce the following metrics events:

```
```text
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
Expand Down