From d17490a75ab8aa6b5cbc188982a1f6b5f2a48d81 Mon Sep 17 00:00:00 2001 From: "Harper, Jason M" Date: Sat, 9 Nov 2024 06:35:30 -0800 Subject: [PATCH] add no root requirements for metrics to readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index d39ee4a..5ed675f 100644 --- a/README.md +++ b/README.md @@ -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