Skip to content

Commit 13f1738

Browse files
eschabellesmerel
andauthored
Updated prom textfile input plugin docs with configuration options table available for v4.1. Fixes #2081. (#2119)
* Removing a readme file this is not standardized in classic-mode directory. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Updated to not use readme file in classic-config directory, but the correct description file. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Updated to better sort some sections and update for missing entries. Fixes #2108. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Updated configuration variables for opentelemetry output plugin, many new ones added. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Updated configuration variables for opentelemetry output plugin, many new ones added. Fixes #2083 Signed-off-by: Eric D. Schabell <eric@schabell.org> * Fixes reqeusted by reviewers for options table for opentelemetry output plugin. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Updated prom texfile input plugin docs with configuration options table available for v4.1. Fixes #2081. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Update pipeline/inputs/prometheus-textfile.md Fixed single quotes to codify the boolean values in options table description. Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: Eric D. Schabell <eric@schabell.org> --------- Signed-off-by: Eric D. Schabell <eric@schabell.org> Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com>
1 parent 7c0d776 commit 13f1738

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

pipeline/inputs/prometheus-textfile.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,21 @@ The _Prometheus text file_ input plugin allows Fluent Bit to read metrics from P
44

55
## Configuration parameters
66

7-
| Key | Description | Default |
8-
|-----|-------------|---------|
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` |
7+
| Key | Description | Default |
8+
|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
9+
| `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_ |
10+
| `log_level` | Specifies the log level for output plugin. If not set here, plugin uses global log level in `service` section. | `info` |
11+
| `log_supress_interval` | Suppresses log messages from output plugin that appear similar within a specified time interval. `0` no suppression. | `0` |
12+
| `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` |
13+
| `path` | File or directory path pattern. Supports glob patterns with `*` wildcard (for example, `/var/lib/prometheus/*.prom`). | _none_ |
14+
| `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` |
15+
| `scrape_interval` | Interval in seconds between file scans. | `10s` |
16+
| `storage.pause_on_chunks_overlimit` | Enable pausing on an input when they reach their chunks limit. | _none_ |
17+
| `storage.type` | Sets the storage type for this input, one of: `filesystem`, `memory` or `memrb`. | `memory` |
18+
| `tag` | Set a tag for the events generated by this input plugin. | _none_ |
19+
| `threaded` | Enable threading on an input. | `false` |
20+
| `thread.ring_buffer.capacity` | Set custom ring buffer capacity when the input runs in threaded mode. | `1024` |
21+
| `thread.ring_buffer.window` | Set custom ring buffer window percentage for threaded inputs. | `5` |
1122

1223
## Get started
1324

0 commit comments

Comments
 (0)