Skip to content

Update WindowsPerf + WPA plugin docs #1409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Update WindowsPerf + WPA plugin docs #1409

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions ...ing-paths/laptops-and-desktops/windowsperf_wpa_plugin/windowsperf_wpa_plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ You can save a `.json` output from WindowsPerf by using the `--output` command f
To create a file named `example.json`, run the following command:

```console
wperf stat -e ld_spec --output example.json
wperf stat -e ld_spec --timeout 5 --json --output example.json
```

2. Open Windows Performance Analyzer, and see the following window:
Expand Down Expand Up @@ -54,9 +54,11 @@ You can use WPA to visualize PMU events in the recorded data.
To try the timeline feature, run the command:

```command
wperf stat -m dcache -c 0,1,2,3,4,5,6,7 -t -i 0 -n 50 --json
wperf stat -m dcache -c 0,1,2,3,4,5,6,7 -t -i 0 -n 10 --timeout 2 --json --output example2.json
```

Note: above command will run for ~20 seconds.

Open the generated output (`.json` file) in WPA to see the graph:

![timeline-by-core #center](figures/timeline-by-core.png)
Expand All @@ -72,9 +74,11 @@ To see all the generated graphs you can expand the `Counting timeline` section i
Run another `wperf` command with different options:

```console
wperf stat -t -i 0 -m imix,l1d_cache_miss_ratio,l1d_cache_mpki,l1d_tlb_miss_ratio,l1d_tlb_mpki -e inst_spec,vfp_spec,ld_spec,st_spec -c 1 --json
wperf stat -t -i 0 -n 10 -m imix,l1d_cache_miss_ratio,l1d_cache_mpki,l1d_tlb_miss_ratio,l1d_tlb_mpki -e inst_spec,vfp_spec,ld_spec,st_spec -c 1 --timeout 2 --json --output --example3.json
```

Note: above command will run for ~20 seconds.

The graph after opening the `.json` file is shown below:

![timeline-events-by-key #center](figures/timeline-events-by-key.png)
Expand All @@ -88,9 +92,11 @@ The WPA Plugin also provides visualization of [Arm telemetry metrics](https://de
To visualize telemetry, run the following command:

```console
wperf stat -t -i 0 -m imix,l1d_cache_miss_ratio,l1d_cache_mpki,l1d_tlb_miss_ratio,l1d_tlb_mpki -e inst_spec,vfp_spec,ld_spec,st_spec -c 1 --json
wperf stat -t -i 0 -n 10 -m imix,l1d_cache_miss_ratio,l1d_cache_mpki,l1d_tlb_miss_ratio,l1d_tlb_mpki -e inst_spec,vfp_spec,ld_spec,st_spec -c 1 --timeout 2 --json --output example4.json
```

Note: above command will run for ~20 seconds.

You can also see the telemetry timeline graphs under the graph explorer level in WPA.

These graphs are generated dynamically so only the relevant metrics for the given `.json` output file are visible.
Expand All @@ -101,4 +107,4 @@ Once expanded, a more in-depth view is visible under the Analysis tab of WPA.

![telemetry-table #center](figures/telemetry-table.png)

You now have a basic understanding of how to use `wperf` generated data in the Windows Performance Analyzer.
You now have a basic understanding of how to use `wperf` generated data in the Windows Performance Analyzer.