Updated to include new input plugin doc for Windows System Statistics. Fixes #2139.

[eschabell]

Updated to include new input plugin doc for Windows System Statistics. Fixes #2139.

Added new file for doc and updated Summary.md to display it.

Summary by CodeRabbit

• Documentation
  • New documentation for the Windows System Statistics (winstat) input plugin (Windows-only): describes collected metrics (CPU, memory, disk I/O, network), configuration options (intervals, threading) and computed interval behavior, notes on permissions and OS applicability, usage examples for CLI and config formats, and a reference to an alternative Windows exporter.

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

[coderabbitai]

Walkthrough

Added documentation for a new Windows-only input plugin "Windows System Statistics (winstat)" and updated SUMMARY.md to reference the new documentation file.

Changes

Cohort / File(s)	Change Summary
Documentation Index Update SUMMARY.md	Added an entry linking the Windows System Statistics (winstat) input plugin documentation.
Plugin Documentation pipeline/inputs/windows-system-statistics.md	Added new documentation describing the winstat input plugin: Windows-only behavior, configuration parameters (Interval_Sec, Interval_NSec, Threaded), metrics collected (CPU, memory, disk I/O, network), computed interval logic, permission/OS notes, and CLI/config examples for fluent-bit.yaml and fluent-bit.conf.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Verify descriptions match the plugin implementation (interval computation, threaded behavior).
• Check accuracy of listed metrics and any OS/permission caveats.
• Validate example configuration syntax for both YAML and INI formats.

Poem

🐰 In Windows fields I hop and peep,
I count the cores while others sleep,
CPU and disk, the bytes I chart,
A tiny rabbit, metric at heart,
Hooray — the docs bring winstat out to start!

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 pull request title clearly summarizes the main change: adding documentation for the Windows System Statistics input plugin and updating the Summary.md file.
Linked Issues check	✅ Passed	The pull request fulfills all coding requirements from issue #2139: it provides documentation for the WINSTAT input plugin and updates Summary.md to include the new documentation file.
Out of Scope Changes check	✅ Passed	All changes are directly related to issue #2139 requirements: adding the Windows System Statistics documentation and updating the Summary.md index file.
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 8b9641d and 2bdfa9a.

📒 Files selected for processing (1)

• pipeline/inputs/windows-system-statistics.md (1 hunks)

🧰 Additional context used

🪛 GitHub Check: runner / vale

pipeline/inputs/windows-system-statistics.md

[warning] 1-1:
[vale] reported by reviewdog 🐶
[FluentBit.Spelling] Spelling check: 'winstat'?

Raw Output:
{"message": "[FluentBit.Spelling] Spelling check: 'winstat'?", "location": {"path": "pipeline/inputs/windows-system-statistics.md", "range": {"start": {"line": 1, "column": 30}}}, "severity": "INFO"}

🔇 Additional comments (4)

pipeline/inputs/windows-system-statistics.md (4)

1-98: Documentation structure is well-organized; verify metrics and configuration against plugin implementation.

The documentation is comprehensive and follows standard plugin doc conventions with clear sections for configuration, metrics, usage examples, and notes. However, since I don't have access to the actual winstat plugin implementation, I need to request verification of a few critical details:

1. Metric field names (lines 46-49): Confirm that the output example shows the correct metric field names (e.g., cpu.usage, cpu.user, memory.available, etc.) as they appear in the actual plugin output.
2. Configuration parameters (lines 15-19): Verify that Interval_Sec, Interval_NSec, and Threaded are the complete set of supported parameters. Check if there are additional optional or required parameters not documented.
3. Metric descriptions (lines 25-30): Confirm the metrics descriptions are accurate and clarify units where applicable (e.g., CPU percentage, memory in bytes, disk in operations/bytes).

Additionally, the SUMMARY.md file referenced in the PR objectives was not provided for review. Please verify that it was updated correctly to link to this new documentation file.

---

1-1: Vale spelling check false positive: "winstat" is the official plugin name.

