docs: storage: dead-letter-queue: document new config parameter#2575
docs: storage: dead-letter-queue: document new config parameter#2575eschabell wants to merge 2 commits into
Conversation
- added storage.rejected.limit and "Limit DLQ size" section with YAML example Signed-off-by: Eric D. Schabell <eric@schabell.org>
- add storage.rejected.limit row to storage parameters table Signed-off-by: Eric D. Schabell <eric@schabell.org>
📝 WalkthroughWalkthroughThis pull request extends Fluent Bit documentation to cover a new DLQ size limit feature. The ChangesDLQ Size Limit Configuration Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
administration/dead-letter-queue.md (1)
69-80: 💤 Low valueConsider adding the new parameter to this example.
The general DLQ example could optionally include
storage.rejected.limitto demonstrate best practices for preventing unbounded growth. However, since the parameter is optional and already documented with a complete example in the "Limit DLQ size" section above, the current approach is acceptable.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@administration/dead-letter-queue.md` around lines 69 - 80, Add the optional storage.rejected.limit parameter to the DLQ example so readers see a best-practice for bounding DLQ size; update the YAML block that defines service and storage keys (e.g., storage.rejected.path, storage.keep.rejected) to include storage.rejected.limit with an example value (such as "100M" or a small integer) and a brief inline comment if desired to indicate it prevents unbounded growth.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@administration/dead-letter-queue.md`:
- Around line 69-80: Add the optional storage.rejected.limit parameter to the
DLQ example so readers see a best-practice for bounding DLQ size; update the
YAML block that defines service and storage keys (e.g., storage.rejected.path,
storage.keep.rejected) to include storage.rejected.limit with an example value
(such as "100M" or a small integer) and a brief inline comment if desired to
indicate it prevents unbounded growth.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 006a695c-6603-40a2-b56e-be1584c7e477
📒 Files selected for processing (2)
administration/configuring-fluent-bit/yaml/service-section.mdadministration/dead-letter-queue.md
|
@cosmo0920 can you review this? |
docs: storage: config: yaml: service-section:
docs: storage: dead-letter-queue:
Note, for code change with no matching docs PR.
Summary by CodeRabbit