Skip to content

Commit

Permalink
Improve logging docs (microsoft#1893)
Browse files Browse the repository at this point in the history
* Add note to documentation about passing alternate manifest to netsh

* Add docs for clog2txt_lttng
  • Loading branch information
thhous-msft authored Aug 10, 2021
1 parent 97f1fd8 commit e7f66d0
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/Diagnostics.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ To convert the trace, you can use the following command:
netsh.exe trace convert quic.etl
```

> **Important** - If you're using a version of MsQuic that uses an ETW manifest version more recent than the one built into the Windows image, decoding may not provide correct output. **TODO** - Provide instructions to get around this problem.
If you're using a version of MsQuic that uses an ETW manifest version more recent than the one built into the Windows image, decoding may not provide correct output. To solve this issue, newer versions of Windows (11 and Server 2022) support a `manpath` flag that can be used to manually specify a manifest. This will likely always be needed for apps using MsQuic in user mode.

```
netsh.exe trace convert quic.etl manpath=path/to/manifest/MsQuicEtw.man
```

You may also open the trace in Windows Performance Analyzer. See the [WPA instructions](../src/plugins/trace/README.md) for more details.

Expand Down Expand Up @@ -70,6 +74,8 @@ You must replace `ETL_PATH` with the path of the output ETL file that you want t

On Linux, MsQuic leverages [LTTng](https://lttng.org/features/) for its logging.

Some dependencies, such as babeltrace, lttng, and clog2text_lttng are required. These can be installed by running `./scripts/prepare-machine.ps1 -Configuration Test`

To start collecting a trace, you can use the following commands:

```
Expand Down

0 comments on commit e7f66d0

Please sign in to comment.