Skip to content

Commit

Permalink
Merge pull request #1396 from madeline-underwood/Windows-Perf-WPA-plugin
Browse files Browse the repository at this point in the history
Editorial review of update_to be approved
  • Loading branch information
jasonrandrews authored Nov 21, 2024
2 parents 9a9b50d + 4f06236 commit d416a94
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions content/install-guides/windows-perf-wpa-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,17 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
The Windows Performance Analyzer (WPA) plugin connects [WindowsPerf](/learning-paths/laptops-and-desktops/windowsperf/) to the Windows Performance Analyzer. Windows Perf is a lightweight performance profiling tool inspired by Linux Perf and designed for Windows on Arm.

Windows Performance Analyzer provides developers with diagnostics and performance tuning. It generates data tables and graphs of Event Tracing for Windows (ETW) events, which are recorded in one of three ways:
- Windows Performance Recorder (WPR)
- Xperf
- or through an assessment that's run in the Assessment Platform.
- By using Windows Performance Recorder (WPR).
- By using Xperf.
- Through an assessment that is run in the Assessment Platform.

WPA can open event trace log (ETL) files, which you can use for analysis.
WPA can open Event Trace Log (ETL) files, which you can use for analysis.

The WPA plugin is built using the [Microsoft Performance Toolkit SDK](https://github.com/microsoft/microsoft-performance-toolkit-sdk), a collection of tools to create and extend performance analysis applications. The plugin parses JSON output from Windows Perf so that it can be visualized in WPA.
The WPA plugin is built using the [Microsoft Performance Toolkit SDK](https://github.com/microsoft/microsoft-performance-toolkit-sdk), which is a collection of tools to create and extend performance analysis applications. The plugin parses JSON output from Windows Perf so that it can be visualized in WPA.

## What are some of the features of the WPA plugin?
## What are the features of the WPA plugin?

The WindowsPerf GUI extension includes features, which are designed to streamline the user experience:
The WindowsPerf GUI extension includes features that are designed to streamline the user experience, and these are detailed below.

### Timeline view

Expand All @@ -67,25 +67,25 @@ Open the Microsoft Store and search for "windows performance analyzer".

![WPA store](/install-guides/_images/wpa-store.png)

Hover over the card, and the "Free" button will become a "Get" button. Click the "Get" button to start installation.
Hover over the card, and you will see that the **Free** button becomes a **Get** button. Click the **Get** button to start the installation.

Wait for WPA to be installed, and launch it from the Windows menu.
Wait for WPA to be installed, and then launch it from the Windows menu.

![WPA installation #center](/install-guides/_images/wpa-installation.png)

{{% notice Note %}}
The WPA plugin requires WPA version `11.0.7.2` or higher. You can check the version by clicking `Help` -> `About Windows Performance Analyzer`.
The WPA plugin requires WPA version `11.0.7.2` or higher. You can check the version by clicking **Help** > **About Windows Performance Analyzer**.
{{% /notice %}}

Close Windows Performance Analyzer.

### Install the WPA plugin

You are ready to install the WPA plugin, which is a single `.dll` file.
You are now ready to install the WPA plugin, which is a single `.dll` file.

Download the `.zip` file from the [Windows Perf WPA plugin GitHub releases page](https://github.com/arm-developer-tools/windowsperf-wpa-plugin/releases) on GitHub.

Alternatively, you can download the `.zip` file from a Command Prompt:
Alternatively, you can download the `.zip` file from a command prompt:

```console
mkdir wpa-plugin
Expand All @@ -101,28 +101,28 @@ tar -xmf wpa-plugin-1.0.2.zip

The file `WPAPlugin.dll` is now in your `wpa-plugin` directory.

There are three ways you can use the `WPAPlugin.dll` file:
There are three ways that you can use the `WPAPlugin.dll` file:

#### 1. Start WPA from the command line and pass the plugin directory location using a flag.
##### Option 1: Start WPA from the command line and pass the plugin directory location using a flag.

Use the `-addsearchdir` flag to tell `wpa` where to find plugins.

For example, if you downloaded the DLL in your `Downloads` directory, you can run `wpa` as shown below:
For example, if you downloaded the `.dll` in your `Downloads` directory, you can run `wpa` as shown below:

```bash
wpa -addsearchdir %USERPROFILE%\Downloads\wpa-plugin-1.0.2
```
#### 2. Set an environment variable.
##### Option 2: Set an environment variable.

Set the `WPA_ADDITIONAL_SEARCH_DIRECTORIES` environment variable to the location of the `.dll` file.

#### 3. Copy the .dll file to the CustomDataSources directory next to the WPA executable.
##### Option 3: Copy the `.dll` file to the `CustomDataSources` directory next to the WPA executable.

The default location is:
`C:\\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\CustomDataSources`

## How can I verify the WPA plugin is installed?
## How can I verify that the WPA plugin is installed?

To verify the plugin is loaded, launch WPA and the plugin should appear on the Installed Plugins list.

Expand All @@ -132,12 +132,12 @@ To verify the plugin is loaded, launch WPA and the plugin should appear on the I

To open a JSON file directly from the command line, you can use the `-i` flag to specify the file path to open.

For example: to open `timeline_long.json` in your downloads directory, run the command:
For example, to open `timeline_long.json` in your `downloads` directory, run the command:

```console
wpa -addsearchdir %USERPROFILE%\Downloads\wpa-plugin-1.0.2 -i %USERPROFILE%\Downloads\timeline_long.json
```
## How do I uninstall the WPA plugin?

To uninstall the plugin simply delete the `WPAPlugin.dll` file.
To uninstall the plugin, simply delete the `WPAPlugin.dll` file.

0 comments on commit d416a94

Please sign in to comment.