Skip to content

docs: pipeline: inputs: winevtlog: document event_data_as_map option#2620

Merged
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_in_win_event_winvtlog_updates
Jul 13, 2026
Merged

docs: pipeline: inputs: winevtlog: document event_data_as_map option#2620
eschabell merged 1 commit into
fluent:masterfrom
eschabell:erics_in_win_event_winvtlog_updates

Conversation

@eschabell

@eschabell eschabell commented Jul 11, 2026

Copy link
Copy Markdown
Collaborator

Document the event_data_as_map and event_template_cache_size options added to the in_winevtlog plugin, which emit EventData as a named map built from provider metadata instead of string inserts.

Note, code commit 6b005e6c4 without corresponding docs PR.

Summary by CodeRabbit

  • Documentation
    • Documented the event_data_as_map option for Windows Event Log input.
    • Explained how event data is represented as a field-name keyed map when enabled.
    • Added configuration requirements and YAML/config-file examples.
    • Clarified the relationship with template cache sizing and related validation behavior.

Document the event_data_as_map and event_template_cache_size options
added to the in_winevtlog plugin, which emit EventData as a named map
built from provider metadata instead of string inserts.

Note, code commit 6b005e6c4 without corresponding docs PR.

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

coderabbitai Bot commented Jul 11, 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: 432bdb63-7638-4264-9790-154b68594707

📥 Commits

Reviewing files that changed from the base of the PR and between a391227 and 87b2fc8.

📒 Files selected for processing (1)
  • pipeline/inputs/windows-event-log-winevtlog.md

📝 Walkthrough

Walkthrough

The winevtlog input documentation adds the event_data_as_map parameter, explains its dependency on event_template_cache_size, and provides YAML and configuration-file examples.

Changes

winevtlog EventData map

Layer / File(s) Summary
Document EventData map configuration
pipeline/inputs/windows-event-log-winevtlog.md
The parameter table and new section describe named EventData mapping, the required positive template cache size, and example configurations.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested labels: 5.0

Suggested reviewers: patrick-stephens

🚥 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 clearly matches the doc update for the new event_data_as_map option.
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 ready for review and I've added the exact triggering code commit for you!

@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Jul 13, 2026
@eschabell eschabell merged commit e913342 into fluent:master Jul 13, 2026
8 checks passed
@eschabell eschabell deleted the erics_in_win_event_winvtlog_updates branch July 13, 2026 15:09
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