(original) (raw)

The following steps assume that only a single node participates in the benchmark run. If you want a multi-node setup, you have to read up on the --remote options of various commands (in particular, pbench-register-tool-set)

Customize the agent for your server environment. This will vary from installation to installation, but it fundamentally involves copying two files that should be made available to you somehow by an administrator: an ssh private key file to allow the client(s) to send results to the server and a configuration file that should be installed in /opt/pbench-agent/config/pbench-agent.cfg. There is an example configuration file in that location, which allows you to run benchmarks normally and gather results; but you need the "real" one for your environment in order to send results to the server, since among other things, the config file specifies who the server is.

Run your benchmark with a default set of tools:

. /etc/profile.d/pbench-agent.sh #or log out and log back in

pbench-register-tool-set

pbench-user-benchmark -C test1 -- ./your_cmd.sh

pbench-move-results

Visit the Results URL in your browser to see the results: the URL depends on who the server is; assuming that the server is "pbench.example.com" and assuming you ran the above on a host named "myhost", the results will be found at (N.B.: this is a fake link serving as an example only - talk to your local administrator to find out what server to use to get to Pbench results):http://pbench.example.com/results/myhost/pbench-user-benchmark_test1_yyyy-mm-dd_HH:MM:SS

Don't see what you need here?

The pbench-move-results script removes the results directory (assumed to be within the/var/lib/pbench-agent hierarchy: that is the default value of the configured run directory) after copying it the results repo. But if there are previous results present (perhaps because pbench-move-results was never invoked, or perhaps becausepbench-copy-results was invoked instead),pbench-move-results will copyallof them: you probably do not want that.

It is a good idea in general to invoke pbench-clear-results, which cleans the configured run directory, beforerunning your benchmark.

All the commands take a --help option and produce a terse uasage message

The default set of tools for data collection can be enabled with

pbench-register-tool-set

You can then run a built-in benchmark by invoking its Pbench script - Pbench will install the benchmark if necessary1:

pbench-fio

When the benchmark finishes, the tools will be stopped as well. The results can be collected and shipped to the standard storage location2 with:

pbench-move-results

or

pbench-copy-results

The pbench-move-results script removes the results directory (assumed to be within the /var/lib/pbench-agent hierarchy) after copying it the results repo. But if there are previous results present (perhaps because pbench-move-results was never invoked, or perhaps because pbench-copy-results was invoked instead), pbench-move-results will copy allof them: you probably do not want that.

It's a good idea in general to invoke pbench-clear-results, which cleans /var/lib/pbench-agent,beforerunning your benchmark.