docs: inputs: winevtlog: add render_event_as_text params and fix table formatting

[eschabell]

• Add render_event_as_text, render_event_text_key config parameters
• Update render_event_as_xml description to match source
• Convert config parameter table keys to lowercase to match source
• Sort config parameter table alphabetically
• Fix parameter references in prose and command line examples to use lowercase
• Add "Render events as text" usage section with YAML and classic .conf examples

Fixes #2495

Summary by CodeRabbit

• Documentation
  • Updated Windows Event Log input configuration parameter naming conventions for consistency.
  • Introduced new "render events as text" option for event output formatting.
  • Enhanced configuration examples and clarified mutual exclusivity between text and XML rendering options.

[coderabbitai]

📝 Walkthrough

Walkthrough

The documentation for the Windows Event Log input plugin configuration is updated to convert all parameter keys from PascalCase to snake_case format, add new render_event_as_text and render_event_text_key parameters, correct the render_event_as_xml description, and document mutual exclusivity between rendering modes.

Changes

Cohort / File(s)	Summary
Windows Event Log Input Documentation pipeline/inputs/windows-event-log-winevtlog.md	Standardizes configuration parameter naming from PascalCase to snake_case (e.g., Channels → channels, DB → db). Adds new rendering options: render_event_as_text and render_event_text_key with mutual exclusivity note against render_event_as_xml. Includes corrected descriptions for rendering parameters and updates command-line/YAML/conf configuration examples.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

4.2.3

Suggested reviewers

• esmerel
• cosmo0920
• alexakreizinger

Poem

🐰 A hoppy hop through docs so fine,
Case conversions, all align!
New rendering paths now laid so clear,
Snake_case bounces, nice and dear! ✨

🚥 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 describes the main changes: adding render_event_as_text parameters and fixing table formatting in the winevtlog documentation.
Linked Issues check	✅ Passed	The PR successfully addresses all coding requirements from issue #2495: adds render_event_as_text and render_event_text_key parameters, corrects render_event_as_xml description, documents mutual exclusivity, and standardizes formatting.
Out of Scope Changes check	✅ Passed	All changes are directly related to issue #2495 requirements: documentation updates for winevtlog configuration parameters, parameter standardization, and formatting improvements within scope.
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

---

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.}

[eschabell]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

🧹 Nitpick comments (1)

pipeline/inputs/windows-event-log-winevtlog.md (1)

22-22: Consider using "username" for consistency with parameter name.

The parameter name is remote.username (one word), but the description uses "user name" (two words). Using "username" in the description would be more consistent with the parameter naming.

📝 Proposed fix for consistency

-| `remote.username`         | Specify user name of remote access for Windows EventLog.                                                                                                                                   | _none_   |
+| `remote.username`         | Specify username of remote access for Windows EventLog.                                                                                                                                     | _none_   |

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@pipeline/inputs/windows-event-log-winevtlog.md` at line 22, The description
for the parameter remote.username uses "user name" (two words); update the
description to use "username" (one word) to match the parameter naming and
maintain consistency—locate the entry referencing remote.username in the Windows
EventLog inputs doc and change the phrase "Specify user name of remote access
for Windows EventLog." to use "username" instead (and scan for other occurrences
of "user name" tied to remote.username to make the same change).

🤖 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/inputs/windows-event-log-winevtlog.md`:
- Line 22: The description for the parameter remote.username uses "user name"
(two words); update the description to use "username" (one word) to match the
parameter naming and maintain consistency—locate the entry referencing
remote.username in the Windows EventLog inputs doc and change the phrase
"Specify user name of remote access for Windows EventLog." to use "username"
instead (and scan for other occurrences of "user name" tied to remote.username
to make the same change).

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 35f56668-8fe7-4433-98b3-5428b06bdd65

📥 Commits

Reviewing files that changed from the base of the PR and between 55086ff and 51cf9e5.

📒 Files selected for processing (1)

• pipeline/inputs/windows-event-log-winevtlog.md