Skip to content

Commit

Permalink
Initial WPA Instructions (#1167)
Browse files Browse the repository at this point in the history
  • Loading branch information
nibanks authored Jan 17, 2021
1 parent ae23d37 commit 7cea98f
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions src/plugins/wpa/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
This page provides the install, setup and usage instructions for Windows Performance Analyzer (WPA) and use it to analyze MsQuic traces.

# Install Instructions

The following are currently only possible on Windows. Other platforms may be supported by WPA in the future.

## Install WPA

1. Download the latest the [ADK Preview](https://www.microsoft.com/en-us/software-download/windowsinsiderpreviewADK) to get the Windows Performance Toolkit (WPT).
- Note: In the future, the WPA team plans to make it easier to install WPA outside of the ADK
2. Install the Windows Performance Toolkit ![](images/ADK_WPT.jpg)
3. Verify that this WPA version supports plugins
- In Command Prompt
```dos
"C:\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\wpa.exe" /?
```
- Verify that these 2 command line WPA options are supported:
- OPTIONS: **-addsearchdir PATH**. Adds a directory path to the plugin search path. ....
- ENVIRONMENT VARIABLES: **WPA_ADDITIONAL_SEARCH_DIRECTORIES** - A semicolon (;) delimited list of additional directories to search for plugins. Equivalent to the -addsearchdir option.
## Install MsQuic WPA Plugin
1. Build the plugin via `QuicEventDataSource.csproj` or download it from the latest release (i.e. [v1.0.0](https://github.com/microsoft/msquic/releases/download/v1.0.0-129524/quic.wpa.zip)).
2. Update/create your WPA shortcut by adding `-addsearchdir <path_to_quic_plugin_folder>`.
# Usage Instructions
**TODO**
Binary file added src/plugins/wpa/images/ADK_WPT.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7cea98f

Please sign in to comment.