Skip to content

docs: inputs: add thread.ring_buffer.retry_limit option #2363

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

Open
jinyongchoi wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −0
Open

docs: inputs: add thread.ring_buffer.retry_limit option #2363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions pipeline/inputs/blob.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ The plugin supports the following configuration parameters:
| `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` |
| `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` |
| `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` |
| `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` |
| `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_ |
| `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_ |
Expand Down
1 change: 1 addition & 0 deletions pipeline/inputs/opentelemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Fluent Bit has a compliant implementation which fully supports `OTLP/HTTP` and `
| `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.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` |
| `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` |
| `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` |
| `tls.ca_file` | Absolute path to CA certificate file. | _none_ |
Expand Down
1 change: 1 addition & 0 deletions pipeline/inputs/prometheus-textfile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ The _Prometheus text file_ input plugin allows Fluent Bit to read metrics from P
| `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.window` | Set custom ring buffer window percentage for threaded inputs. | `5` |
| `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` |
| `threaded` | Enable threading on an input. | `false` |

## Get started
Expand Down
1 change: 1 addition & 0 deletions pipeline/inputs/tail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ The plugin supports the following configuration parameters:
| `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_ |
| `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.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` |
| `thread.ring_buffer.retry_limit` | Maximum number of retry attempts when the ring buffer is full before dropping data. Each retry waits 100&nbsp;ms. | `10` |
| `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` |
| `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_ |
Expand Down