Fixed typos, sorted config table, moved a config option from metrics table. Fixes #2233

[eschabell]

Fixed typos, sorted config table, moved a config option from metrics table. Fixes #2233

Summary by CodeRabbit

• Documentation

  • Reorganized CPU metrics docs; renamed config keys to interval_sec, interval_nsec and pid; added a new threaded option (default: false)
  • Updated wording for getting started and command-line usage; expanded example output for clarity

• Chores

  • Added PID to style-guide acronyms exceptions

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

This PR updates the CPU metrics input plugin documentation: parameter names standardized to lowercase, the threaded option added and promoted to public config, command-line examples and wording refined. Also updates Vale acronyms config to add PID as an exception.

Changes

Cohort / File(s)	Summary
CPU Metrics documentation pipeline/inputs/cpu-metrics.md	Renamed config keys to lowercase (Interval_Sec → interval_sec, Interval_NSec → interval_nsec, PID → pid); added threaded option (default: false) as a public parameter; reorganized configuration table; adjusted "Get started" and command-line wording and expanded sample output.
Vale acronyms configuration vale-styles/FluentBit/Acronyms.yml	Added PID to the acronym exceptions list to prevent automatic "spell out" transformation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Check pipeline/inputs/cpu-metrics.md for consistency between the new parameter table, defaults, and examples.
• Confirm PID addition in vale-styles/FluentBit/Acronyms.yml follows existing YAML structure and style.

Possibly related PRs

• Vale/general: various page updates to reduce messages #2167 — Also modifies vale-styles/FluentBit/Acronyms.yml, related to acronym exceptions and Vale style updates.

Suggested reviewers

• esmerel
• cnorris-cs
• alexakreizinger

Poem

🐇
I hopped through docs with tiny feet,
Lowercased names now tidy and neat,
A threaded toggle joined the crew,
PID got a pass — concise and true,
Hooray for clarity, fresh and sweet!

Pre-merge checks and finishing touches

✅ 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 changes: typo fixes, config table sorting, and moving a config option from metrics table.
Linked Issues check	✅ Passed	The PR addresses all coding requirements from issue #2233: moved threaded config option, fixed typos, and reorganized configuration table.
Out of Scope Changes check	✅ Passed	All changes are directly scoped to issue #2233: configuration documentation updates and Vale style rule adjustments for acronyms.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6ab4974 and ce0e63a.

📒 Files selected for processing (1)

• pipeline/inputs/cpu-metrics.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• pipeline/inputs/cpu-metrics.md

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

pipeline/inputs/cpu-metrics.md (1)

35-35: Minor style: Streamline verbose phrase (optional).

The phrase "In order to get the statistics" could be simplified to "To get the statistics" for better conciseness.

-In order to get the statistics of the CPU usage of your system, you can run the plugin from the command line or through the configuration file:
+To get the statistics of the CPU usage of your system, you can run the plugin from the command line or through the configuration file:

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9c28f9e and 6ab4974.

📒 Files selected for processing (2)

• pipeline/inputs/cpu-metrics.md (1 hunks)
• vale-styles/FluentBit/Acronyms.yml (1 hunks)

🧰 Additional context used

🪛 LanguageTool

pipeline/inputs/cpu-metrics.md

[style] ~35-~35: Consider a more concise word here.
Context: ... | false | ## Get started In order to get the statistics of the CPU usage of ...

(IN_ORDER_TO_PREMIUM)

🔇 Additional comments (5)

vale-styles/FluentBit/Acronyms.yml (1)

102-102: Acronym exception addition is correct.

The addition of PID to the exceptions list is appropriately positioned alphabetically and aligns with the lowercase pid parameter naming convention being introduced in the CPU metrics documentation.

pipeline/inputs/cpu-metrics.md (4)

13-13: Main CPU table documentation is consistent.

The user_p key documentation aligns with the plugin's output examples and provides consistent context for system-wide CPU usage metrics.

---

21-21: Per-core keys table is now complete.

Adding cpuN.p_user documentation completes the set of documented per-core metrics and aligns with the output examples showing per-core user mode CPU usage.

---

27-32: Configuration table reorganization is correct and well-structured.

The table now properly:

• Uses lowercase parameter naming convention (e.g., interval_sec instead of Interval_Sec), which aligns with YAML configuration syntax and the Vale acronym exception just added
• Moves the threaded parameter from an incorrect placement in the metrics table to its proper location in the configuration section, addressing issue #2233
• Maintains alphabetical ordering of parameters
• Provides clear descriptions with appropriate references (e.g., link to multithreading documentation)

---

40-40: Terminology update improves clarity.

Changing the description to reference "input plugin" rather than "filter" is more accurate and aligns with Fluent Bit's architectural terminology.

[eschabell]

AI review passed, merging.