-
Notifications
You must be signed in to change notification settings - Fork 544
in_tail: add thread ring buffer configuration options #2320
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.
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
base: master
Are you sure you want to change the base?
in_tail: add thread ring buffer configuration options #2320
Conversation
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>
📝 WalkthroughWalkthroughTwo new configuration options were documented for the Tail input plugin's threaded mode: Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Poem
Pre-merge checks✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🔇 Additional comments (1)
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. Comment |
There was a problem hiding this 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.capacityparameter with default value of 1024 slots - Added documentation for
thread.ring_buffer.windowparameter with default value of 5%
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
alexakreizinger
left a comment
There was a problem hiding this 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😁
Add
thread.ring_buffer.capacityandthread.ring_buffer.windowparameters 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
thread.ring_buffer.capacity(ring buffer capacity, default: 1024) andthread.ring_buffer.window(flush threshold percentage, default: 5).✏️ Tip: You can customize this high-level summary in your review settings.