docs: inputs: add thread.ring_buffer.retry_limit option

[jinyongchoi]

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#11394

Summary by CodeRabbit

• Documentation
  • Added thread.ring_buffer.retry_limit configuration to multiple input plugin docs (blob, opentelemetry, prometheus-textfile, tail). Describes maximum retry attempts when the ring buffer is full, 100 ms wait between retries, and default value of 10.

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation updates to four input plugin guides adding the thread.ring_buffer.retry_limit configuration parameter; no runtime code or control-flow changes.

Changes

Cohort / File(s)	Summary
Thread ring buffer docs pipeline/inputs/blob.md, pipeline/inputs/opentelemetry.md, pipeline/inputs/prometheus-textfile.md, pipeline/inputs/tail.md	Added documentation for thread.ring_buffer.retry_limit: maximum number of retry attempts when the ring buffer is full; each retry waits 100 ms; default 10.

Sequence Diagram(s)

(omitted)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• in_tail: add thread ring buffer configuration options #2320: Adds thread.ring_buffer configuration documentation for Tail input (related thread.ring_buffer docs).

Suggested labels

4.2.1

Suggested reviewers

• cosmo0920
• alexakreizinger

Poem

🐇 I hopped through docs with nimble feet,

Counting retries—ten small beats,
When buffers brim and lines must wait,
I tap and tally, patient, light and straight,
Then bound away into the night.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding documentation for the thread.ring_buffer.retry_limit option across multiple input plugin pages.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

Important

Action Needed: IP Allowlist Update

If your organization protects your Git platform with IP whitelisting, please add the new CodeRabbit IP address to your allowlist:

• ✨ 136.113.208.247/32 (new)
• 34.170.211.100/32
• 35.222.179.152/32

Reviews will stop working after February 8, 2026 if the new IP is not added to your allowlist.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

Adds documentation for the new thread.ring_buffer.retry_limit input configuration option (retry attempts before dropping data when the threaded ring buffer is full).

Changes:

• Documented thread.ring_buffer.retry_limit for tail, opentelemetry, prometheus-textfile, and blob inputs.
• Described behavior (max retries, 100ms wait per retry) and default value (10).

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
pipeline/inputs/tail.md	Adds thread.ring_buffer.retry_limit to the Tail input config table.
pipeline/inputs/opentelemetry.md	Adds thread.ring_buffer.retry_limit to the OpenTelemetry input config table.
pipeline/inputs/prometheus-textfile.md	Adds thread.ring_buffer.retry_limit to the Prometheus textfile input config table.
pipeline/inputs/blob.md	Adds thread.ring_buffer.retry_limit to the Blob input config table (but key prefix is inconsistent with adjacent entries).

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@pipeline/inputs/blob.md`:
- Around line 24-26: The three ring buffer parameters must use the same
namespace; replace the incorrect parameter name thread.ring_buffer.retry_limit
with threaded.ring_buffer.retry_limit so all three read
threaded.ring_buffer.capacity, threaded.ring_buffer.window and
threaded.ring_buffer.retry_limit; update the occurrence of
thread.ring_buffer.retry_limit in blob.md to threaded.ring_buffer.retry_limit to
match the other inputs and maintain naming consistency.

[coderabbitai]

Actionable comments posted: 3

🤖 Fix all issues with AI agents

In `@pipeline/inputs/opentelemetry.md`:
- Line 45: Update the unit formatting in the description for
`thread.ring_buffer.retry_limit`: replace "100ms" with "100 ms" using a
non-breaking space so the number and unit stay together (i.e., change the text
in the table cell to use "100 ms"). Ensure only the formatting of the unit is
changed and the rest of the description remains unchanged.

In `@pipeline/inputs/prometheus-textfile.md`:
- Line 21: Update the text for the `thread.ring_buffer.retry_limit` description
to use a non‑breaking space between the number and unit: replace "100ms" with
"100\u00A0ms" so the unit follows the FluentBit.Units style guide and avoids
line breaks (target the description string containing
`thread.ring_buffer.retry_limit`).

In `@pipeline/inputs/tail.md`:
- Line 50: Update the unit formatting for the `thread.ring_buffer.retry_limit`
description by replacing the hard space in "100ms" with a non-breaking space so
it reads "100\u00A0ms" (or use the HTML entity ` ` if appropriate for the
Markdown renderer); locate the table cell containing the text "Each retry waits
100ms." and change it to "Each retry waits 100\u00A0ms." to comply with the
FluentBit.Units style guide.

[eschabell]

@jinyongchoi the patch for the other config threaded* parameter fix is now causing conflicts here, can you resolve?

[jinyongchoi]

@jinyongchoi the patch for the other config threaded* parameter fix is now causing conflicts here, can you resolve?

Rebased on latest master to resolve conflicts caused by the threaded.* → thread.* parameter rename.
Also reordered thread.ring_buffer.retry_limit to maintain alphabetical sorting in all four plugin pages.
Thanks!

[eschabell]

@jinyongchoi I'm not sure I see the need to use   for the spacing? Can you remove that please?

[jinyongchoi]

@jinyongchoi I'm not sure I see the need to use   for the spacing? Can you remove that please?

Removed. Thanks for the feedback!