Skip to content

Pipeline: input: prom scrape: style #1821

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: prom scrape: style #1821

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40a256d
Pipeline: input: prom scrape: style
esmerel Jul 1, 2025
761a2d3
Update pipeline/inputs/prometheus-scrape-metrics.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
32 changes: 15 additions & 17 deletions pipeline/inputs/prometheus-scrape-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
# Prometheus Scrape Metrics
# Prometheus Scrape metrics

Fluent Bit 1.9 includes additional metrics features to allow you to collect both logs and metrics with the same collector. 
Fluent Bit 1.9 and later includes additional metrics features to let you collect logs and metrics from a Prometheus-based endpoint at a set interval. These metrics can be routed to metric supported endpoints such as [Prometheus Exporter](../outputs/prometheus-exporter.md), [InfluxDB](../outputs/influxdb.md) or [Prometheus Remote Write](../outputs/prometheus-remote-write.md).

The initial release of the Prometheus Scrape metric allows you to collect metrics from a Prometheus-based endpoint at a set interval. These metrics can be routed to metric supported endpoints such as [Prometheus Exporter](../outputs/prometheus-exporter.md), [InfluxDB](../outputs/influxdb.md), or [Prometheus Remote Write](../outputs/prometheus-remote-write.md)
## Configuration

## Configuration <a href="#configuration" id="configuration"></a>

| Key | Description | Default |
| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| host | The host of the prometheus metric endpoint that you want to scrape | |
| port | The port of the prometheus metric endpoint that you want to scrape | |
| scrape\_interval | The interval to scrape metrics | 10s |
| metrics\_path | <p>The metrics URI endpoint, that must start with a forward slash.<br><br>Note: Parameters can also be added to the path by using <code>?</code></p> | /metrics |
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
| Key | Description | Default |
| --- | ----------- | -------- |
| `host` | The host of the Prometheus metric endpoint to scrape. | _none_ |
| `port` | The port of the Prometheus metric endpoint to scrape. | _none_ |
| `scrape_interval` | The interval to scrape metrics. | `10s` |
| `metrics_path` | The metrics URI endpoint, which must start with a forward slash (`/`). Parameters can be added to the path by using `?` | `/metrics` |
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |

## Example

If an endpoint exposes Prometheus Metrics we can specify the configuration to scrape and then output the metrics. In the following example, we retrieve metrics from the HashiCorp Vault application.
If an endpoint exposes Prometheus Metrics you can specify the configuration to scrape and then output the metrics. The following example retrieves metrics from the HashiCorp Vault application.

{% tabs %}
{% tab title="fluent-bit.yaml" %}
Expand All @@ -30,7 +28,7 @@ pipeline:
tag: vault
metrics_path: /v1/sys/metrics?format=prometheus
scrape_interval: 10s

outputs:
- name: stdout
match: '*'
Expand All @@ -57,9 +55,9 @@ pipeline:
{% endtab %}
{% endtabs %}

**Example Output**
This returns output similar to:

```
```text
2022-03-26T23:01:29.836663788Z go_memstats_alloc_bytes_total = 31891336
2022-03-26T23:01:29.836663788Z go_memstats_frees_total = 313264
2022-03-26T23:01:29.836663788Z go_memstats_lookups_total = 0
Expand Down Expand Up @@ -102,4 +100,4 @@ pipeline:
2022-03-26T23:01:29.836663788Z vault_runtime_sys_bytes = 24724488
2022-03-26T23:01:29.836663788Z vault_runtime_total_gc_pause_ns = 1917611
2022-03-26T23:01:29.836663788Z vault_runtime_total_gc_runs = 19
```
```