Skip to content

docs: outputs: cloudwatch: add workers, fix classic key casing, fix bool values#2420

Merged
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_out_cloudwatch_updates
Mar 16, 2026
Merged

docs: outputs: cloudwatch: add workers, fix classic key casing, fix bool values#2420
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_out_cloudwatch_updates

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 14, 2026

  • Add missing workers parameter with correct default of 1
  • Apply Title_Case to all [OUTPUT] keys across all 5 classic config examples
  • Fix auto_create_group boolean: true -> On in classic config metrics examples
  • Align [INPUT] and [FILTER] key spacing in classic config examples for consistency

Applies to #2412

Summary by CodeRabbit

  • Documentation
    • Updated CloudWatch output configuration documentation with the addition of a workers parameter.
    • Standardized configuration key naming conventions in CloudWatch examples and snippets.
    • Improved formatting and alignment of configuration blocks for better readability.

…ool values

  - Add missing workers parameter with correct default of 1
  - Apply Title_Case to all [OUTPUT] keys across all 5 classic config examples
  - Fix auto_create_group boolean: true -> On in classic config metrics examples
  - Align [INPUT] and [FILTER] key spacing in classic config examples for consistency

  Applies to fluent#2412

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

coderabbitai bot commented Mar 14, 2026

📝 Walkthrough

Walkthrough

This PR updates the CloudWatch output configuration documentation by adding a workers parameter to the configuration table and converting configuration keys from snake_case to CamelCase format, with alignment adjustments for consistency.

Changes

Cohort / File(s) Summary
CloudWatch Output Documentation
pipeline/outputs/cloudwatch.md
Added workers parameter row to configuration table; converted configuration keys from snake_case to CamelCase (e.g., region → Region, log_group_name → Log_group_name, auto_create_group → Auto_create_group); adjusted indentation and alignment across example blocks for consistent column formatting.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 ✨ With CamelCase now dancing bright,
And workers marching into sight,
CloudWatch docs aligned just so,
Configuration's proper flow! 📊

🚥 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 changes: adding a workers parameter, fixing key casing in CloudWatch output configuration, and correcting boolean values in documentation examples.
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.

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.

🧹 Nitpick comments (1)
pipeline/outputs/cloudwatch.md (1)

91-91: Update allowed boolean values text to match examples.

Examples now use Auto_create_group On, but the parameter table still says allowed values are only true, false. Please include on/off there to avoid contradictory guidance.

Suggested doc patch
-| `auto_create_group`                | Automatically create the log group. Allowed values: `true`, `false` (case insensitive).      | `false`    |
+| `auto_create_group`                | Automatically create the log group. Allowed values: `true`, `false`, `on`, `off` (case insensitive). | `false`    |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@pipeline/outputs/cloudwatch.md` at line 91, The parameter documentation for
Auto_create_group is inconsistent with examples: update the parameter table
entry for Auto_create_group to list allowed boolean values as both true/false
and on/off (matching examples like "Auto_create_group On"), and note that values
are case-insensitive if applicable; locate references to "Auto_create_group" in
the docs and add "on/off" alongside "true/false" in the allowed values cell and
any descriptive text.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@pipeline/outputs/cloudwatch.md`:
- Line 91: The parameter documentation for Auto_create_group is inconsistent
with examples: update the parameter table entry for Auto_create_group to list
allowed boolean values as both true/false and on/off (matching examples like
"Auto_create_group On"), and note that values are case-insensitive if
applicable; locate references to "Auto_create_group" in the docs and add
"on/off" alongside "true/false" in the allowed values cell and any descriptive
text.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 57158c09-c7db-4be2-995f-984941d84d95

📥 Commits

Reviewing files that changed from the base of the PR and between 455c4ee and 647dced.

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

@eschabell
Copy link
Collaborator Author

@cosmo0920 and @patrick-stephens ready for review!

@eschabell eschabell merged commit 0e1a2c2 into fluent:master Mar 16, 2026
8 checks passed
@eschabell eschabell deleted the erics_out_cloudwatch_updates branch March 16, 2026 15:30
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Mar 16, 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