Skip to content

Commit 0a251c6

Browse files
committed
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#11393
1 parent 0cb56bb commit 0a251c6

File tree

4 files changed

+4
-0
lines changed

4 files changed

+4
-0
lines changed

pipeline/inputs/blob.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The plugin supports the following configuration parameters:
2323
| `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` |
2424
| `threaded.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` |
2525
| `threaded.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` |
26+
| `thread.ring_buffer.retry_limit` | Maximum number of retry attempts when the ring buffer is full before dropping data. Each retry waits 100ms. | `10` |
2627
| `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_ |
2728
| `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_ |
2829
| `upload_failure_suffix` | Suffix to append to the filename after upload failure. Only used when `upload_failure_action` is set to `add_suffix`. For example, if set to `.failed`, a file named `data.bin` will be renamed to `data.bin.failed`. | _none_ |

pipeline/inputs/opentelemetry.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Fluent Bit has a compliant implementation which fully supports `OTLP/HTTP` and `
4242
| `tag_key` | Record accessor key to use for generating tags from incoming records. | _none_ |
4343
| `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` |
4444
| `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` |
45+
| `thread.ring_buffer.retry_limit` | Maximum number of retry attempts when the ring buffer is full before dropping data. Each retry waits 100ms. | `10` |
4546
| `threaded` | Enable [multithreading](../../administration/multithreading.md) for this input to run in a separate dedicated thread. | `false` |
4647
| `tls` | Enable or disable TLS/SSL support. | `off` |
4748
| `tls.ca_file` | Absolute path to CA certificate file. | _none_ |

pipeline/inputs/prometheus-textfile.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The _Prometheus text file_ input plugin allows Fluent Bit to read metrics from P
1919
| `threaded` | Enable threading on an input. | `false` |
2020
| `thread.ring_buffer.capacity` | Set custom ring buffer capacity when the input runs in threaded mode. | `1024` |
2121
| `thread.ring_buffer.window` | Set custom ring buffer window percentage for threaded inputs. | `5` |
22+
| `thread.ring_buffer.retry_limit` | Maximum number of retry attempts when the ring buffer is full before dropping data. Each retry waits 100ms. | `10` |
2223

2324
## Get started
2425

pipeline/inputs/tail.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ The plugin supports the following configuration parameters:
4747
| `tag_regex` | Set a regular expression to extract fields from the filename. For example: `(?<pod_name>[a-z0-9](?:[-a-z0-9]*[a-z0-9])?(?:\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*)_(?<namespace_name>[^_]+)_(?<container_name>.+)-(?<container_id>[a-z0-9]{64})\.log$`. | _none_ |
4848
| `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` |
4949
| `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` |
50+
| `thread.ring_buffer.retry_limit` | Maximum number of retry attempts when the ring buffer is full before dropping data. Each retry waits 100ms. | `10` |
5051
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
5152
| `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` |
5253
| `unicode.encoding` | Set the Unicode character encoding of the file data. This parameter requests two-byte aligned chunk and buffer sizes. If data isn't aligned for two bytes, Fluent Bit will use two-byte alignment automatically to avoid character breakages on consuming boundaries. Supported values: `UTF-16LE`, `UTF-16BE`, and `auto`. | _none_ |

0 commit comments

Comments
 (0)