Skip to content

docs: outputs: exit: update doc and add example#2429

Open
eschabell wants to merge 1 commit intofluent:masterfrom
eschabell:erics_out_exit_updates
Open

docs: outputs: exit: update doc and add example#2429
eschabell wants to merge 1 commit intofluent:masterfrom
eschabell:erics_out_exit_updates

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 16, 2026

  • Lowercase Key column entries in parameter table
  • Fix all defaults: none -> -1
  • Sort table alphabetically
  • Fix extra space before none on record_count row
  • Add missing period to flush_count description
  • Add Get started section with YAML and classic config examples using record_count

Applies to #2412

Summary by CodeRabbit

  • Documentation
    • Added "Get started" guide with example configurations demonstrating exit functionality in both YAML and text formats.
    • Updated configuration parameter naming conventions (record_count, flush_count, time_count).
    • Modified default values for configuration parameters.

  - Lowercase Key column entries in parameter table
  - Fix all defaults: _none_ -> -1
  - Sort table alphabetically
  - Fix extra space before _none_ on record_count row
  - Add missing period to flush_count description
  - Add Get started section with YAML and classic config examples using record_count

  Applies to fluent#2412

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Mar 16, 2026
@eschabell eschabell requested a review from a team as a code owner March 16, 2026 14:25
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0 labels Mar 16, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 16, 2026

📝 Walkthrough

Walkthrough

Documentation for the exit plugin was updated with renamed configuration parameters (snake_case convention), modified default values from "none" to "-1", and a new "Get started" section containing usage examples in YAML and text configuration formats.

Changes

Cohort / File(s) Summary
Exit Plugin Documentation
pipeline/outputs/exit.md
Renamed configuration parameters from PascalCase to snake_case (Record_Count → record_count, Flush_Count → flush_count, Time_Count → time_count), changed default values from "none" to "-1", and added a "Get started" section with example configurations demonstrating exit after 5 records in both YAML and text formats.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 With whiskers twitched and paws so quick,
I've hopped through docs to check each trick,
Snake_case flows and defaults true,
Examples fresh for all to chew!
The exit path now crystal clear,
For every config far and near!

🚥 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 accurately summarizes the main change: documentation updates and addition of an example to the exit output configuration page.
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
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

CodeRabbit can enforce grammar and style rules using `languagetool`.

Configure the reviews.tools.languagetool setting to enable/disable rules and categories. Refer to the LanguageTool Community to learn more.

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: 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 `@pipeline/outputs/exit.md`:
- Line 53: Update the classic fluent-bit.conf example to use Title_Case for the
plugin key by changing the incorrect "Record_count" entry to the canonical
"Record_Count" so the example matches docs conventions for plugin-specific keys;
locate the occurrence of "Record_count 5" in the exit output example and replace
it with "Record_Count 5".

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 591c5bde-98e8-4ef9-843f-774eca6aefa6

📥 Commits

Reviewing files that changed from the base of the PR and between 2a548ae and fcc4ed9.

📒 Files selected for processing (1)
  • pipeline/outputs/exit.md

@eschabell
Copy link
Collaborator Author

@cosmo0920 and @patrick-stephens ready for review!

| `Record_Count` | Number of records to wait for before exiting. | _none_ |
| `Flush_Count` | Number of flushes to wait for before exiting.| _none_ |
| `Time_Count` | Number of seconds to wait for before exiting. | _none_ |
| `flush_count` | Number of flushes to wait for before exiting. | `-1` |
Copy link
Contributor

Choose a reason for hiding this comment

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

I thought we were doing Title_Case now?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5.0 waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants