docs: outputs: exit: update doc and add example#2429
docs: outputs: exit: update doc and add example#2429eschabell wants to merge 1 commit intofluent:masterfrom
Conversation
- 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>
📝 WalkthroughWalkthroughDocumentation 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 Tip CodeRabbit can enforce grammar and style rules using `languagetool`.Configure the |
There was a problem hiding this comment.
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".
|
@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` | |
There was a problem hiding this comment.
I thought we were doing Title_Case now?
Applies to #2412
Summary by CodeRabbit