Skip to content

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

Open
jinyongchoi wants to merge 1 commit into
fluent:masterfrom
jinyongchoi:docs/add-ring-buffer-retry-limit-option
Open

docs: inputs: add thread.ring_buffer.retry_limit option#2363
jinyongchoi wants to merge 1 commit into
fluent:masterfrom
jinyongchoi:docs/add-ring-buffer-retry-limit-option

Conversation

@jinyongchoi
Copy link
Copy Markdown
Contributor

@jinyongchoi jinyongchoi commented Jan 28, 2026

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 the thread.ring_buffer.retry_limit configuration to multiple input plugin docs. Describes the maximum retry attempts when the ring buffer is full, 100 ms wait between retries, and a default value of 10.

Review Change Stack

Copilot AI review requested due to automatic review settings January 28, 2026 00:50
@jinyongchoi jinyongchoi requested review from a team and eschabell as code owners January 28, 2026 00:50
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 28, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0b87e680-5354-4132-8306-ff5e83b361f6

📥 Commits

Reviewing files that changed from the base of the PR and between 3e27ed9 and 4551cf0.

📒 Files selected for processing (4)
  • pipeline/inputs/blob.md
  • pipeline/inputs/opentelemetry.md
  • pipeline/inputs/prometheus-textfile.md
  • pipeline/inputs/tail.md
✅ Files skipped from review due to trivial changes (4)
  • pipeline/inputs/tail.md
  • pipeline/inputs/opentelemetry.md
  • pipeline/inputs/blob.md
  • pipeline/inputs/prometheus-textfile.md

📝 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

Suggested labels

4.2

Suggested reviewers

  • alexakreizinger
  • cosmo0920

Poem

🐇 I hopped through tables, neat and bright,
Counting retries in the quiet night,
Ten little taps at a hundred ms beat,
I note each pause and make it neat,
Then bound along—docs tidy, light.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 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: documentation additions for a new thread.ring_buffer.retry_limit configuration option across four input plugin pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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

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

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread pipeline/inputs/blob.md Outdated
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread pipeline/inputs/blob.md Outdated
@jinyongchoi jinyongchoi force-pushed the docs/add-ring-buffer-retry-limit-option branch from 0a251c6 to ce45d76 Compare January 28, 2026 00:55
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread pipeline/inputs/opentelemetry.md Outdated
Comment thread pipeline/inputs/prometheus-textfile.md Outdated
Comment thread pipeline/inputs/tail.md Outdated
@jinyongchoi jinyongchoi force-pushed the docs/add-ring-buffer-retry-limit-option branch 3 times, most recently from 92f8e47 to 963dfda Compare January 28, 2026 01:45
@eschabell eschabell self-assigned this Jan 31, 2026
@eschabell
Copy link
Copy Markdown
Collaborator

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

@eschabell eschabell added conflict Waiting on conflict to be resolved by contributor waiting-on-review Waiting on a review from mainteners labels Jan 31, 2026
@jinyongchoi jinyongchoi force-pushed the docs/add-ring-buffer-retry-limit-option branch from 963dfda to a69a897 Compare January 31, 2026 16:24
@jinyongchoi
Copy link
Copy Markdown
Contributor Author

@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 eschabell removed conflict Waiting on conflict to be resolved by contributor waiting-on-review Waiting on a review from mainteners labels Feb 4, 2026
Copy link
Copy Markdown
Collaborator

@eschabell eschabell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@eschabell eschabell added the waiting-on-review Waiting on a review from mainteners label Feb 4, 2026
@jinyongchoi jinyongchoi force-pushed the docs/add-ring-buffer-retry-limit-option branch from a69a897 to 3e27ed9 Compare February 4, 2026 10:26
@jinyongchoi
Copy link
Copy Markdown
Contributor Author

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

Removed. Thanks for the feedback!

Copy link
Copy Markdown
Collaborator

@eschabell eschabell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me now, just waiting on code PR merge.

@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Feb 7, 2026
@eschabell eschabell removed the 5.0 label Apr 1, 2026
@eschabell
Copy link
Copy Markdown
Collaborator

@jinyongchoi resolved the conflicts, waiting on code PR merge.

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 <inimax801@gmail.com>
@jinyongchoi jinyongchoi force-pushed the docs/add-ring-buffer-retry-limit-option branch from f5c57b6 to 4551cf0 Compare May 15, 2026 08:53
@jinyongchoi
Copy link
Copy Markdown
Contributor Author

@jinyongchoi resolved the conflicts, waiting on code PR merge.

Rebased onto latest master to resolve the new conflicts from recent doc cleanups. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants