Skip to content

Updated prom textfile input plugin docs with configuration options table available for v4.1. Fixes #2081. #2119

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 12 commits into from
Oct 29, 2025
Merged

Updated prom textfile input plugin docs with configuration options table available for v4.1. Fixes #2081. #2119

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
5f4a90c
Removing a readme file this is not standardized in classic-mode direc…
eschabell Oct 22, 2025
ca437dc
Updated to not use readme file in classic-config directory, but the c…
eschabell Oct 22, 2025
5bbc956
Updated to better sort some sections and update for missing entries. …
eschabell Oct 22, 2025
b630391
Merge branch 'fluent:master' into master
eschabell Oct 23, 2025
e4ea1cc
Updated configuration variables for opentelemetry output plugin, many…
eschabell Oct 23, 2025
f8ff78d
Updated configuration variables for opentelemetry output plugin, many…
eschabell Oct 23, 2025
8b007c0
Fixes reqeusted by reviewers for options table for opentelemetry outp…
eschabell Oct 24, 2025
8f2b2a1
Merge branch 'fluent:master' into master
eschabell Oct 27, 2025
81143f7
Merge branch 'fluent:master' into master
eschabell Oct 27, 2025
f93136a
Merge branch 'fluent:master' into master
eschabell Oct 28, 2025
49a8c3a
Updated prom texfile input plugin docs with configuration options tab…
eschabell Oct 28, 2025
804b5c9
Update pipeline/inputs/prometheus-textfile.md
eschabell Oct 29, 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
19 changes: 15 additions & 4 deletions pipeline/inputs/prometheus-textfile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,21 @@

## Configuration parameters

| Key | Description | Default |
|-----|-------------|---------|
| `path` | File or directory path pattern. Supports glob patterns with `*` wildcard (for example, `/var/lib/prometheus/*.prom`). | _none_ |
| `scrape_interval` | Interval in seconds between file scans. | `10s` |
| Key | Description | Default |
|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| `alias` | Sets an alias, useful for multiple instances of the same input plugin. If no alias is specified, a default name will be assigned using the plugin name followed by a dot and a sequence number (`cpu.0`, `cpu.1`). | _none_ |

Check warning on line 9 in pipeline/inputs/prometheus-textfile.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[FluentBit.Simplicity] Avoid words like "useful" that imply ease of use, because the user may find this action difficult.

Raw Output:
{"message": "[FluentBit.Simplicity] Avoid words like \"useful\" that imply ease of use, because the user may find this action difficult.", "location": {"path": "pipeline/inputs/prometheus-textfile.md", "range": {"start": {"line": 9, "column": 56}}}, "severity": "WARNING"}
| `log_level` | Specifies the log level for output plugin. If not set here, plugin uses global log level in `service` section. | `info` |
| `log_supress_interval` | Suppresses log messages from output plugin that appear similar within a specified time interval. `0` no suppression. | `0` |
| `mem_buf_limit` | Set a memory buffer limit for the input plugin. If the limit is reached, the plugin will pause until the buffer is drained. The value is in bytes. If set to 0, the buffer limit is disabled. | `0` |
| `path` | File or directory path pattern. Supports glob patterns with `*` wildcard (for example, `/var/lib/prometheus/*.prom`). | _none_ |
| `routable` | If set to `true`, the data generated by the plugin will be routable, meaning that it can be forwarded to other plugins or outputs. If set to `false`, the data will be discarded. | `true` |
| `scrape_interval` | Interval in seconds between file scans. | `10s` |
| `storage.pause_on_chunks_overlimit` | Enable pausing on an input when they reach their chunks limit. | _none_ |
| `storage.type` | Sets the storage type for this input, one of: `filesystem`, `memory` or `memrb`. | `memory` |
| `tag` | Set a tag for the events generated by this input plugin. | _none_ |
| `threaded` | Enable threading on an input. | `false` |
| `thread.ring_buffer.capacity` | Set custom ring buffer capacity when the input runs in threaded mode. | `1024` |
| `thread.ring_buffer.window` | Set custom ring buffer window percentage for threaded inputs. | `5` |

## Get started

Expand Down