Skip to content

Commit cea353d

Browse files
authored
document --noroot option for metrics (#92)
1 parent 905510d commit cea353d

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,13 +71,11 @@ Metric files:
7171
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.
7272

7373
##### No Root Permissions
74-
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:
74+
If sudo is not possible and running as the root user is not possible, use the `--noroot` flag on the command line, e.g., `perfspect metrics --noroot`, and request an administrator make the following changes to the target system:
7575
- sysctl -w kernel.perf_event_paranoid=0
7676
- sysctl -w kernel.nmi_watchdog=0
7777
- 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`
7878

79-
Recommend returning these settings to their prior values when analysis with PerfSpect is complete.
80-
8179
See `perfspect metrics -h` for the extensive set of options and examples.
8280

8381
#### Report Command

0 commit comments

Comments
 (0)