The static analysis tool flagged 'winstat' as a spelling error, but this is the correct and official name of the Windows System Statistics input plugin. This can be safely ignored or whitelisted in the linting configuration.

---

5-9: Platform requirements and notes are clearly communicated.

The documentation appropriately highlights Windows-only availability and permission requirements in both an info box and a notes section. The reference to an alternative Windows Exporter Metrics plugin is helpful for users.

Also applies to: 95-99

---

57-93: Configuration examples are clear and properly documented.

The YAML and classic configuration file examples are consistent, well-formatted, and the interval calculation logic is clearly explained. Both formats align with standard Fluent Bit documentation conventions.

---

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 (3)

pipeline/inputs/windows-system-statistics.md (3)

1-1: Apply sentence-style capitalization to match project style guide.

The heading uses title-case capitalization. The FluentBit style guide recommends sentence-style capitalization for headings.

Apply this diff to fix the heading:

-# Windows System Statistics (winstat)
+# Windows system statistics (winstat)

---

98-98: Use contraction for better readability.

Apply this diff to align with the project's style guide:

-This plugin is Windows-only and will not work on Linux, macOS, or other operating systems.
+This plugin is Windows-only and won't work on Linux, macOS, or other operating systems.

---

21-30: Consider adding specific metric field names.

The metrics table describes categories (CPU, Memory, Disk, Network) but doesn't list actual metric field names. The command-line example (line 48) shows field names like cpu.usage, cpu.user, memory.total, etc. Consider expanding the table with specific metric field names for clarity, or providing a reference to the complete metric list.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cc7a032 and 8b9641d.

📒 Files selected for processing (2)

• SUMMARY.md (1 hunks)
• pipeline/inputs/windows-system-statistics.md (1 hunks)

🧰 Additional context used

🪛 GitHub Check: runner / vale

pipeline/inputs/windows-system-statistics.md

[warning] 98-98:
[vale] reported by reviewdog 🐶
[FluentBit.Contractions] Feel free to use 'won't' instead of 'will not'.

Raw Output:
{"message": "[FluentBit.Contractions] Feel free to use 'won't' instead of 'will not'.", "location": {"path": "pipeline/inputs/windows-system-statistics.md", "range": {"start": {"line": 98, "column": 35}}}, "severity": "INFO"}

---

[warning] 1-1:
[vale] reported by reviewdog 🐶
[FluentBit.Spelling] Spelling check: 'winstat'?

Raw Output:
{"message": "[FluentBit.Spelling] Spelling check: 'winstat'?", "location": {"path": "pipeline/inputs/windows-system-statistics.md", "range": {"start": {"line": 1, "column": 30}}}, "severity": "INFO"}

---

[warning] 1-1:
[vale] reported by reviewdog 🐶
[FluentBit.Headings] 'Windows System Statistics (winstat)' should use sentence-style capitalization.

Raw Output:
{"message": "[FluentBit.Headings] 'Windows System Statistics (winstat)' should use sentence-style capitalization.", "location": {"path": "pipeline/inputs/windows-system-statistics.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "INFO"}

SUMMARY.md

[warning] 128-128:
[vale] reported by reviewdog 🐶
[FluentBit.Spelling] Spelling check: 'winstat'?

Raw Output:
{"message": "[FluentBit.Spelling] Spelling check: 'winstat'?", "location": {"path": "SUMMARY.md", "range": {"start": {"line": 128, "column": 33}}}, "severity": "INFO"}

🔇 Additional comments (2)

pipeline/inputs/windows-system-statistics.md (1)

1-99: Documentation is comprehensive and well-structured.

The new documentation follows the project's format conventions, provides clear configuration examples in both YAML and classic modes, includes practical usage guidance with sample output, and appropriately notes platform restrictions and permissions requirements.

SUMMARY.md (1)

128-128: SUMMARY.md entry correctly positioned and formatted.

The new entry is properly alphabetically ordered, follows the existing link format, and correctly references the new documentation file. The update successfully indexes the new plugin documentation in the table of contents.

[eschabell]

AI code review passed, merging.