Argument description:
Create a new probe-streamer object with a name. If name is not given a unique name will be created for it automatically. The probe-streamer samples probes in the system either at a regular interval or when a notification is raised.
The sampling-mode argument specifies the mode used to perform sampling. Default is "realtime-sync" when the interval is in realtime (wallclock), but also synchronized so all processor have executed at least one quantum since last sample.
With the "realtime" sampling mode, sampling is based on the wallclock time only, without any synchronization. Some probes might yield strange results, when some processors have not executed at all since the last sample.
Mode can also be "virtual", where the virtual time is used to perform sampling. The time is based on the virtual time of the first processor found in the system, unless clock is set to override the default one with another clock or processor.
In "realtime-sync", "realtime" and "virtual" modes the interval is set in seconds by the interval argument.
Another available mode is "notifier" where sampling is performed each time a notification is raised. notifier-type specifies the notifier type and notifier-obj the object where the notifier is installed.
The timestamp-file specifies a file to be used recording specific timepoints when the sampling should take place. Together with realtime-sync the file will be created and filled with the cycle count from the clock argument, when the samples are taken.
With the time-stamp sampler, this file will instead be used as an input file, and the sampling will take place on the cycles specified in the file.
Probes to sample are added by the <probe-streamer>.add-probe command.
The csv-output-file argument specifies the path of the CSV file where the samples are dumped.
The -no-metadata switch disables the insertion of the metadata fields in the generated CSV.
The -no-timestamp switch disables the insertion of the timestamp column in the generated CSV.
The timestamp-probe allows the user to specify the probe used for timestamping, overriding the default timestamp probe selection.