ringdiagnostics

Name

ringdiagnostics --  Diagnose ring data flow bottlenecks

Synopsis

$DAQBIN/ringdiagnostics [options...]

DESCRIPTION

Provides a graphical description of the flow of data between ringbuffers in a multi computer system.

OPTIONS

--help

Prints a list of options and their descriptions to stdout. Then exits without doing anything.

--update seconds

Specifies the update rate in seconds. THis defaults to 2 if not specified.

--alarm_percentage pct

Specifies the backlog level, as a percentage of ring size, that constitutes a bottleneck. This defaults to 90 if not specified.

Environment requirements in a containr

If this is run in a container, its use of the nscldaq.nscldaqutils.ssh method imposes some environment variable definitions:

APPTAINER_CONTAINER

Must be the full path to the container image.

SINGULARITY_CONTAINER

In older singularity systems, this must have the same value as APPTAINER_CONTAINER. In Apptainer systems, this is not needed.

CONTAINER_BINDINGS

Must be a string that can be passed to apptainer/singularity's --bind option, that specifies the container bindings you care about, for example at the FRIB for the bookworm container, you might have the value /usr/opt/opt-bookworm:/usr/opt.