Skip to content

docs: administration: configuring: document --dry-run flag and property validation#2521

Merged
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_cli_co_updates
Mar 24, 2026
Merged

docs: administration: configuring: document --dry-run flag and property validation#2521
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_cli_co_updates

Conversation

@eschabell
Copy link
Copy Markdown
Collaborator

@eschabell eschabell commented Mar 23, 2026

  • Add --dry-run subsection under the CLI section explaining validation behavior
  • Note that Fluent Bit 4.2+ catches unknown plugin properties at dry-run time (previously these only failed at runtime)
  • Based on commits: 7e49f8f8b + 8b86fdeed — bin: run additional validation for --dry-run

Summary by CodeRabbit

  • Documentation
    • Added documentation for Fluent Bit's --dry-run command-line flag, covering how to validate configuration files without starting the service. Includes expected success output, exit code behavior (0 on success, non-zero on failure), and full property validation capabilities introduced in version 4.2, with example error messages.

@eschabell eschabell self-assigned this Mar 23, 2026
@eschabell eschabell requested a review from a team as a code owner March 23, 2026 15:06
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0 labels Mar 23, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 23, 2026

Warning

Rate limit exceeded

@eschabell has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 24 minutes and 1 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ee5a89a5-f2ad-4280-9a5d-2310d65a2ffb

📥 Commits

Reviewing files that changed from the base of the PR and between f917f05 and 6cacd42.

📒 Files selected for processing (1)
  • administration/configuring-fluent-bit.md
📝 Walkthrough

Walkthrough

Documentation update adding a new section explaining Fluent Bit's --dry-run command-line flag for configuration validation. The addition covers expected success output, exit code behavior, property validation details introduced in version 4.2, and example error messages for invalid configurations.

Changes

Cohort / File(s) Summary
Documentation
administration/configuring-fluent-bit.md
Added section describing --dry-run flag usage for config validation, including success output format, exit codes, and Fluent Bit 4.2 property validation enhancements with example error messages.

Suggested labels

4.2

Suggested reviewers

  • patrick-stephens
  • cosmo0920

Poem

🐰 A doc so fine, now shines so bright,
--dry-run tested, configs right!
Four-point-two brings validation true,
No more guessing what your configs do! ✨

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ 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 clearly and specifically summarizes the main change: documenting the --dry-run flag and property validation behavior in Fluent Bit documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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
Copy Markdown
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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@administration/configuring-fluent-bit.md`:
- Line 43: Update the sentence about prior behavior to avoid "failed silently at
startup" and instead state that unknown or misspelled plugin property names were
previously surfaced at runtime rather than during validation; specifically edit
the line referencing Fluent Bit 4.2 and `--dry-run` (and the example mentioning
a `dummy` input) so it reads that prior to 4.2 such property errors would only
surface at runtime, whereas `--dry-run` now performs full property validation
and catches them earlier.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1739266b-13ea-44f4-a293-eaf9cac2959d

📥 Commits

Reviewing files that changed from the base of the PR and between d1a3a63 and f917f05.

📒 Files selected for processing (1)
  • administration/configuring-fluent-bit.md

…ty validation

  - Add --dry-run subsection under the CLI section explaining validation behavior
  - Note that Fluent Bit 4.2+ catches unknown plugin properties at dry-run time
    (previously these only failed at runtime)
  - Based on commits: 7e49f8f8b + 8b86fdeed — bin: run additional validation for --dry-run

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the erics_cli_co_updates branch from f917f05 to 6cacd42 Compare March 23, 2026 15:12
@eschabell
Copy link
Copy Markdown
Collaborator Author

@patrick-stephens ready for review!

@eschabell eschabell merged commit dc533c3 into fluent:master Mar 24, 2026
8 checks passed
@eschabell eschabell deleted the erics_cli_co_updates branch March 25, 2026 06:19
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Mar 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants