From 3e27ed92ecc197e57c704effd6fa597fc95d22c0 Mon Sep 17 00:00:00 2001 From: "jinyong.choi" Date: Wed, 28 Jan 2026 09:45:31 +0900 Subject: [PATCH] docs: inputs: add thread.ring_buffer.retry_limit option Add documentation for the new 'thread.ring_buffer.retry_limit' configuration option to the following input plugin pages: - tail - opentelemetry - prometheus-textfile - blob This option controls the maximum number of retry attempts when the ring buffer is full before dropping data. Each retry waits 100ms (hardcoded). The default value is 10. Refs: fluent/fluent-bit#113934 Signed-off-by: jinyong.choi --- pipeline/inputs/blob.md | 1 + pipeline/inputs/opentelemetry.md | 1 + pipeline/inputs/prometheus-textfile.md | 1 + pipeline/inputs/tail.md | 1 + 4 files changed, 4 insertions(+) diff --git a/pipeline/inputs/blob.md b/pipeline/inputs/blob.md index 5aec976f7..c08a1ef20 100644 --- a/pipeline/inputs/blob.md +++ b/pipeline/inputs/blob.md @@ -22,6 +22,7 @@ The plugin supports the following configuration parameters: | `tag` | Set a tag for the events generated by this input plugin. Tags are used for routing records to specific outputs. Supports tag expansion with wildcards. | _none_ | | `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). When enabled, the plugin runs in a separate thread, which can improve performance for I/O-bound operations. | `false` | | `thread.ring_buffer.capacity` | Set custom ring buffer capacity when the input runs in threaded mode. This determines how many records can be buffered in the ring buffer before blocking. | `1024` | +| `thread.ring_buffer.retry_limit` | Maximum number of retry attempts when the ring buffer is full before dropping data. Each retry waits 100 ms. | `10` | | `thread.ring_buffer.window` | Set custom ring buffer window percentage for threaded inputs. This controls when the ring buffer is considered "full" and triggers backpressure handling. | `5` | | `upload_failure_action` | Action to perform on the file after upload failure. Supported values: `delete` (delete the file), `add_suffix` (rename file by appending a suffix), `emit_log` (emit a log record with a custom message). When set to `add_suffix`, use `upload_failure_suffix` to specify the suffix. When set to `emit_log`, use `upload_failure_message` to specify the message. | _none_ | | `upload_failure_message` | Message to emit as a log record after upload failure. Only used when `upload_failure_action` is set to `emit_log`. This can be used for debugging or monitoring purposes. | _none_ | diff --git a/pipeline/inputs/opentelemetry.md b/pipeline/inputs/opentelemetry.md index 23fdc22fe..f7424e4c4 100644 --- a/pipeline/inputs/opentelemetry.md +++ b/pipeline/inputs/opentelemetry.md @@ -41,6 +41,7 @@ Fluent Bit has a compliant implementation which fully supports `OTLP/HTTP` and ` | `tag_from_uri` | By default, the tag will be created from the URI. For example, `v1_metrics` from `/v1/metrics`. This must be set to false if using `tag`. | `true` | | `tag_key` | Record accessor key to use for generating tags from incoming records. | _none_ | | `thread.ring_buffer.capacity` | Number of slots in the ring buffer for data entries when running in [threaded](../../administration/multithreading.md) mode. Each slot can hold one data entry. | `1024` | +| `thread.ring_buffer.retry_limit` | Maximum number of retry attempts when the ring buffer is full before dropping data. Each retry waits 100 ms. | `10` | | `thread.ring_buffer.window` | Percentage threshold (1-100) of the ring buffer capacity at which a flush is triggered when running in [threaded](../../administration/multithreading.md) mode. | `5` | | `threaded` | Enable [multithreading](../../administration/multithreading.md) for this input to run in a separate dedicated thread. | `false` | | `tls` | Enable or disable TLS/SSL support. | `off` | diff --git a/pipeline/inputs/prometheus-textfile.md b/pipeline/inputs/prometheus-textfile.md index c97d3d7bb..8f4c2e28c 100644 --- a/pipeline/inputs/prometheus-textfile.md +++ b/pipeline/inputs/prometheus-textfile.md @@ -17,6 +17,7 @@ The _Prometheus text file_ input plugin allows Fluent Bit to read metrics from P | `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_ | | `thread.ring_buffer.capacity` | Set custom ring buffer capacity when the input runs in threaded mode. | `1024` | +| `thread.ring_buffer.retry_limit` | Maximum number of retry attempts when the ring buffer is full before dropping data. Each retry waits 100 ms. | `10` | | `thread.ring_buffer.window` | Set custom ring buffer window percentage for threaded inputs. | `5` | | `threaded` | Enable threading on an input. | `false` | diff --git a/pipeline/inputs/tail.md b/pipeline/inputs/tail.md index 8a9a5b906..7880ea1cc 100644 --- a/pipeline/inputs/tail.md +++ b/pipeline/inputs/tail.md @@ -46,6 +46,7 @@ The plugin supports the following configuration parameters: | `tag` | Set a tag with `regexextract` fields that will be placed on lines read. For example, `kube....`. Tag expansion is supported: if the tag includes an asterisk (`*`), that asterisk will be replaced with the absolute path of the monitored file, with slashes replaced by dots. See [Workflow of Tail + Kubernetes Filter](../filters/kubernetes.md#workflow-of-tail--kubernetes-filter). | _none_ | | `tag_regex` | Set a regular expression to extract fields from the filename. For example: `(?[a-z0-9](?:[-a-z0-9]*[a-z0-9])?(?:\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)_(?[^_]+)_(?.+)-(?[a-z0-9]{64})\.log$`. | _none_ | | `thread.ring_buffer.capacity` | Number of slots in the ring buffer for data entries when running in [threaded](../../administration/multithreading.md) mode. Each slot can hold one data entry. | `1024` | +| `thread.ring_buffer.retry_limit` | Maximum number of retry attempts when the ring buffer is full before dropping data. Each retry waits 100 ms. | `10` | | `thread.ring_buffer.window` | Percentage threshold (1-100) of the ring buffer capacity at which a flush is triggered when running in [threaded](../../administration/multithreading.md) mode. | `5` | | `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` | | `truncate_long_lines` | When enabled, truncates lines that exceed the buffer capacity after input encoding conversion to UTF-8. Use this option when dealing with character encoding conversions that might expand the line length. | `false` |