Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ETW event manifest for high frequency events #3830

Draft
wants to merge 22 commits into
base: main
Choose a base branch
from

Conversation

mtfriesen
Copy link
Collaborator

@mtfriesen mtfriesen commented Sep 13, 2024

Description

Describe the purpose of and changes within this Pull Request.

eBPF is missing diagnostics on its hottest code paths, namely the program invocation APIs. These were intentionally missing for performance reasons, as the TraceLogging APIs are convenient for developers, but have relatively high CPU, memory, and log size footprints.

For maximum performance on these critical paths, add an ETW manifest and trace minimal entry/exit events. Install the manifest via MSI and include the .man file in the redist nuget. The ETW manifest uses the same GUID, provider name, and keyword mappings as the existing TraceLogging provider, which simplifies consumption of the events.

Resolves #3829

Testing

Do any existing tests cover this change? Are new tests needed?
Verified traces locally.

Documentation

Is there any documentation impact for this change?
N/A because the manifested events can be collected and consumed using the same techniques as existing TraceLogging.

Installation

Is there any installer impact for this change?
Yes.

@mtfriesen mtfriesen changed the title Manifest etw Add ETW event manifest for high frequency events Sep 16, 2024
@shankarseal
Copy link
Collaborator

The GettingStarted.md file mentions netsh trace convert for trace conversion. Now with ETW the document should be updated for the -manpath parameter.

@mtfriesen
Copy link
Collaborator Author

The GettingStarted.md file mentions netsh trace convert for trace conversion. Now with ETW the document should be updated for the -manpath parameter.

Good point. If eBPF is installed locally, then there is no need for the -manpath, but for developer/support scenarios, it is likely that eBPF will not be locally installed on dev boxes.

Signed-off-by: Alan Jowett <[email protected]>
@Alan-Jowett
Copy link
Member

@mtfriesen This PR appears to break the redirection logic in usersim that captures events written via TraceLog. All the test failure are because the tests is expecting tracelog events to be printed to console but none are showing up.

@saxena-anurag
Copy link
Contributor

@mtfriesen should we move this PR to draft, since this is not actively being worked on?

@shankarseal
Copy link
Collaborator

@mtfriesen if you are not planning to work on this PR, please abandon.

@Alan-Jowett Alan-Jowett marked this pull request as draft November 22, 2024 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add diagnostic events for eBPF extension entry points and exit points
4 participants