Skip to content

Pipeline: output: prom exporter: style #1964

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 22, 2025
Merged

Pipeline: output: prom exporter: style #1964

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34c4c7d
Pipeline: output: prom exporter: style
esmerel Jul 21, 2025
3b2f5d0
Apply suggestions from code review
esmerel Jul 22, 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
29 changes: 17 additions & 12 deletions pipeline/outputs/prometheus-exporter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,27 @@
description: An output plugin to expose Prometheus Metrics
---

# Prometheus Exporter
# Prometheus exporter

The prometheus exporter allows you to take metrics from Fluent Bit and expose them such that a Prometheus instance can scrape them.
The _Prometheus_ exporter lets you take metrics from Fluent Bit and expose them so a Prometheus instance can scrape them.

Important Note: The prometheus exporter only works with metric plugins, such as Node Exporter Metrics
The Prometheus exporter only works with metric plugins such as Node Exporter Metrics.

| Key | Description | Default |
|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------|:--------|
| host | This is address Fluent Bit will bind to when hosting prometheus metrics. Note: `listen` parameter is deprecated from v1.9.0. | 0.0.0.0 |
| port | This is the port Fluent Bit will bind to when hosting prometheus metrics | 2021 |
| add\_label | This allows you to add custom labels to all metrics exposed through the prometheus exporter. You may have multiple of these fields | |
| workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `1` |

## Getting Started
## Configuration parameters

The Prometheus exporter only works with metrics captured from metric plugins. In the following example, host metrics are captured by the node exporter metrics plugin and then are routed to prometheus exporter. Within the output plugin two labels are added `app="fluent-bit"`and `color="blue"`
This plugin supports the following parameters:

| Key | Description | Default |
|:----|:------------|:--------|
| `host` | This is address Fluent Bit will bind to when hosting Prometheus metrics. The `listen` parameter is deprecated in 1.9.0 and later. | `0.0.0.0` |
| `port` | This is the port Fluent Bit will bind to when hosting Prometheus metrics. | `2021` |
| `add_label` | This lets you add custom labels to all metrics exposed through the Prometheus exporter. You can have multiple of these fields. | _none_ |
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `1` |

## Get started

The Prometheus exporter only works with metrics captured from metric plugins. In the following example, host metrics are captured by the node exporter metrics plugin and then are routed to Prometheus exporter. In the output plugin, two labels are added `app="fluent-bit"`and `color="blue"`

{% tabs %}
{% tab title="fluent-bit.yaml" %}
Expand Down Expand Up @@ -86,4 +91,4 @@ pipeline:
```

{% endtab %}
{% endtabs %}
{% endtabs %}