Skip to content

Conversation

@jinyongchoi
Copy link
Contributor

@jinyongchoi jinyongchoi commented Jan 6, 2026

Add thread.ring_buffer.capacity and thread.ring_buffer.window parameters to the Tail input plugin documentation.

These options are already documented in other input plugins (OpenTelemetry, Prometheus text file). While testing with fluent/fluent-bit#11337, found that these parameters are also useful for tuning the Tail plugin in threaded mode.

When using threaded: true, users may need to adjust the ring buffer settings to handle high-volume log ingestion or optimize flush timing based on their workload.

Summary by CodeRabbit

Documentation

  • Added two new configuration options to the Tail input plugin for threaded mode: thread.ring_buffer.capacity (ring buffer capacity, default: 1024) and thread.ring_buffer.window (flush threshold percentage, default: 5).

✏️ Tip: You can customize this high-level summary in your review settings.

Add thread.ring_buffer.capacity and thread.ring_buffer.window configuration
parameters to the Tail input plugin documentation. These options control the
ring buffer behavior when running in threaded mode.

Signed-off-by: jinyong.choi <inimax801@gmail.com>
Copilot AI review requested due to automatic review settings January 6, 2026 08:02
@jinyongchoi jinyongchoi requested review from a team as code owners January 6, 2026 08:02
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 6, 2026

📝 Walkthrough

Walkthrough

Two new configuration options were documented for the Tail input plugin's threaded mode: thread.ring_buffer.capacity for ring buffer slot count and thread.ring_buffer.window for flush threshold percentage. No functional changes were introduced.

Changes

Cohort / File(s) Summary
Documentation Updates
pipeline/inputs/tail.md
Added two new configuration parameters: thread.ring_buffer.capacity (default: 1024) and thread.ring_buffer.window (default: 5) for ring buffer management in threaded mode.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

4.2

Poem

🐰 A rabbit hops through configs new,
Ring buffers, windows, all so true,
With capacity set, the threads fly free,
Documentation blooms for all to see! ✨

Pre-merge checks

✅ 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 directly and clearly describes the main change: adding thread ring buffer configuration options to the in_tail plugin documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 623781d and ec3a8e2.

📒 Files selected for processing (1)
  • pipeline/inputs/tail.md
🔇 Additional comments (1)
pipeline/inputs/tail.md (1)

48-49: Clean addition of thread ring buffer configuration options.

The two new parameters are well-documented with clear descriptions, appropriate defaults, and consistent formatting. Placement immediately before the threaded parameter logically groups related configuration options, and the links to multithreading documentation provide good context.

Since the PR mentions these parameters are already documented for OpenTelemetry and Prometheus text file input plugins, please verify that the descriptions here are consistent with how they're documented in those other plugins. This helps ensure uniform user experience across the documentation.


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

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

This PR adds documentation for two thread ring buffer configuration parameters (thread.ring_buffer.capacity and thread.ring_buffer.window) to the Tail input plugin. These parameters are already documented in other input plugins but were missing from the Tail plugin documentation, despite being supported when the plugin runs in threaded mode.

  • Added documentation for thread.ring_buffer.capacity parameter with default value of 1024 slots
  • Added documentation for thread.ring_buffer.window parameter with default value of 5%

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

Copy link
Member

@alexakreizinger alexakreizinger left a comment

Choose a reason for hiding this comment

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

thanks for copying these over from the other docs! I didn't realize they applied to this plugin too😁

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants