1STATS-COLLECT(1) Generated Python Manual STATS-COLLECT(1)
2
6 stats-collect
7
9 stats-collect [-h] [-q] [-d] [--version] [--force-color] {de‐
10 ploy,start,report} ...
11
13 stats-collect - a tool for collecting and visualising system statistics
14 and telemetry.
15
18 -h Show this help message and exit.
19 -q Be quiet.
22 -d Print debugging information.
25 --version
28 Print version and exit.
29 --force-color
32 Force coloring of the text output.
33
36 stats-collect deploy
37 Deploy stats-collect helpers.
38 stats-collect start
40 Start the measurements.
41 stats-collect report
43 Create an HTML report.
44
47 usage: stats-collect deploy [-h] [-q] [-d] [--tmpdir-path TMPDIR_PATH]
48 [--keep-tmpdir] [-H HOSTNAME] [-U USERNAME] [-K PRIVKEY] [-T TIMEOUT]
49 Deploy stats-collect helpers to a remote SUT (System Under Test).
51
54 -h Show this help message and exit.
55 -q Be quiet.
58 -d Print debugging information.
61 --tmpdir-path TMPDIR_PATH
64 When 'stats-collect' is deployed, a random temporary directory
65 is used. Use this option provide a custom path instead. It will
66 be used as a temporary directory on both local and remote hosts.
67 This option is meant for debugging purposes.
68 --keep-tmpdir
71 Do not remove the temporary directories created while deploying
72 'stats-collect'. This option is meant for debugging purposes.
73 -H HOSTNAME, --host HOSTNAME
76 Name of the host to run the command on.
77 -U USERNAME, --username USERNAME
80 Name of the user to use for logging into the remote host over
81 SSH. The default user name is 'root'.
82 -K PRIVKEY, --priv-key PRIVKEY
85 Path to the private SSH key that should be used for logging into
86 the remote host. By default the key is automatically found from
87 standard paths like '~/.ssh'.
88 -T TIMEOUT, --timeout TIMEOUT
91 SSH connect timeout in seconds, default is 8.
92
95 usage: stats-collect start [-h] [-q] [-d] [-H HOSTNAME] [-U USERNAME]
96 [-K PRIVKEY] [-T TIMEOUT] [--cpunum CPUNUM] [--time-limit LIMIT] [-o
97 OUTDIR] [--reportid REPORTID] [--stats STATS] [--stats-intervals
98 STATS_INTERVALS] [--report] cmd [cmd ...]
99 Start collecting statistics.
101 cmd Command to run on the SUT during statistics collection. If
104 'HOSTNAME' is provided, the tool will run the command on that
105 host, otherwise the tool will run the command on 'localhost'.
106
109 -h Show this help message and exit.
110 -q Be quiet.
113 -d Print debugging information.
116 -H HOSTNAME, --host HOSTNAME
119 Name of the host to run the command on.
120 -U USERNAME, --username USERNAME
123 Name of the user to use for logging into the remote host over
124 SSH. The default user name is 'root'.
125 -K PRIVKEY, --priv-key PRIVKEY
128 Path to the private SSH key that should be used for logging into
129 the remote host. By default the key is automatically found from
130 standard paths like '~/.ssh'.
131 -T TIMEOUT, --timeout TIMEOUT
134 SSH connect timeout in seconds, default is 8.
135 --cpunum CPUNUM
138 If the executed command stresses a particular CPU number, you
139 can specify it via this option so that the number is saved in
140 the test result and later the 'stats-collect report' command
141 will take this into account while generating the test report.
142 --time-limit LIMIT
145 The time limit for statistics collection, after which the col‐
146 lection will stop if the command 'cmd' (given as a positional
147 argument) has not finished executing.
148 -o OUTDIR, --outdir OUTDIR
151 --reportid REPORTID
154 Any string which may serve as an identifier of this run. By de‐
155 fault report ID is the current date, prefixed with the remote
156 host name in case the '-H' option was used: [hostname-]YYYYMMDD.
157 For example, "20150323" is a report ID for a run made on March
158 23, 2015. The allowed characters are: ACSII alphanumeric, '-',
159 '.', ',', '_', and '~'.
160 --stats STATS
163 Comma-separated list of statistics to collect. They are stored
164 in the the "stats" sub-directory of the output directory. By de‐
165 fault, only 'turbostat, sysinfo' statistics are collected. Use
166 'all' to collect all possible statistics. Use '--stats=""' or
167 '--stats="none"' to disable statistics collection. If you know
168 exactly what statistics you need, specify the comma-separated
169 list of statistics to collect. For example, use 'turbo‐
170 stat,acpower' if you need only turbostat and AC power meter sta‐
171 tistics. You can also specify the statistics you do not want to
172 be collected by pre-pending the '!' symbol. For example,
173 'all,!turbostat' would mean: collect all the statistics sup‐
174 ported by the SUT, except for 'turbostat'. Use the
175 '--list-stats' option to get more information about available
176 statistics. By default, only 'sysinfo' statistics are collected.
177 --stats-intervals STATS_INTERVALS
180 The intervals for statistics. Statistics collection is based on
181 doing periodic snapshots of data. For example, by default the
182 'acpower' statistics collector reads SUT power consumption for
183 the last second every second, and 'turbostat' default interval
184 is 5 seconds. Use
185 --report
188
191 usage: stats-collect report [-h] [-q] [-d] [-o OUTDIR] [--reportids RE‐
192 PORTIDS] respaths [respaths ...]
193 Create an HTML report for one or multiple test results.
195 respaths
198 One or multiple stats-collect test result paths.
199
202 -h Show this help message and exit.
203 -q Be quiet.
206 -d Print debugging information.
209 -o OUTDIR, --outdir OUTDIR
212 Path to the directory to store the report at. By default the re‐
213 port is stored in the 'stats-collect-report-<reportid>' sub-di‐
214 rectory of the test result directory. If there are multiple test
215 results, the report is stored in the current directory. The
216 '<reportid>' is report ID of stats-collect test result.
217 --reportids REPORTIDS
220 Every input raw result comes with a report ID. This report ID is
221 basically a short name for the test result, and it used in the
222 HTML report to refer to the test result. However, sometimes it
223 is helpful to temporarily override the report IDs just for the
224 HTML report, and this is what the '--reportids' option does.
225 Please, specify a comma-separated list of report IDs for every
226 input raw test result. The first report ID will be used for the
227 first raw rest result, the second report ID will be used for the
228 second raw test result, and so on. Please, refer to the '--re‐
229 portid' option description in the 'start' command for more in‐
230 formation about the report ID.
231
234 Artem Bityutskiy
235 dedekind1@gmail.com
236
239 The latest version of stats-collect may be downloaded from
240 ⟨https://github.com/intel/stats-collect⟩
241stats-collect 2023-08-23 STATS-COLLECT(1)