stats-collect-start - Man Page

-h

Show this help message and exit.

-q

Be quiet.

-d

Print debugging information.

-H HOSTNAME, --host HOSTNAME

Name of the host to run the command on.

-U USERNAME, --username USERNAME

Name of the user to use for logging into the remote host over SSH. The default user name is 'root'.

-K PRIVKEY, --priv-key PRIVKEY

Path to the private SSH key that should be used for logging into the remote host. By default the key is automatically found from standard paths like '~/.ssh'.

-T TIMEOUT, --timeout TIMEOUT

SSH connect timeout in seconds, default is 8.

--time-limit LIMIT

The time limit for statistics collection, after which the collection will stop if the command 'cmd' (given as a positional argument) has not finished executing.

-o OUTDIR, --outdir OUTDIR

--reportid REPORTID

Any string which may serve as an identifier of this run. By default report ID is the current date, prefixed with the remote host name in case the '-H' option was used: [hostname-]YYYYMMDD. For example, "20150323" is a report ID for a run made on March 23, 2015. The allowed characters are: ACSII alphanumeric, '-', '.', ',', '_', and '~'.

--stats STATS

Comma-separated list of statistics to collect. They are stored in the the "stats" sub-directory of the output directory. By default, only 'turbostat, sysinfo' statistics are collected. Use 'all' to collect all possible statistics. Use ' --stats=""' or '--stats="none"' to disable statistics collection. If you know exactly what statistics you need, specify the comma-separated list of statistics to collect. For example, use 'turbostat,acpower' if you need only turbostat and AC power meter statistics. You can also specify the statistics you do not want to be collected by pre-pending the '!' symbol. For example, 'all,!turbostat' would mean: collect all the statistics supported by the SUT, except for

--stats-intervals STATS_INTERVALS

The intervals for statistics. Statistics collection is based on doing periodic snapshots of data. For example, by default the 'acpower' statistics collector reads SUT power consumption for the last second every second, and 'turbostat' default interval is 5 seconds. Use 'acpower:5,turbostat:10' to increase the intervals to 5 and 10 seconds correspondingly. Use the '--list-stats' to get the default interval values.

--list-stats

Print information about the statistics 'stats-collect' can collect and exit.

--report

Generate an HTML report for collected results (same as calling 'report' command with default arguments).

--cmd-local

Run the command on the local host instead of the SUT ('HOSTNAME'). This is useful for client/server workloads where the SUT runs the server and the local host runs the client.

-P PIPE_PATH, --pipe-path PIPE_PATH*

Path to the named pipe where the executed command is going to write the lables to. The named pipe is created on the SUT ('HOSTNAME'). The labels are used for the X-axix in the HTML reports. Use the special keyword "auto" to instruct 'stats-collect' to automatically create a named pipe in the temporary directory (use the "{PIPE_PATH}" placeholder in workload's command line to get the path in this case). No named pipe is created by default.

--pipe-timeout PIPE_TIMEOUT

The longest allowed time interval between named pipe input lines. The 'stats-collect' tool exits with an error if the interval exceeds PIPE_TIMEOUT. The default timeout is 5 minutes. Specify time value in minutes, or use one of the following specifiers: d - days, h - hours, m - minutes, s - seconds. For example, '--pipe-timeout=1m 20s' would mean mean 1 minute and 20 seconds.