Skip to content

docs: pipeline: fix classic config key casing to Title_Case#2619

Open
eschabell wants to merge 1 commit into
fluent:masterfrom
eschabell:erics_title_case_plugin_fixes
Open

docs: pipeline: fix classic config key casing to Title_Case#2619
eschabell wants to merge 1 commit into
fluent:masterfrom
eschabell:erics_title_case_plugin_fixes

Conversation

@eschabell

@eschabell eschabell commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator

Classic config examples for plugins should use Title_Case keys, but several were authored with lowercase keys copied from their YAML tabs. Fix plain keys while leaving dotted/namespaced keys lowercase per convention.

  • Input plugins updated: elasticsearch, fluentbit-metrics, kubernetes-events, node-exporter-metrics, process-exporter-metrics, prometheus-remote-write, prometheus-scrape-metrics, tail, windows-exporter-metrics
  • Filter plugins updated: grep (parsers_file), kubernetes (aws_use_pod_association, set_platform)

Summary by CodeRabbit

  • Documentation
    • Updated Fluent Bit configuration examples across input and filter guides to use consistent capitalization and formatting for section headers and directives.
    • Improved clarity and consistency for service, input, and output configuration snippets without changing their example values or behavior.

Classic config examples for plugins should use Title_Case keys, but several
were authored with lowercase keys copied from their YAML tabs. Fix plain keys
while leaving dotted/namespaced keys lowercase per convention.

  - Input plugins updated: elasticsearch, fluentbit-metrics, kubernetes-events,
    node-exporter-metrics, process-exporter-metrics, prometheus-remote-write,
    prometheus-scrape-metrics, tail, windows-exporter-metrics
  - Filter plugins updated: grep (parsers_file),
    kubernetes (aws_use_pod_association, set_platform)

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Jul 10, 2026
@eschabell eschabell requested a review from a team as a code owner July 10, 2026 19:18
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0.8 labels Jul 10, 2026
@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e7f1563e-b501-4c54-8f0e-7156893d4be4

📥 Commits

Reviewing files that changed from the base of the PR and between a391227 and 7bce435.

📒 Files selected for processing (11)
  • pipeline/filters/grep.md
  • pipeline/filters/kubernetes.md
  • pipeline/inputs/elasticsearch.md
  • pipeline/inputs/fluentbit-metrics.md
  • pipeline/inputs/kubernetes-events.md
  • pipeline/inputs/node-exporter-metrics.md
  • pipeline/inputs/process-exporter-metrics.md
  • pipeline/inputs/prometheus-remote-write.md
  • pipeline/inputs/prometheus-scrape-metrics.md
  • pipeline/inputs/tail.md
  • pipeline/inputs/windows-exporter-metrics.md

📝 Walkthrough

Walkthrough

Fluent Bit documentation examples were reformatted to use capitalized, underscored configuration directives across filter, input, output, service, and metrics configuration snippets. Existing values, metric selections, and example structures remain unchanged.

Changes

Configuration example updates

Layer / File(s) Summary
Filter configuration directives
pipeline/filters/grep.md, pipeline/filters/kubernetes.md
Filter examples use capitalized directive names such as Parsers_File, Aws_Use_Pod_Association, and Set_Platform.
Input and output configuration directives
pipeline/inputs/elasticsearch.md, pipeline/inputs/fluentbit-metrics.md, pipeline/inputs/kubernetes-events.md, pipeline/inputs/node-exporter-metrics.md, pipeline/inputs/process-exporter-metrics.md, pipeline/inputs/prometheus-*.md, pipeline/inputs/tail.md
Input, output, and service snippets use capitalized and aligned configuration keys while retaining their existing values and block structures.
Windows metrics configuration directives
pipeline/inputs/windows-exporter-metrics.md
Windows exporter examples update service, input, and output directive casing and formatting while preserving metric selections and counter definitions.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested labels: 5.0

Suggested reviewers: patrick-stephens, cosmo0920, alexakreizinger

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 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: updating classic pipeline config examples to Title_Case keys.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ 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.

@eschabell

Copy link
Copy Markdown
Collaborator Author

@patrick-stephens bit of maintenance on all the plugins.... ready for review!

@eschabell eschabell added 5.0.9 and removed 5.0.8 labels Jul 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant