Status checks

The program omicron-status check for several common problems:

• Gaps: the dectector was in an analyzable state, frames of the appropriate type are available but there are no trigger files.

• Latency: <todo: working on what this is??>

• Overlaps: checks for trigger files that duplicate or overlap others

When used with the --json option the program writes files compatible with the dashboard LIGO Nagios monitors. See Omicron dashboard

The --html option creates a plot of latency and a list of parameters used. The results are shown in the “Service status” tab of the network nummary pages.

The full list of options is available from the help message:

$ omicron-status --help
/home/docs/checkouts/readthedocs.org/user_builds/pyomicron/conda/latest/lib/python3.11/site-packages/htcondor/__init__.py:49: UserWarning: Neither the environment variable CONDOR_CONFIG, /etc/condor/, /usr/local/etc/, nor ~condor/ contain a condor_config source. Therefore, we are using a null condor_config.
  _warnings.warn(message)
/home/docs/checkouts/readthedocs.org/user_builds/pyomicron/conda/latest/lib/python3.11/site-packages/h5py/__init__.py:36: UserWarning: h5py is running against HDF5 1.14.3 when it was built against 1.14.2, this may cause problems
  _warn(("h5py is running against HDF5 {0} when it was built against {1}, "
[omicron-status 12-12 19:25:55]     INFO status.py:245: Found omicron version: 4.1.0
usage: omicron-status [-h] [-V] [-f CONFIG_FILE] [-i IFO] [-s GPS_START_TIME]
                      [-e GPS_END_TIME] [-c CHANNEL] [-b STATE_FLAG] [-p X,Y]
                      [-u USER] [-a ARCHIVE_DIRECTORY]
                      [-d PRODUCTION_DIRECTORY] [-A] [-B] [-C] [--json [JSON]]
                      [-o OUTPUT_DIRECTORY] [-l LATENCY_ARCHIVE_TAG] [-m]
                      [-U UNKNOWN] [-W WARNING] [-X ERROR]
                      group

Check the status of Omicron trigger generation

positional arguments:
  group                 name of channel group to check

options:
  -h, --help            show this help message and exit
  -V, --version         show program's version number and exit
  -f CONFIG_FILE, --config-file CONFIG_FILE
                        path to a channel list configuration file (default:
                        None)
  -i IFO, --ifo IFO     IFO prefix to process (default: None)
  -s GPS_START_TIME, --gps-start-time GPS_START_TIME
                        GPS start time of check or date/time (default:
                        1385839573)
  -e GPS_END_TIME, --gps-end-time GPS_END_TIME
                        GPS end time of check or date/time (default:
                        1386444373)
  -c CHANNEL, --channel CHANNEL
                        name of channel to process, can be given multiple
                        times, default: all channels in group (default: None)
  -b STATE_FLAG, --state-flag STATE_FLAG
                        name of data-quality flag to use in defining state,
                        default is taken from --config-file (default: None)
  -p X,Y, --state-pad X,Y
                        inward padding for start,end of each --state-flag
                        segment (default: 0,0)
  -u USER, --user USER  name of user running condor jobs (default: docs)
  -a ARCHIVE_DIRECTORY, --archive-directory ARCHIVE_DIRECTORY
                        path of archive (default: /home/docs/triggers)
  -d PRODUCTION_DIRECTORY, --production-directory PRODUCTION_DIRECTORY
                        path of production directory (default:
                        /home/docs/omicron/online/{group})
  -A, --skip-condor     don't check condor status (default: False)
  -B, --skip-file-checks
                        don't check file status (default: False)
  -C, --skip-job-duration
                        don't query and plot job durations (default: False)

Output options:
  --json [JSON]         print output in dashboard.ligo.org nagios JSON format
                        (default: False)
  -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY
                        path to write output (default: /home/docs/checkouts/re
                        adthedocs.org/user_builds/pyomicron/checkouts/latest/d
                        ocs)
  -l LATENCY_ARCHIVE_TAG, --latency-archive-tag LATENCY_ARCHIVE_TAG
                        file tag for latency archive (default: {group})
  -m, --html            write HTML summary to index.html in output dir
                        (default: False)

Monitoring options:
  -U UNKNOWN, --unknown UNKNOWN
                        time (seconds) after which nagios output should be
                        considered stable and 'unknown' (default: 7200)
  -W WARNING, --warning WARNING
                        how much latency to consider as a warning (default:
                        3600)
  -X ERROR, --error ERROR
                        how much latency to consider as an error (default:
                        7200)