Skip to content

in_etw: Add a documentation for Event Tracing for Windows input plugin#2618

Open
cosmo0920 wants to merge 2 commits into
masterfrom
cosmo0920-add-docs-for-event-tracing-for-windows-plugin
Open

in_etw: Add a documentation for Event Tracing for Windows input plugin#2618
cosmo0920 wants to merge 2 commits into
masterfrom
cosmo0920-add-docs-for-event-tracing-for-windows-plugin

Conversation

@cosmo0920

@cosmo0920 cosmo0920 commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Corresponding PR is fluent/fluent-bit#12072.

Summary by CodeRabbit

  • Documentation
    • Added a new documentation page for the Windows Event Tracing (ETW) input, including supported event types, Windows-only availability, and permission/access guidance.
    • Documented configuration options for provider/session selection, ETW filtering, and buffer/flush tuning, plus the emitted log record schema and examples.
    • Updated main documentation navigation to include “Event tracing for Windows” and added a documentation redirect for the new page.

Signed-off-by: Hiroshi Hatake <hiroshi@chronosphere.io>
@cosmo0920 cosmo0920 requested review from a team and eschabell as code owners July 8, 2026 10:04
@coderabbitai

coderabbitai Bot commented Jul 8, 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: 2fa6be79-e0fa-41d8-ab46-e4f3615ba73d

📥 Commits

Reviewing files that changed from the base of the PR and between 725db94 and 79b7fb4.

📒 Files selected for processing (2)
  • SUMMARY.md
  • pipeline/inputs/event-tracing-windows.md
✅ Files skipped from review due to trivial changes (2)
  • SUMMARY.md
  • pipeline/inputs/event-tracing-windows.md

📝 Walkthrough

Walkthrough

This PR adds documentation for the Windows-only Event Tracing for Windows input plugin, including configuration, emitted fields, examples, and permissions guidance. It also adds navigation and redirect entries for the new page.

Changes

ETW Documentation Addition

Layer / File(s) Summary
Navigation and redirect wiring
SUMMARY.md, .gitbook.yaml
Adds a navigation entry and redirect mapping for the new ETW documentation page.
ETW plugin documentation content
pipeline/inputs/event-tracing-windows.md
Documents plugin configuration, emitted log-record fields, provider and kernel-session examples, and access requirements.

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

Suggested labels: 5.0

Suggested reviewers: lecaros, 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 main change: adding documentation for the Event Tracing for Windows input plugin.
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
  • Commit unit tests in branch cosmo0920-add-docs-for-event-tracing-for-windows-plugin

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.

Comment thread pipeline/inputs/event-tracing-windows.md Outdated
Comment thread pipeline/inputs/event-tracing-windows.md Outdated
Comment thread pipeline/inputs/event-tracing-windows.md Outdated
Comment thread pipeline/inputs/event-tracing-windows.md Outdated
Comment thread pipeline/inputs/event-tracing-windows.md Outdated
Comment thread pipeline/inputs/event-tracing-windows.md Outdated
Comment thread pipeline/inputs/event-tracing-windows.md Outdated
Comment thread pipeline/inputs/event-tracing-windows.md Outdated
Comment thread pipeline/inputs/event-tracing-windows.md Outdated
Comment thread pipeline/inputs/event-tracing-windows.md

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@pipeline/inputs/event-tracing-windows.md`:
- Line 35: Clarify the provider identity validation in the event tracing Windows
docs: the check should compare the resolved provider GUID against the configured
provider_guid, not the provider name. Update the wording around the provider
session rules so it explicitly says provider_guid, provider_name, or both may be
set, and if both are set the resolved GUID must match the configured GUID; use
the provider/session terminology consistently in this section.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c1edbe88-8e57-4906-a1df-b70b4cda3510

📥 Commits

Reviewing files that changed from the base of the PR and between 8892466 and f2773b5.

📒 Files selected for processing (3)
  • .gitbook.yaml
  • SUMMARY.md
  • pipeline/inputs/event-tracing-windows.md

Comment thread pipeline/inputs/event-tracing-windows.md Outdated
eschabell added a commit that referenced this pull request Jul 10, 2026
Clean up Vale suggestions on the new Event Tracing for Windows input
plugin doc:

  - Use sentence-style capitalization for the page title and sync
    matching SUMMARY.md navigation entry.
  - Wrap bare "GUID" references in backticks so the FluentBit.Acronyms
    rule no longer flags them

Applies to #2618

Signed-off-by: Eric D. Schabell <eric@schabell.org>
Comment thread pipeline/inputs/event-tracing-windows.md Outdated
Comment thread pipeline/inputs/event-tracing-windows.md Outdated
eschabell added a commit that referenced this pull request Jul 10, 2026
Clean up Vale suggestions on the new Event Tracing for Windows input
plugin doc:

  - Use sentence-style capitalization for the page title and sync
    matching SUMMARY.md navigation entry.
  - Wrap bare "GUID" references in backticks so the FluentBit.Acronyms
    rule no longer flags them and table alignments

Applies to #2618

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the cosmo0920-add-docs-for-event-tracing-for-windows-plugin branch from 17651ee to 725db94 Compare July 10, 2026 14:45
Clean up Vale suggestions on the new Event Tracing for Windows input
plugin doc:

  - Use sentence-style capitalization for the page title and sync
    matching SUMMARY.md navigation entry.
  - Wrap bare "GUID" references in backticks so the FluentBit.Acronyms
    rule no longer flags them and table alignments
  - Classic config keys → Title_Case

Applies to #2618

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the cosmo0920-add-docs-for-event-tracing-for-windows-plugin branch from 725db94 to 79b7fb4 Compare July 10, 2026 15:28

@eschabell eschabell left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cosmo0920 fixed a bunch of formatting issues, now just waiting on code PR merging. Thanks for the docs PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants