docs: buffering: document memrb storage type and improve coverage#2374
docs: buffering: document memrb storage type and improve coverage#2374eschabell wants to merge 1 commit intofluent:masterfrom
Conversation
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughAdds a new memory ring buffer mode ("memrb") to buffering documentation, expands buffering modes to three (memory-only, memrb, filesystem), documents memrb behavior and metrics, updates configuration reference and examples, and adds guidance for global/per-input storage.type inheritance. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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 |
7e32eb0 to
21397ec
Compare
There was a problem hiding this comment.
Pull request overview
This PR enhances the Fluent Bit buffering documentation by adding comprehensive coverage for the memory ring buffer (memrb) storage type, which joins memory-only and filesystem as the third buffering mode. The documentation now accurately reflects that Fluent Bit supports three buffering modes rather than two, and provides detailed information about memrb's behavior, configuration, and monitoring capabilities.
Changes:
- Updated buffering modes introduction to describe three modes instead of two
- Added new "Memory ring buffer buffering" section explaining memrb behavior and use cases
- Updated
storage.typeparameter documentation to include memrb as an accepted value - Added memrb configuration examples in both YAML and classic formats
- Documented memrb-specific metrics (memrb_dropped_chunks and memrb_dropped_bytes)
- Added note about storage.inherit and global storage.type configuration
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@pipeline/buffering.md`:
- Line 92: The doc text for mem_buf_limit conflicts with examples referencing
storage.type: memrb; update the description of mem_buf_limit to state explicitly
whether it applies to memory-only buffering and/or memrb mode. Modify the
paragraph for the `mem_buf_limit` entry so it clarifies scope (e.g., "If
memory-only buffering or memrb storage is used, sets a limit..."), mention that
the value must follow unit size specs, and keep the default behavior note
(unspecified means no limit). Ensure references to `mem_buf_limit` and
`storage.type: memrb` in examples remain consistent with this new description.
- Around line 84-85: Remove the incorrect reference to storage.inherit in the
service section and update the sentence to accurately explain buffering
defaults: state that you set a global default by configuring storage.type in the
service section and that input plugins that do not explicitly set their own
storage.type will inherit the global storage.type by default; replace or remove
any mention of storage.inherit and, if helpful, add a short note that per-plugin
buffering is configured via each input's storage.type setting.
21397ec to
bf40aba
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
bf40aba to
0a59e51
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Add memory ring buffer (memrb) as third buffering mode section - Update intro from "two modes" to "three modes" - Add memrb as accepted value for per-input storage.type - Add memrb configuration examples in YAML and classic formats - Document memrb_dropped_chunks and memrb_dropped_bytes metrics - Add note about storage.inherit and global storage.type usage - Sort per-input settings table alphabetically by key - Clarify mem_buf_limit applies to both memory-only and memrb modes - Add storage.inherit configuration example with YAML and classic formats - fix Log_Level capitalization in classic format examples Fixes fluent#2373 Signed-off-by: Eric D. Schabell <eric@schabell.org>
0a59e51 to
942e5ae
Compare
|
@cosmo0920 and @patrick-stephens ready for review! |
Fixes #2373
Summary by CodeRabbit