alert_status - bruno-beloff/scs_analysis GitHub Wiki

docs > software repositories > scs_analysis > commands > alerts


DESCRIPTION

The alert_status utility is used to report on the history of alerts generated by a specific alert specification. Alert causes are:

  • L - Below lower threshold
  • U - Above upper threshold
  • N - Null value
  • OK - data has returned within bounds

The --credentials flag is only required where the user wishes to store multiple identities. Setting the credentials is done interactively using the command line interface.

SYNOPSIS

alert_status.py [-c CREDENTIALS] { -F { -l | -d [-a CAUSE] } | -D } [-i INDENT] [-v] ID

Options
-h, --help show this help message and exit
-c CREDENTIALS_NAME, --credentials=CREDENTIALS_NAME the stored credentials to be presented
-F, --find find alert status reports
-D, --delete delete the alert status history
-l, --latest find latest status report only
-d, --history find history of status reports
-a CAUSE, --cause=CAUSE filter history by cause { L | U | N | OK }
-i INDENT, --indent=INDENT pretty-print the output with INDENT
-v, --verbose report narrative to stderr

EXAMPLES

alert_status.py -vi4 -c bruno -Fl 87
alert_status.py -v -c bruno -Fd 107 | node.py -s | csv_writer.py

DOCUMENT EXAMPLE

{"id": 88, "rec": "2023-06-29T09:48:42Z", "cause": "NV", "val": null}

SEE ALSO

scs_analysis/alert
scs_analysis/cognito_user_credentials