Skip to content

Conversation

@cosmo0920
Copy link
Contributor

@cosmo0920 cosmo0920 commented Nov 10, 2025

Corresponding PR is:
fluent/fluent-bit#11000

Summary by CodeRabbit

  • Documentation
    • Added new storage configuration options for managing rejected data with documented defaults.
    • Standardized formatting in existing storage configuration entry.

@cosmo0920 cosmo0920 requested review from a team as code owners November 10, 2025 16:13
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 10, 2025

Walkthrough

Documentation update to the storage configuration section, adding two new public configuration keys (storage.keep.rejected and storage.rejected.path) and correcting a typographical inconsistency in an existing storage configuration entry.

Changes

Cohort / File(s) Summary
Storage configuration documentation
administration/buffering-and-storage.md
Added two new configuration keys under Service section with descriptions and defaults; fixed typographical standardization in existing storage.delete_irrecoverable_chunks entry

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

  • Verify new configuration keys (storage.keep.rejected, storage.rejected.path) are properly documented with accurate descriptions and default values
  • Confirm typographical fix maintains consistency with other configuration entries

Poem

🐰 Two new keys hop into the docs today,
Storage paths configured the proper way,
A typo fixed with careful care,
Config clarity everywhere! ✨

Pre-merge checks and finishing touches

✅ 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 'storage: Add descriptions for DLQ parameters' accurately describes the main change: adding descriptions for dead-letter queue (DLQ) storage configuration parameters (storage.keep.rejected and storage.rejected.path) to documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch cosmo0920-dlq-descriptions

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
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: 0

🧹 Nitpick comments (1)
administration/buffering-and-storage.md (1)

151-151: Minor formatting inconsistency in storage.keep.rejected table entry.

There's a missing space before the closing pipe in the default value cell: | Off| should be | Off | to align with adjacent rows (e.g., line 150).

Apply this diff to fix the spacing:

-| `storage.keep.rejected` | When enabled, the dead-letter queue feature stores failed chunks that can't be delivered. Accepted values: `Off`, `On`. | `Off`|
+| `storage.keep.rejected` | When enabled, the dead-letter queue feature stores failed chunks that can't be delivered. Accepted values: `Off`, `On`. | `Off` |
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b570e48 and af10ba2.

📒 Files selected for processing (1)
  • administration/buffering-and-storage.md (1 hunks)
🔇 Additional comments (2)
administration/buffering-and-storage.md (2)

150-150: Typographical fix for storage.delete_irrecoverable_chunks looks good.

The "Accepted values" format is now consistent with other entries in the table, using backticks around Off and On.


152-152: New DLQ path configuration entry is well-documented.

The description clearly explains the relationship to storage.path and the runtime default behavior. The wording about the default subdirectory name rejected being used "if not set" is helpful context for users.

Copy link
Contributor

@esmerel esmerel left a comment

Choose a reason for hiding this comment

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

🎉 ship it

@cosmo0920 cosmo0920 merged commit b6f318c into master Nov 11, 2025
8 checks passed
@cosmo0920 cosmo0920 deleted the cosmo0920-dlq-descriptions branch November 11, 2025 12:56
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