Skip to content

Commit

Permalink
Modify README for perf lock
Browse files Browse the repository at this point in the history
  • Loading branch information
TianyouLi authored and harp-intel committed Dec 10, 2024
1 parent 128ff8f commit 1e0ffe7
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Svr-info functionality is now included in PerfSpect. The svr-info configuration
| ------- | ----------- |
| [`perfspect config`](#config-command) | Modify system configuration |
| [`perfspect flame`](#flame-command) | Generate flamegraphs |
| [`perfspect lock`](#lock-command) | Collect system wide hotspot, c2c and lock contention information |
| [`perfspect metrics`](#metrics-command) | Monitor core and uncore metrics |
| [`perfspect report`](#report-command) | Generate configuration report |
| [`perfspect telemetry`](#telemetry-command) | Collect system telemetry |
Expand All @@ -55,6 +56,10 @@ $ ./perfspect config --cores 24 --llc 2.0 --uncoremaxfreq 1.8
```
#### Flame Command
Software flamegraphs are useful in diagnosing software performance bottlenecks. Run `perfspect flame -h` to capture a system-wide software flamegraph.

#### Lock Command
As system contains more and more cores, it would be usuful to be able to analyze the kernel lock overhead and potential false-sharing that impact the overall system scalability. Run `perfspect lock -h` to collect system wide hotspot, c2c and lock contention information, that will be helpful for experienced performance engineers to have a chance to look into the related problems.

#### Metrics Command
The `metrics` command provides system performance characterization metrics. The metrics provided are dependent on the platform architecture.

Expand Down Expand Up @@ -186,4 +191,4 @@ $ ./perfspect report --benchmark speed,memory --targets targets.yaml
`builder/build.sh` builds the dependencies and the app in Docker containers that provide the required build environments. Assumes you have Docker installed on your development system.

### Subsequent Builds
`make` builds the app. Assumes the dependencies have been built previously and that you have Go installed on your development system.
`make` builds the app. Assumes the dependencies have been built previously and that you have Go installed on your development system.

0 comments on commit 1e0ffe7

Please sign in to comment.