Add probes to the monitor. Using the probe-kind argument will add all instances of that probe to the monitor, i.e. all objects that have that probe, will be added.
To be more selective on which objects that should be monitored, the probe argument can be used instead, specific which object's probes that should be added.
Either way a prefix which ends with a dot (.) is allowed to add any probes below the prefix in the probe name hierarchy, e.g., probe="board.mb.cpu[0]:cpu." will add all probes that start with "cpu.". in the board.mb.cpu[0] object, and similarly, a probe-kind of just "cpu." will add all probes having "cpu." as prefix, in all objects.
The mode argument tells the monitor how the probe values should be display in each sample, by default the delta value from last sample is shown. Other options are current and session. current means the actual probe value is displayed in each sample. With the session mode, the delta value since the probe was added to the monitor is displayed.
For example, a steps probe might have a value of several millions when you add the probe to the monitor. With current the full number will be displayed, with session it will start at zero and increase. The delta will show the number of steps between each sample.
A probe can be added with different modes by using the command repeatedly. A probe can only be added once in each mode and adding it several time will have no effect.
If -verbose is given all the proves added are logged to the console.
The -hidden flag can be used to collect a probe during sampling, but not print the value on the console. (Reducing the width and the amount of data being presented). Hidden probes will still be printed by the various commands that list or export the data.
The -no-sampling flags tells the monitor to ignore the probe in each sample, and only display the final probe value. The probe will however be available in the <probe_monitor>.summary and <probe_monitor>.export-to-json commands. The purpose of this is to reduce memory footprint and to lower sampling overhead.
The command returns a list of the probe names added if used as a value.