diff --git a/agent/tool-scripts/base-tool b/agent/tool-scripts/base-tool index 61f42ea158..c96632d921 100755 --- a/agent/tool-scripts/base-tool +++ b/agent/tool-scripts/base-tool @@ -191,17 +191,26 @@ esac function usage { printf -- "The following options are available:\n\n" + printf -- "Operational options - do *not* specify any of these when you register a tool:\n\n" printf -- "\t--install verify this perf tool will work\n\n" printf -- "\t--start|stop|postprocess start/stop/postprocess the data collection\n" printf -- "\t-d str|--dir=str directory to store data collection (required)\n" + + printf -- "\nTool-specific options - these should be specified when you register a tool:\n\n" + case "${tool}" in - blktrace|bpftrace|kvmtrace|lockstat|oc|perf|strace|systemtap|tcpdump) - : # These tools don't use interval + lockstat) + : # Tools that don't take *any* tool-specific options + printf -- "\tNo tool-specific options for this tool\n" + ;; + blktrace|bpftrace|kvmtrace|oc|perf|strace|systemtap|tcpdump) + : # Tools that don't use '--interval' but take other tool-specific options ;; *) printf -- "\t--interval=int number of seconds between each data collection (optional, default is %s seconds)\n" "${def_interval}" ;; esac + case "${tool}" in blktrace) printf -- "\t--devices=str,[str] the list of block devices to trace (required w/ --start)\n" @@ -278,7 +287,9 @@ function usage { printf -- "\t but not both at the same time\n" ;; esac - printf -- "\n\t-h|--help display this help message\n" + + printf -- "\nHelp option - do *not* specify this when you register a tool:\n\n" + printf -- "\t-h|--help display this help message\n\n" } # Process options and arguments @@ -582,7 +593,7 @@ install) local _installed_rpm local _rc _installed_rpm="$(require-rpm "${_tpn}" "${_tpv}")" - _rc=${?} + _rc=${?} if [[ ${_rc} != 0 ]]; then printf -- "%s: %s is not installed\n" "${tool}" "${_tpn}${_tpv:+-${_tpv}}" >&2 else diff --git a/agent/tool-scripts/tests/blktrace/gold/stderr b/agent/tool-scripts/tests/blktrace/gold/stderr index 0035b002b4..8bd3aa8dbb 100644 --- a/agent/tool-scripts/tests/blktrace/gold/stderr +++ b/agent/tool-scripts/tests/blktrace/gold/stderr @@ -2,12 +2,20 @@ blktrace: Error, one of the following options is required, --install|--start|--s The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --devices=str,[str] the list of block devices to trace (required w/ --start) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + blktrace: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/blktrace/tools-group/blktrace', missing blktrace: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/blktrace/tools-group/blktrace', missing diff --git a/agent/tool-scripts/tests/bpftrace/gold/stderr b/agent/tool-scripts/tests/bpftrace/gold/stderr index 5a8d218c6c..160d32ec4b 100644 --- a/agent/tool-scripts/tests/bpftrace/gold/stderr +++ b/agent/tool-scripts/tests/bpftrace/gold/stderr @@ -2,12 +2,20 @@ bpftrace: Error, one of the following options is required, --install|--start|--s The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --script=str path to the bpftrace script (required w/ --start) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + bpftrace: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/bpftrace/tools-group/bpftrace', missing bpftrace: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/bpftrace/tools-group/bpftrace', missing diff --git a/agent/tool-scripts/tests/cpuacct/gold/stderr b/agent/tool-scripts/tests/cpuacct/gold/stderr index 3f5a10e7d5..a4e9172b6d 100644 --- a/agent/tool-scripts/tests/cpuacct/gold/stderr +++ b/agent/tool-scripts/tests/cpuacct/gold/stderr @@ -2,12 +2,20 @@ cpuacct: Error, one of the following options is required, --install|--start|--st The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + cpuacct: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/cpuacct/tools-group/cpuacct', missing cpuacct: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/cpuacct/tools-group/cpuacct', missing diff --git a/agent/tool-scripts/tests/disk/gold/stderr b/agent/tool-scripts/tests/disk/gold/stderr index 99ca48205a..13c3413bde 100644 --- a/agent/tool-scripts/tests/disk/gold/stderr +++ b/agent/tool-scripts/tests/disk/gold/stderr @@ -2,12 +2,20 @@ disk: Error, one of the following options is required, --install|--start|--stop| The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + disk: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/disk/tools-group/disk', missing disk: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/disk/tools-group/disk', missing diff --git a/agent/tool-scripts/tests/dm-cache/gold/stderr b/agent/tool-scripts/tests/dm-cache/gold/stderr index 3253bd6abd..c3465d8037 100644 --- a/agent/tool-scripts/tests/dm-cache/gold/stderr +++ b/agent/tool-scripts/tests/dm-cache/gold/stderr @@ -2,12 +2,20 @@ dm-cache: Error, one of the following options is required, --install|--start|--s The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + dm-cache: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/dm-cache/tools-group/dm-cache', missing dm-cache: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/dm-cache/tools-group/dm-cache', missing diff --git a/agent/tool-scripts/tests/docker-info/gold/stderr b/agent/tool-scripts/tests/docker-info/gold/stderr index cd4eba3a9d..cb4ed3521d 100644 --- a/agent/tool-scripts/tests/docker-info/gold/stderr +++ b/agent/tool-scripts/tests/docker-info/gold/stderr @@ -2,12 +2,20 @@ docker-info: Error, one of the following options is required, --install|--start| The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + docker-info: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/docker-info/tools-group/docker-info', missing docker-info: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/docker-info/tools-group/docker-info', missing diff --git a/agent/tool-scripts/tests/docker/gold/stderr b/agent/tool-scripts/tests/docker/gold/stderr index 4faa9f7648..e258f1ac2a 100644 --- a/agent/tool-scripts/tests/docker/gold/stderr +++ b/agent/tool-scripts/tests/docker/gold/stderr @@ -2,12 +2,20 @@ docker: Error, one of the following options is required, --install|--start|--sto The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + docker: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/docker/tools-group/docker', missing docker: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/docker/tools-group/docker', missing diff --git a/agent/tool-scripts/tests/haproxy-ocp/gold/stderr b/agent/tool-scripts/tests/haproxy-ocp/gold/stderr index d898ab3320..d29868286f 100644 --- a/agent/tool-scripts/tests/haproxy-ocp/gold/stderr +++ b/agent/tool-scripts/tests/haproxy-ocp/gold/stderr @@ -2,13 +2,21 @@ haproxy-ocp: Error, one of the following options is required, --install|--start| The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --counters-clear-all clear all HAProxy counters at tool start (optional, default: 'false') +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + haproxy-ocp: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/haproxy-ocp/tools-group/haproxy-ocp', missing haproxy-ocp: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/haproxy-ocp/tools-group/haproxy-ocp', missing diff --git a/agent/tool-scripts/tests/iostat/gold/stderr b/agent/tool-scripts/tests/iostat/gold/stderr index 1b5e3dfd0b..9a839bab12 100644 --- a/agent/tool-scripts/tests/iostat/gold/stderr +++ b/agent/tool-scripts/tests/iostat/gold/stderr @@ -2,13 +2,21 @@ iostat: Error, one of the following options is required, --install|--start|--sto The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --options=str options passed directly to the tool (optional) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + iostat: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/iostat/tools-group/iostat', missing iostat: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/iostat/tools-group/iostat', missing diff --git a/agent/tool-scripts/tests/jmap/gold/stderr b/agent/tool-scripts/tests/jmap/gold/stderr index e12fa08f83..99f041d496 100644 --- a/agent/tool-scripts/tests/jmap/gold/stderr +++ b/agent/tool-scripts/tests/jmap/gold/stderr @@ -2,14 +2,22 @@ jmap: Error, one of the following options is required, --install|--start|--stop| The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --pid=int a process ID to jmap --pattern=str jmap any PID which name matches this string (via pgrep) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + jmap: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/jmap/tools-group/jmap', missing jmap: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/jmap/tools-group/jmap', missing diff --git a/agent/tool-scripts/tests/jstack/gold/stderr b/agent/tool-scripts/tests/jstack/gold/stderr index 2cb463e0cb..1a7c84e2a2 100644 --- a/agent/tool-scripts/tests/jstack/gold/stderr +++ b/agent/tool-scripts/tests/jstack/gold/stderr @@ -2,14 +2,22 @@ jstack: Error, one of the following options is required, --install|--start|--sto The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --pid=int a process ID to jstack --pattern=str jstack any PID which name matches this string (via pgrep) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + jstack: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/jstack/tools-group/jstack', missing jstack: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/jstack/tools-group/jstack', missing diff --git a/agent/tool-scripts/tests/kvm-spinlock/gold/stderr b/agent/tool-scripts/tests/kvm-spinlock/gold/stderr index 98f1360e93..34c752f0a9 100644 --- a/agent/tool-scripts/tests/kvm-spinlock/gold/stderr +++ b/agent/tool-scripts/tests/kvm-spinlock/gold/stderr @@ -2,12 +2,20 @@ kvm-spinlock: Error, one of the following options is required, --install|--start The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + kvm-spinlock: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/kvm-spinlock/tools-group/kvm-spinlock', missing kvm-spinlock: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/kvm-spinlock/tools-group/kvm-spinlock', missing diff --git a/agent/tool-scripts/tests/kvmstat/gold/stderr b/agent/tool-scripts/tests/kvmstat/gold/stderr index 28f5a8d3e9..331f8ba32f 100644 --- a/agent/tool-scripts/tests/kvmstat/gold/stderr +++ b/agent/tool-scripts/tests/kvmstat/gold/stderr @@ -2,12 +2,20 @@ kvmstat: Error, one of the following options is required, --install|--start|--st The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + kvmstat: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/kvmstat/tools-group/kvmstat', missing kvmstat: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/kvmstat/tools-group/kvmstat', missing diff --git a/agent/tool-scripts/tests/kvmtrace/gold/stderr b/agent/tool-scripts/tests/kvmtrace/gold/stderr index 565e5c1d0b..ce2c34bfc6 100644 --- a/agent/tool-scripts/tests/kvmtrace/gold/stderr +++ b/agent/tool-scripts/tests/kvmtrace/gold/stderr @@ -2,15 +2,23 @@ kvmtrace: Error, one of the following options is required, --install|--start|--s The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --vm=str the hostname of the vm running (to get kallsyms) --timeout=int how long the trace will run (default is 1 second) If 0 is used, the trace will not stop until stop-tools is called --start-delay=int sleep this many seconds before starting the trace (default is 0 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + kvmtrace: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/kvmtrace/tools-group/kvmtrace', missing kvmtrace: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/kvmtrace/tools-group/kvmtrace', missing diff --git a/agent/tool-scripts/tests/lockstat/gold/stderr b/agent/tool-scripts/tests/lockstat/gold/stderr index 72670a3708..1e78d9b4a6 100644 --- a/agent/tool-scripts/tests/lockstat/gold/stderr +++ b/agent/tool-scripts/tests/lockstat/gold/stderr @@ -2,11 +2,20 @@ lockstat: Error, one of the following options is required, --install|--start|--s The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) +Tool-specific options - these should be specified when you register a tool: + + No tool-specific options for this tool + +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + lockstat: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/lockstat/tools-group/lockstat', missing lockstat: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/lockstat/tools-group/lockstat', missing diff --git a/agent/tool-scripts/tests/mpstat/gold/stderr b/agent/tool-scripts/tests/mpstat/gold/stderr index 1f15a77068..9d7658a492 100644 --- a/agent/tool-scripts/tests/mpstat/gold/stderr +++ b/agent/tool-scripts/tests/mpstat/gold/stderr @@ -2,13 +2,21 @@ mpstat: Error, one of the following options is required, --install|--start|--sto The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --options=str options passed directly to the tool (optional) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + mpstat: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/mpstat/tools-group/mpstat', missing mpstat: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/mpstat/tools-group/mpstat', missing diff --git a/agent/tool-scripts/tests/numastat/gold/stderr b/agent/tool-scripts/tests/numastat/gold/stderr index 462a2b19c9..ed35c6a2a6 100644 --- a/agent/tool-scripts/tests/numastat/gold/stderr +++ b/agent/tool-scripts/tests/numastat/gold/stderr @@ -2,13 +2,21 @@ numastat: Error, one of the following options is required, --install|--start|--s The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --pattern=str a pattern for matching which processes for reporting per-node memory allocation +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + numastat: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/numastat/tools-group/numastat', missing numastat: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/numastat/tools-group/numastat', missing diff --git a/agent/tool-scripts/tests/oc/gold/stderr b/agent/tool-scripts/tests/oc/gold/stderr index 0c20261da8..fb41df3b0b 100644 --- a/agent/tool-scripts/tests/oc/gold/stderr +++ b/agent/tool-scripts/tests/oc/gold/stderr @@ -2,12 +2,20 @@ oc: Error, one of the following options is required, --install|--start|--stop|-- The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --components=str[,str] one or more OpenShift component names suitable for use with "oc get" (optional, default: 'rc,ep,pods,pv,pvc,svc,cs') +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + oc: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/oc/tools-group/oc', missing oc: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/oc/tools-group/oc', missing diff --git a/agent/tool-scripts/tests/openvswitch/gold/stderr b/agent/tool-scripts/tests/openvswitch/gold/stderr index c45021acc0..6e3df10310 100644 --- a/agent/tool-scripts/tests/openvswitch/gold/stderr +++ b/agent/tool-scripts/tests/openvswitch/gold/stderr @@ -2,12 +2,20 @@ openvswitch: Error, one of the following options is required, --install|--start| The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + openvswitch: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/openvswitch/tools-group/openvswitch', missing openvswitch: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/openvswitch/tools-group/openvswitch', missing diff --git a/agent/tool-scripts/tests/perf/gold/stderr b/agent/tool-scripts/tests/perf/gold/stderr index 12e215ddcf..4f124ef9d3 100644 --- a/agent/tool-scripts/tests/perf/gold/stderr +++ b/agent/tool-scripts/tests/perf/gold/stderr @@ -2,14 +2,22 @@ perf: Error, one of the following options is required, --install|--start|--stop| The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + -r str|--record-opts=str options one would use to record perf data (optional, default: '-a --freq=100') -p str|--report-opts=str options one would use to report perf data (optional, default: '--show-nr-samples -I') --callgraph generate a call graph by adding '-g' to the record and report options +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + perf: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/perf/tools-group/perf', missing perf: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/perf/tools-group/perf', missing diff --git a/agent/tool-scripts/tests/pidstat/gold/stderr b/agent/tool-scripts/tests/pidstat/gold/stderr index d37ff5e817..8d68e6e0ad 100644 --- a/agent/tool-scripts/tests/pidstat/gold/stderr +++ b/agent/tool-scripts/tests/pidstat/gold/stderr @@ -2,10 +2,15 @@ pidstat: Error, one of the following options is required, --install|--start|--st The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --options=str options passed directly to the tool --patterns=str[,str] only collect information on process names @@ -14,6 +19,9 @@ The following options are available: work) for kvm, use --patterns=qemu,vhost --threads collect per-thread statistics +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + pidstat: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/pidstat/tools-group/pidstat', missing pidstat: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/pidstat/tools-group/pidstat', missing diff --git a/agent/tool-scripts/tests/pprof/gold/stderr b/agent/tool-scripts/tests/pprof/gold/stderr index b5f5a49318..aa8998e49a 100644 --- a/agent/tool-scripts/tests/pprof/gold/stderr +++ b/agent/tool-scripts/tests/pprof/gold/stderr @@ -2,15 +2,23 @@ pprof: Error, one of the following options is required, --install|--start|--stop The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 60 seconds) --gopath=str path to the Go directory containing a 'bin' directory (required) --goroot=str path to the Go installation directory (optional) --inventory=str path to the inventory file (required) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + pprof: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/pprof/tools-group/pprof', missing pprof: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/pprof/tools-group/pprof', missing diff --git a/agent/tool-scripts/tests/proc-interrupts/gold/stderr b/agent/tool-scripts/tests/proc-interrupts/gold/stderr index 9965b1aab7..e1abc27efc 100644 --- a/agent/tool-scripts/tests/proc-interrupts/gold/stderr +++ b/agent/tool-scripts/tests/proc-interrupts/gold/stderr @@ -2,12 +2,20 @@ proc-interrupts: Error, one of the following options is required, --install|--st The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + proc-interrupts: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/proc-interrupts/tools-group/proc-interrupts', missing proc-interrupts: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/proc-interrupts/tools-group/proc-interrupts', missing diff --git a/agent/tool-scripts/tests/proc-sched_debug/gold/stderr b/agent/tool-scripts/tests/proc-sched_debug/gold/stderr index 6c76cb18d0..e81a4eb0b6 100644 --- a/agent/tool-scripts/tests/proc-sched_debug/gold/stderr +++ b/agent/tool-scripts/tests/proc-sched_debug/gold/stderr @@ -2,12 +2,20 @@ proc-sched_debug: Error, one of the following options is required, --install|--s The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + proc-sched_debug: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/proc-sched_debug/tools-group/proc-sched_debug', missing proc-sched_debug: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/proc-sched_debug/tools-group/proc-sched_debug', missing diff --git a/agent/tool-scripts/tests/proc-vmstat/gold/stderr b/agent/tool-scripts/tests/proc-vmstat/gold/stderr index c23a14b501..65875b620f 100644 --- a/agent/tool-scripts/tests/proc-vmstat/gold/stderr +++ b/agent/tool-scripts/tests/proc-vmstat/gold/stderr @@ -2,12 +2,20 @@ proc-vmstat: Error, one of the following options is required, --install|--start| The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + proc-vmstat: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/proc-vmstat/tools-group/proc-vmstat', missing proc-vmstat: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/proc-vmstat/tools-group/proc-vmstat', missing diff --git a/agent/tool-scripts/tests/prometheus-metrics/gold/stderr b/agent/tool-scripts/tests/prometheus-metrics/gold/stderr index 32adc72977..0e3bcefaf1 100644 --- a/agent/tool-scripts/tests/prometheus-metrics/gold/stderr +++ b/agent/tool-scripts/tests/prometheus-metrics/gold/stderr @@ -2,15 +2,23 @@ prometheus-metrics: Error, one of the following options is required, --install|- The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --gopath=str path to the Go directory containing a 'bin' directory (required) --goroot=str path to the Go installation directory (optional) --inventory=str path to the inventory file (required) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + prometheus-metrics: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/prometheus-metrics/tools-group/prometheus-metrics', missing prometheus-metrics: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/prometheus-metrics/tools-group/prometheus-metrics', missing diff --git a/agent/tool-scripts/tests/qemu-migrate/gold/stderr b/agent/tool-scripts/tests/qemu-migrate/gold/stderr index e5c1441111..5d73467c58 100644 --- a/agent/tool-scripts/tests/qemu-migrate/gold/stderr +++ b/agent/tool-scripts/tests/qemu-migrate/gold/stderr @@ -2,13 +2,21 @@ qemu-migrate: Error, one of the following options is required, --install|--start The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --vm=str the name of the VM being migrated +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + qemu-migrate: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/qemu-migrate/tools-group/qemu-migrate', missing qemu-migrate: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/qemu-migrate/tools-group/qemu-migrate', missing diff --git a/agent/tool-scripts/tests/rabbit/gold/stderr b/agent/tool-scripts/tests/rabbit/gold/stderr index b15e7adf43..c22055855f 100644 --- a/agent/tool-scripts/tests/rabbit/gold/stderr +++ b/agent/tool-scripts/tests/rabbit/gold/stderr @@ -2,14 +2,22 @@ rabbit: Error, one of the following options is required, --install|--start|--sto The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --username=str rabbit user name (default is "guest") --password=str rabbit password (default is "guest") +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + rabbit: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/rabbit/tools-group/rabbit', missing rabbit: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/rabbit/tools-group/rabbit', missing diff --git a/agent/tool-scripts/tests/sar/gold/stderr b/agent/tool-scripts/tests/sar/gold/stderr index c8e742f856..2173faad90 100644 --- a/agent/tool-scripts/tests/sar/gold/stderr +++ b/agent/tool-scripts/tests/sar/gold/stderr @@ -2,13 +2,21 @@ sar: Error, one of the following options is required, --install|--start|--stop|- The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --options=str options passed directly to the tool (optional) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + sar: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/sar/tools-group/sar', missing sar: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/sar/tools-group/sar', missing diff --git a/agent/tool-scripts/tests/strace/gold/stderr b/agent/tool-scripts/tests/strace/gold/stderr index 7524316a90..53192d611a 100644 --- a/agent/tool-scripts/tests/strace/gold/stderr +++ b/agent/tool-scripts/tests/strace/gold/stderr @@ -2,13 +2,21 @@ strace: Error, one of the following options is required, --install|--start|--sto The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --pid=int a process ID to strace --pattern=str strace any PID which name matches this string (via pgrep) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + strace: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/strace/tools-group/strace', missing strace: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/strace/tools-group/strace', missing diff --git a/agent/tool-scripts/tests/sysfs/gold/stderr b/agent/tool-scripts/tests/sysfs/gold/stderr index a5787cca83..8d13889409 100644 --- a/agent/tool-scripts/tests/sysfs/gold/stderr +++ b/agent/tool-scripts/tests/sysfs/gold/stderr @@ -2,15 +2,23 @@ sysfs: Error, one of the following options is required, --install|--start|--stop The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --path=str a path (beyond the /sysfs prefix) --pattern=str a pattern passed to -name option of find command to filter files --maxdepth=int a maxdepth passed to the find command to limit recursion depth +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + sysfs: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/sysfs/tools-group/sysfs', missing sysfs: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/sysfs/tools-group/sysfs', missing diff --git a/agent/tool-scripts/tests/systemtap/gold/stderr b/agent/tool-scripts/tests/systemtap/gold/stderr index cd56deadcb..122dc27828 100644 --- a/agent/tool-scripts/tests/systemtap/gold/stderr +++ b/agent/tool-scripts/tests/systemtap/gold/stderr @@ -2,12 +2,20 @@ systemtap: Error, one of the following options is required, --install|--start|-- The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --script=str path to the systemtap script (required w/ --install) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + systemtap: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/systemtap/tools-group/systemtap', missing systemtap: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/systemtap/tools-group/systemtap', missing diff --git a/agent/tool-scripts/tests/tcpdump/gold/stderr b/agent/tool-scripts/tests/tcpdump/gold/stderr index 3a79525102..20beb28dd9 100644 --- a/agent/tool-scripts/tests/tcpdump/gold/stderr +++ b/agent/tool-scripts/tests/tcpdump/gold/stderr @@ -2,13 +2,21 @@ tcpdump: Error, one of the following options is required, --install|--start|--st The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interface=str the network interface to monitor --packets=int the number of packets to monitor before exiting +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + tcpdump: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/tcpdump/tools-group/tcpdump', missing tcpdump: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/tcpdump/tools-group/tcpdump', missing diff --git a/agent/tool-scripts/tests/turbostat/gold/stderr b/agent/tool-scripts/tests/turbostat/gold/stderr index 91ae1d3298..29c7d8091e 100644 --- a/agent/tool-scripts/tests/turbostat/gold/stderr +++ b/agent/tool-scripts/tests/turbostat/gold/stderr @@ -2,12 +2,20 @@ turbostat: Error, one of the following options is required, --install|--start|-- The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + turbostat: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/turbostat/tools-group/turbostat', missing turbostat: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/turbostat/tools-group/turbostat', missing diff --git a/agent/tool-scripts/tests/user-tool/gold/stderr b/agent/tool-scripts/tests/user-tool/gold/stderr index 77ef8171cd..652b7f550c 100644 --- a/agent/tool-scripts/tests/user-tool/gold/stderr +++ b/agent/tool-scripts/tests/user-tool/gold/stderr @@ -2,10 +2,15 @@ user-tool: Error, one of the following options is required, --install|--start|-- The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --tool-name=str you must provide a unique name for this user tool --start-script=str run this user-provided script when starting this tool @@ -15,6 +20,9 @@ The following options are available: you can use this option, or the start/stop/postprocess-script, but not both at the same time +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + user-tool: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/user-tool/tools-group/user-tool-foo42', missing user-tool: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/user-tool/tools-group/user-tool-foo42', missing diff --git a/agent/tool-scripts/tests/virsh-migrate/gold/stderr b/agent/tool-scripts/tests/virsh-migrate/gold/stderr index 61b7bc18be..8e1e7bb1ac 100644 --- a/agent/tool-scripts/tests/virsh-migrate/gold/stderr +++ b/agent/tool-scripts/tests/virsh-migrate/gold/stderr @@ -2,13 +2,21 @@ virsh-migrate: Error, one of the following options is required, --install|--star The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) --vm=str the name of the VM being migrated +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + virsh-migrate: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/virsh-migrate/tools-group/virsh-migrate', missing virsh-migrate: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/virsh-migrate/tools-group/virsh-migrate', missing diff --git a/agent/tool-scripts/tests/vmstat/gold/stderr b/agent/tool-scripts/tests/vmstat/gold/stderr index 3210955820..b6687afb5e 100644 --- a/agent/tool-scripts/tests/vmstat/gold/stderr +++ b/agent/tool-scripts/tests/vmstat/gold/stderr @@ -2,12 +2,20 @@ vmstat: Error, one of the following options is required, --install|--start|--sto The following options are available: +Operational options - do *not* specify any of these when you register a tool: + --install verify this perf tool will work --start|stop|postprocess start/stop/postprocess the data collection -d str|--dir=str directory to store data collection (required) + +Tool-specific options - these should be specified when you register a tool: + --interval=int number of seconds between each data collection (optional, default is 10 seconds) +Help option - do *not* specify this when you register a tool: + -h|--help display this help message + vmstat: WARNING - postprocess - tool output directory, '/var/tmp/pbench-test-tool-scripts/vmstat/tools-group/vmstat', missing vmstat: WARNING - stop - tool output directory, '/var/tmp/pbench-test-tool-scripts/vmstat/tools-group/vmstat', missing diff --git a/agent/util-scripts/gold/pbench-register-tool/test-44.txt b/agent/util-scripts/gold/pbench-register-tool/test-44.txt index 2f73f0defa..ee8e923226 100644 --- a/agent/util-scripts/gold/pbench-register-tool/test-44.txt +++ b/agent/util-scripts/gold/pbench-register-tool/test-44.txt @@ -65,6 +65,10 @@ Available tools: For a list of tool specific options, run: /var/tmp/pbench-test-utils/opt/pbench-agent/tool-scripts/ --help + +The tools have a few operational options (marked as such in the help message) +which are used internally by pbench: you should *NOT* specify those when +you register a tool. --- Finished test-44 pbench-register-tool (status=1) +++ pbench tree state /var/tmp/pbench-test-utils/pbench diff --git a/agent/util-scripts/gold/pbench-register-tool/test-46.txt b/agent/util-scripts/gold/pbench-register-tool/test-46.txt index c6a547ee4e..04a2a59a80 100644 --- a/agent/util-scripts/gold/pbench-register-tool/test-46.txt +++ b/agent/util-scripts/gold/pbench-register-tool/test-46.txt @@ -65,6 +65,10 @@ Available tools: For a list of tool specific options, run: /var/tmp/pbench-test-utils/opt/pbench-agent/tool-scripts/ --help + +The tools have a few operational options (marked as such in the help message) +which are used internally by pbench: you should *NOT* specify those when +you register a tool. --- Finished test-46 pbench-register-tool (status=1) +++ pbench tree state /var/tmp/pbench-test-utils/pbench diff --git a/agent/util-scripts/gold/pbench-register-tool/test-47.txt b/agent/util-scripts/gold/pbench-register-tool/test-47.txt index 7b7350702f..67a29f6604 100644 --- a/agent/util-scripts/gold/pbench-register-tool/test-47.txt +++ b/agent/util-scripts/gold/pbench-register-tool/test-47.txt @@ -65,6 +65,10 @@ Available tools: For a list of tool specific options, run: /var/tmp/pbench-test-utils/opt/pbench-agent/tool-scripts/ --help + +The tools have a few operational options (marked as such in the help message) +which are used internally by pbench: you should *NOT* specify those when +you register a tool. --- Finished test-47 pbench-register-tool (status=1) +++ pbench tree state /var/tmp/pbench-test-utils/pbench diff --git a/agent/util-scripts/pbench-register-tool b/agent/util-scripts/pbench-register-tool index 3bf1f56d3b..b95d0b7482 100755 --- a/agent/util-scripts/pbench-register-tool +++ b/agent/util-scripts/pbench-register-tool @@ -132,7 +132,11 @@ function usage() { # 1 2 3 4 5 6 7 8 # (no tab) 12345678901234567890123456789012345678901234567890123456789012345678901234567890 printf -- "\nFor a list of tool specific options, run:\n" - printf -- "\t${pbench_bin}/tool-scripts/ --help\n" + printf -- "\t${pbench_bin}/tool-scripts/ --help\n\n" + + printf -- "The tools have a few operational options (marked as such in the help message)\n" + printf -- "which are used internally by pbench: you should *NOT* specify those when\n" + printf -- "you register a tool.\n" } # Process options and arguments