|
2 | 2 | description: An output plugin to expose Prometheus Metrics
|
3 | 3 | ---
|
4 | 4 |
|
5 |
| -# Prometheus Exporter |
| 5 | +# Prometheus exporter |
6 | 6 |
|
7 |
| -The prometheus exporter allows you to take metrics from Fluent Bit and expose them such that a Prometheus instance can scrape them. |
| 7 | +The _Prometheus_ exporter lets you take metrics from Fluent Bit and expose them so a Prometheus instance can scrape them. |
8 | 8 |
|
9 |
| -Important Note: The prometheus exporter only works with metric plugins, such as Node Exporter Metrics |
| 9 | +The Prometheus exporter only works with metric plugins such as Node Exporter Metrics. |
10 | 10 |
|
11 |
| -| Key | Description | Default | |
12 |
| -|:-----------|:-----------------------------------------------------------------------------------------------------------------------------------|:--------| |
13 |
| -| 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 | |
14 |
| -| port | This is the port Fluent Bit will bind to when hosting prometheus metrics | 2021 | |
15 |
| -| add\_label | This allows you to add custom labels to all metrics exposed through the prometheus exporter. You may have multiple of these fields | | |
16 |
| -| workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `1` | |
17 | 11 |
|
18 |
| -## Getting Started |
| 12 | +## Configuration parameters |
19 | 13 |
|
20 |
| -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"` |
| 14 | +This plugin supports the following parameters: |
| 15 | + |
| 16 | +| Key | Description | Default | |
| 17 | +|:----|:------------|:--------| |
| 18 | +| `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` | |
| 19 | +| `port` | This is the port Fluent Bit will bind to when hosting Prometheus metrics. | `2021` | |
| 20 | +| `add_label` | This lets you add custom labels to all metrics exposed through the Prometheus exporter. You can have multiple of these fields. | _none_ | |
| 21 | +| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `1` | |
| 22 | + |
| 23 | +## Get started |
| 24 | + |
| 25 | +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"` |
21 | 26 |
|
22 | 27 | {% tabs %}
|
23 | 28 | {% tab title="fluent-bit.yaml" %}
|
@@ -86,4 +91,4 @@ pipeline:
|
86 | 91 | ```
|
87 | 92 |
|
88 | 93 | {% endtab %}
|
89 |
| -{% endtabs %} |
| 94 | +{% endtabs %} |
0 commit comments