Skip to content

Commit

Permalink
add no root requirements for metrics to readme (#91)
Browse files Browse the repository at this point in the history
  • Loading branch information
harp-intel authored Nov 9, 2024
1 parent 8ed7549 commit 2072bac
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,14 @@ Metric files:
```
The `metrics` command supports two modes -- default and "live". Default mode behaves as above -- metrics are collected and saved into files for review. The "live" mode prints the metrics in a selected format, e.g., CSV, JSON, to stdout where they can be viewed in the console and/or redirected into a file or observability pipeline.

##### No Root Permissions
If sudo is not possible and running as the root user is not possible, then a user may request the following changes be made to the target system by an administrator:
- sysctl -w kernel.perf_event_paranoid=0
- sysctl -w kernel.nmi_watchdog=0
- write '125' to all perf_event_mux_interval_ms files found under /sys/devices/*, e.g., `for i in $(find /sys/devices -name perf_event_mux_interval_ms); do echo 125 > $i; done`

Recommend returning these settings to their prior values when analysis with PerfSpect is complete.

See `perfspect metrics -h` for the extensive set of options and examples.

#### Report Command
Expand Down

0 comments on commit 2072bac

Please sign in to comment.