Skip to content

Commit bba2579

Browse files
Merge pull request #1394 from jasonrandrews/review
Update WPA plugin install guide
2 parents ad9dba5 + acf0e26 commit bba2579

File tree

4 files changed

+31
-31
lines changed

4 files changed

+31
-31
lines changed
87.3 KB
Loading
-377 Bytes
Loading
124 KB
Loading

content/install-guides/windows-perf-wpa-plugin.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
---
22
title: Windows Performance Analyzer (WPA) plugin
33

4-
draft: true
5-
cascade:
6-
draft: true
7-
84
minutes_to_complete: 15
95

106
official_docs: https://github.com/arm-developer-tools/windowsperf-wpa-plugin
@@ -34,7 +30,7 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
3430

3531
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.
3632

37-
Windows Performance Analyzer is a useful tool that supports 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:
33+
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:
3834
- Windows Performance Recorder (WPR)
3935
- Xperf
4036
- or through an assessment that's run in the Assessment Platform.
@@ -61,72 +57,76 @@ The telemetry view displays telemetry events grouped by unit:
6157

6258
## How do I install the WPA plugin?
6359

64-
Before installing the plugin, you need to make sure you have installed WPA:
60+
Before installing the plugin, you need to install WPA.
6561

6662
### Install WPA
6763

68-
WPA is included in the Windows Assessment and Deployment Kit (Windows ADK), which you can download from [Microsoft](https://go.microsoft.com/fwlink/?linkid=2243390).
64+
For Windows on Arm devices, you can install WPA from the Microsoft Store.
6965

70-
{{% notice Note %}}
71-
The WPA plugin requires WPA version `11.0.7.2` or higher.
72-
{{% /notice %}}
66+
Open the Microsoft Store and search for "windows performance analyzer".
7367

74-
Run the downloaded `adksetup.exe` program.
68+
![WPA store](/install-guides/_images/wpa-store.png)
7569

76-
Specify the default installation location and accept the license agreement.
70+
Hover over the card, and the "Free" button will become a "Get" button. Click the "Get" button to start installation.
7771

78-
Make sure that **Windows Performance Toolkit** is checked under **Select the features you want to install**.
72+
Wait for WPA to be installed, and launch it from the Windows menu.
7973

80-
![WPA Installation](/install-guides/_images/wpa-installation.png)
74+
![WPA installation #center](/install-guides/_images/wpa-installation.png)
8175

82-
Finally, click **Install**.
76+
{{% notice Note %}}
77+
The WPA plugin requires WPA version `11.0.7.2` or higher. You can check the version by clicking `Help` -> `About Windows Performance Analyzer`.
78+
{{% /notice %}}
79+
80+
Close Windows Performance Analyzer.
8381

8482
### Install the WPA plugin
8583

86-
Now you're ready to install the plugin, which is a single `.dll` file.
84+
You are ready to install the WPA plugin, which is a single `.dll` file.
8785

8886
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.
8987

90-
Alternatively, you can download the latest version using command prompt:
88+
Alternatively, you can download the `.zip` file from a Command Prompt:
9189

9290
```console
9391
mkdir wpa-plugin
9492
cd wpa-plugin
9593
curl -L -O https://github.com/arm-developer-tools/windowsperf-wpa-plugin/releases/download/1.0.2/wpa-plugin-1.0.2.zip
9694
```
9795

98-
Now extract the `.dll` file from the downloaded `.zip` file.
96+
Extract the `.dll` file from the downloaded `.zip` file.
9997

10098
```console
10199
tar -xmf wpa-plugin-1.0.2.zip
102100
```
103101

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

106-
There are three ways you can install the `WPAPlugin.dll` file:
104+
There are three ways you can use the `WPAPlugin.dll` file:
107105

108-
#### 1. Copy the .dll file to the CustomDataSources directory next to the WPA executable.
106+
#### 1. Start WPA from the command line and pass the plugin directory location using a flag.
109107

110-
The default location is:
111-
`C:\\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\CustomDataSources`
108+
Use the `-addsearchdir` flag to tell `wpa` where to find plugins.
109+
110+
For example, if you downloaded the DLL in your `Downloads` directory, you can run `wpa` as shown below:
112111

112+
```bash
113+
wpa -addsearchdir %USERPROFILE%\Downloads\wpa-plugin-1.0.2
114+
```
115+
113116
#### 2. Set an environment variable.
114117

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

117-
#### 3. Start WPA from the command line and pass the plugin directory location using a flag.
120+
#### 3. Copy the .dll file to the CustomDataSources directory next to the WPA executable.
118121

119-
Use the `-addsearchdir` flag for `wpa`:
122+
The default location is:
123+
`C:\\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\CustomDataSources`
120124

121-
```bash
122-
wpa -addsearchdir "%USERPROFILE%\plugins"
123-
```
124-
125125
## How can I verify the WPA plugin is installed?
126126

127-
To verify the plugin is loaded, launch WPA and the plugin should appear under **Help > About Windows Performance Analyzer**.
127+
To verify the plugin is loaded, launch WPA and the plugin should appear on the Installed Plugins list.
128128

129-
![WPA installation confirmation](/install-guides/_images/about-wpa.png)
129+
![WPA installation confirmation](/install-guides/_images/wpa-install-plugin.png)
130130

131131
## How can I run the WPA plugin from the command line?
132132

@@ -135,7 +135,7 @@ To open a JSON file directly from the command line, you can use the `-i` flag to
135135
For example: to open `timeline_long.json` in your downloads directory, run the command:
136136

137137
```console
138-
wpa -i "%USERPROFILE%\\Downloads\\timeline_long.json"
138+
wpa -addsearchdir %USERPROFILE%\Downloads\wpa-plugin-1.0.2 -i %USERPROFILE%\Downloads\timeline_long.json
139139
```
140140
## How do I uninstall the WPA plugin?
141141

0 commit comments

Comments
 (0)