Skip to content

Commit 85a8b14

Browse files
authored
Merge pull request #2038 from fluent/lynettemiles/sc-144523/fb-fix-markdown-errors-introduced-by-pr
2 parents 7c99423 + a1af3ac commit 85a8b14

File tree

2 files changed

+20
-15
lines changed

2 files changed

+20
-15
lines changed

pipeline/inputs/prometheus-textfile.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# Prometheus Textfile
1+
# Prometheus text file
22

3-
The **prometheus_textfile** input plugin allows Fluent Bit to read metrics from Prometheus text format files (.prom files) on the local filesystem. This plugin is particularly useful for collecting custom metrics that are written to files by external applications or scripts, similar to the Prometheus Node Exporter textfile collector.
3+
The _Prometheus text file_ input plugin allows Fluent Bit to read metrics from Prometheus text format files (`.prom` files) on the local filesystem. Use this plugin to collect custom metrics that are written to files by external applications or scripts, similar to the Prometheus Node Exporter text file collector.
44

5-
## Configuration Parameters
5+
## Configuration parameters
66

77
| Key | Description | Default |
88
|-----|-------------|---------|
9-
| path | File or directory path pattern. Supports glob patterns with `*` wildcard (e.g., `/var/lib/prometheus/*.prom`) | |
10-
| scrape_interval | Interval in seconds between file scans | 10s |
9+
| `path` | File or directory path pattern. Supports glob patterns with `*` wildcard (for example, `/var/lib/prometheus/*.prom`). | _none_ |
10+
| `scrape_interval` | Interval in seconds between file scans. | `10s` |
1111

12-
## Getting Started
12+
## Get started
1313

14-
### Simple Configuration
14+
### Basic configuration
1515

1616
The following configuration will monitor `/var/lib/prometheus/textfile` directory for `.prom` files every 15 seconds:
1717

@@ -29,11 +29,11 @@ pipeline:
2929
port: 2021
3030
```
3131
32-
## Prometheus Text Format
32+
## Prometheus text format
3333
3434
The plugin expects files to be in the standard Prometheus text exposition format. Here's an example of a valid `.prom` file:
3535

36-
```
36+
```text
3737
# HELP custom_counter_total A custom counter metric
3838
# TYPE custom_counter_total counter
3939
custom_counter_total{instance="server1",job="myapp"} 42
@@ -52,9 +52,9 @@ custom_histogram_sum 125.5
5252
custom_histogram_count 50
5353
```
5454

55-
## Use Cases
55+
## Use cases
5656

57-
### Custom Application Metrics
57+
### Custom application metrics
5858

5959
Applications can write custom metrics to `.prom` files, and this plugin will collect them:
6060

@@ -66,7 +66,8 @@ echo "app_requests_total{status=\"200\"} 1500" >> /var/lib/prometheus/textfile/a
6666
echo "app_requests_total{status=\"404\"} 23" >> /var/lib/prometheus/textfile/app.prom
6767
```
6868

69-
### Batch Job Metrics
69+
### Batch job metrics
70+
7071
Cron jobs or batch processes can write completion metrics:
7172

7273
```bash
@@ -88,12 +89,14 @@ backup_last_success_timestamp_seconds ${BACKUP_END}
8889
EOF
8990
```
9091

91-
### System Integration
92+
### System integration
93+
9294
External monitoring tools can write metrics that Fluent Bit will collect and forward.
9395

94-
## Integration with Other Plugins
96+
## Integration with other plugins
97+
9598

96-
### OpenTelemetry Destination
99+
### OpenTelemetry destination
97100

98101
```yaml
99102
pipeline:

vale-styles/FluentBit/Spelling-exceptions.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Config
3434
Coralogix
3535
coroutine
3636
coroutines
37+
cron
3738
Crowdstrike
3839
CRDs
3940
DaemonSet
@@ -216,6 +217,7 @@ templated
216217
temporality
217218
Tensorflow
218219
Terraform
220+
textfile
219221
Thanos
220222
Timeshift
221223
tolerations

0 commit comments

Comments
 (0)