Skip to content

Commit 98fc1b8

Browse files
docs: minor additions and calirifications
1 parent 3c5eba7 commit 98fc1b8

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

content/learning-paths/laptops-and-desktops/windowsperf_wpa_plugin/windowsperf_wpa_plugin.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ weight: 2
66

77
# Overview
88

9+
WindpwsPerf WPA plugin is a plugin built for WPA that parses JSON output of `wperf` command line tool to visualize counting and telemetry events as timeline graphs.
10+
911
[**WindowsPerf**](https://github.com/arm-developer-tools/windowsperf) is a lightweight performance profiling tool inspired by Linux perf, specifically tailored for Windows on Arm.
10-
It leverages the Arm64 PMU (Performance Monitor Unit) and its hardware counters to offer precise profiling capabilities.
11-
The **WindowsPerf WPA plugin** bridges the gap between the detailed output of **WindowsPerf** and the powerful capabilities of **Windows Performance Analyzer**.
12+
It leverages the ARM64 PMU (Performance Monitor Unit) and its hardware counters to offer precise profiling capabilities.
13+
The [WindowsPerf WPA plugin](https://github.com/arm-developer-tools/windowsperf-wpa-plugin) bridges the gap between the detailed output of **WindowsPerf** and the powerful capabilities of [Windows Performance Analyzer](https://learn.microsoft.com/en-us/windows-hardware/test/wpt/windows-performance-analyzer).
1214

1315
## WindowsPerf WPA Plugin releases
1416

@@ -21,7 +23,9 @@ For installation instructions see the [install guide](/install-guides/windows-pe
2123
## Using WindowsPerf WPA Plugin
2224

2325
In order to use the `WindowsPerf WPA Plugin`, we first need to get a `.json` output from a WindowsPerf `wperf stat` command running on a Windows on Arm machine.
24-
> In order to get a `.json` output from WindowsPerf, we need to use the `--output` command followed by the filename.
26+
{{% notice Note%}}
27+
In order to get a `.json` output from WindowsPerf, we need to use the `--output` command followed by the filename.
28+
{{% /notice %}}
2529

2630
Example:
2731

@@ -32,7 +36,7 @@ wperf stat -e ld_spec --output example.json
3236
Upon opening Windows Performance Analyzer, we are greeted with the following window:
3337
![wpa-first-screen](figures/wpa-first-screen.png)
3438

35-
As we can see, the WindowsPerf WPA Plugin is installed correctly and it appears under the Installed Plugins section. We can then click on "Open file..." from the start menu on the left side and we're prompted to choose a `.json` file.
39+
As we can see, the `WindowsPerf WPA Plugin` is installed correctly and it appears under the Installed Plugins section. We can then click on "Open file..." from the start menu on the left side and we're prompted to choose a `.json` file.
3640

3741
![wpa-open-file](figures/wpa-open-file.png)
3842

@@ -41,6 +45,11 @@ By clicking "Open", the output file is then validated to check its format and co
4145

4246
### Timeline
4347

48+
The WindowsPerf timeline feature (command line option -t) enable continuous counting of Performance Monitoring Unit (PMU) events.
49+
Users can specify sleep intervals (with -i) between counts and set the number of repetitions (with -n), allowing for detailed and flexible data collection.
50+
Users can take advantage of the `WindowsPerf WPA Plugin` to visualize these complex measurements.
51+
This plugin allows for detailed graphical representation of the PMU event data in WPA.
52+
4453
For this example we will be running the following command:
4554

4655
```command
@@ -67,7 +76,7 @@ We can double click on any graph to expand it under the Analysis tab for further
6776

6877
### Telemetry
6978

70-
The WindowsPerf WPA Plugin also allows the visualization of telemetry metrics counted similarly to counting events.
79+
The `WindowsPerf WPA Plugin` also allows the visualization of [Arm telemetry metrics](https://developer.arm.com/documentation/109542/0100/About-Arm-CPU-Telemetry-Solution) counted similarly to counting events.
7180

7281
For this example, the following command was used:
7382

0 commit comments

Comments
 (0)