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.

Sign up for GitHub

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

Update README.md #125

Closed
wants to merge 1 commit into from
Closed

Update README.md #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions opentelemetry-etw-logs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,26 @@ captured by agents running locally and listening for specific ETW events.
[![Slack](https://img.shields.io/badge/slack-@cncf/otel/rust-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/archives/C03GDP0H023)

## Viewing ETW Logs

Logs exported to ETW can be viewed using tools like `logman`, `perfview` etc.
// TODO - add instructions.

#### Instructions using Powershell:
Copy link
Member

Choose a reason for hiding this comment

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

i dont think we need to duplicate the instructions from https://github.com/open-telemetry/opentelemetry-rust-contrib/blob/main/opentelemetry-etw-logs/examples/basic.rs#L7 to readme file.

It'd be better to use https://github.com/open-telemetry/opentelemetry-rust-contrib/blob/main/opentelemetry-etw-logs/src/lib.rs#L1 for documentation so it show up docs.rs .

1. Get the ETW Session Guid for the given provider (on this example `my-provider-name`):<br />
``PS> $EtwSessionGuid = (new-object System.Diagnostics.Tracing.EventSource("my-provider-name")).Guid.ToString()``
2. Start Logman session:<br />
```PS> logman create trace OtelETWExampleBasic -o OtelETWExampleBasic.log -p "{$EtwSessionGuid}" -f bincirc -max 1000```
```PS> logman start OtelETWExampleBasic```
3. Stop and Remove `logman` session:<br />
```PS> logman stop OtelETWExampleBasic```<br />
```PS> logman delete OtelETWExampleBasic```<br />
4. View the events with `perfview`:<br />
4.1. [Download PerView](https://github.com/microsoft/perfview/blob/main/documentation/Downloading.md):[PerfView releases](https://github.com/Microsoft/perfview/releases)
4.2. Open PerfView.
4.3. Go the location of the `.etl` file: `OtelETWExampleBasic.log_000001.etl` and open it.
4.4. Double-click `Events` in the left-panel.
4.5. Double-click the `my-provider-name/my-event-name` in the left-panel.
4.6. You should see the events in the right-panel.

## OpenTelemetry Overview

OpenTelemetry is an Observability framework and toolkit designed to create and
manage telemetry data such as traces, metrics, and logs. OpenTelemetry is
vendor- and tool-agnostic, meaning that it can be used with a broad variety of
Expand Down
Loading