You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/install-guides/windows-perf-wpa-plugin.md
+11-23Lines changed: 11 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,16 +33,12 @@ layout: installtoolsall # DO NOT MODIFY. Always true for tool install articles
33
33
It leverages the ARM64 PMU (Performance Monitor Unit) and its hardware counters to offer precise profiling capabilities.
34
34
The **WindowsPerf WPA plugin** bridges the gap between the detailed output of **WindowsPerf** and the powerful capabilities of **Windows Performance Analyzer**.
35
35
36
-
The plugin is built on the [`microsoft-performance-toolkit-sdk`](https://github.com/microsoft/microsoft-performance-toolkit-sdk)
37
-
and is shipped as a single `.dll` file.
36
+
The plugin is built on the [`microsoft-performance-toolkit-sdk`](https://github.com/microsoft/microsoft-performance-toolkit-sdk) and is shipped as a single `.dll` file.
38
37
39
38
40
-
**Windows Performance Analyzer (WPA)** is a tool that creates graphs and data tables of Event Tracing for Windows (ETW) events
41
-
that are recorded by Windows Performance Recorder (WPR), Xperf, or an assessment that is run in the
42
-
Assessment Platform. WPA can open any event trace log (ETL) file for analysis.
39
+
**Windows Performance Analyzer (WPA)** is a tool that creates graphs and data tables of Event Tracing for Windows (ETW) events that are recorded by Windows Performance Recorder (WPR), Xperf, or an assessment that is run in the Assessment Platform. WPA can open any event trace log (ETL) file for analysis.
43
40
44
-
WPA's capabilities can be expanded upon using the `microsoft-performance-toolkit-sdk` by creating
45
-
plugins which enables parsing any type of data (`.json` in this case).
41
+
WPA's capabilities can be expanded upon using the `microsoft-performance-toolkit-sdk` by creating plugins which enables parsing any type of data (`.json` in this case).
46
42
47
43
48
44
## A Glimpse of the available features
@@ -58,48 +54,40 @@ The WindowsPerf GUI extension is composed of several key features, each designed
58
54
## Getting Started
59
55
### Installation
60
56
61
-
WPA is included in the Windows Assessment and Deployment Kit (Windows ADK)
62
-
that can be downloaded [here](https://go.microsoft.com/fwlink/?linkid=2243390).
57
+
WPA is included in the Windows Assessment and Deployment Kit (Windows ADK) that can be downloaded [here](https://go.microsoft.com/fwlink/?linkid=2243390).
63
58
64
59
> The wperf WPA plugin requires a WPA version of `11.0.7.2` or higher.
65
60
66
-
Once downloaded, make sure that "Windows Performance Toolkit" checkbox is
67
-
checked under "Select the features you want to install/change".
61
+
Once downloaded, make sure that "Windows Performance Toolkit" checkbox is checked under "Select the features you want to install/change".
68
62
69
63

70
64
71
65
The plugin can be downloaded from the [releases page](https://github.com/arm-developer-tools/windowsperf-wpa-plugin/releases).
72
66
73
67
To install the plugin you have the option between:
74
68
75
-
- Moving the plugin dll to the **CustomDataSources** directory next
76
-
to the WPA executable (defaults to `C:\\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\CustomDataSources`).
69
+
- Moving the plugin dll to the **CustomDataSources** directory next to the WPA executable (defaults to `C:\\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit\CustomDataSources`).
77
70
- Setting up the `WPA_ADDITIONAL_SEARCH_DIRECTORIES` env variable and moving the dll to that directory
78
-
- Calling `wpa` from the command line and passing the plugin directory
79
-
to the `-addsearchdir` flag (example : `wpa -addsearchdir "%USERPROFILE%\plugins"`).
71
+
- Calling `wpa` from the command line and passing the plugin directory to the `-addsearchdir` flag (example : `wpa -addsearchdir "%USERPROFILE%\plugins"`).
80
72
81
73
<img
82
74
src="_images/about-wpa.png"
83
75
alt="About WPA"
84
76
style="display: block; margin: 0 auto"
85
77
/>
86
78
87
-
> To verify that the plugin is loaded successfully, launch WPA then the plugin
88
-
should appear under Help > About Windows Performance Analyzer.
79
+
> To verify that the plugin is loaded successfully, launch WPA then the plugin should appear under Help > About Windows Performance Analyzer.
89
80
90
81
91
82
### Running from the command line
92
83
93
84
After installing WPA, it should be added automatically to the path environnment variable.
94
-
If it's not the case, add the WPA directory (defaults to `C:\\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit`)
95
-
to your environnment variable.
85
+
If it's not the case, add the WPA directory (defaults to `C:\\Program Files (x86)\Windows Kits\10\Windows Performance Toolkit`) to your environnment variable.
96
86
97
87
98
-
To open a json file directly from the command line, you can use the `-i` flag to specify the
99
-
file path to open.
88
+
To open a json file directly from the command line, you can use the `-i` flag to specify the file path to open.
100
89
101
-
Example: to open a `timeline_long.json` that sits in the Downloads directory, run the following
102
-
command in the command line:
90
+
Example: to open a `timeline_long.json` that sits in the Downloads directory, run the following command in the command line:
0 commit comments