alarmLogDisp - Historical alarm log display
alarmLogDisp [-b background color] [-f fontName]
[-i alarm file directory] [-w width]
[-r rows] [-v vertical spacing]
[-t today] [-x date/time regexp]
alarmLogDisp allows the user to display historical alarms that have
been saved into files that are in the following format:
YYYY-MM-DD
where:
YYYY = year (eg. 1994)
MM = month (eg. 07)
DD = day of month (eg. 01)
The file can be compressed using gzip or compress and the program will
automatically de-compress the file before reading it in (see
alarmSeparate script).
Selecting the alarm date is performed through the View->Alarm Date...
menu item.
Once the alarms for the selected date is displayed, the user is able
to select particular alarms that are of interest, and either print
them or save them into a file. Only the alarm message is saved.
When printing the selected alarms, the user is able to select the
printer to print to and any additional printer options (for example,
-oc can be used for compressed print, -olandscape for printing in
landscape format (NOTE: not all printers support these options)).
When saving to a file, and the selected file does not exist, it will
be created. If an existing file has been selected, the alarms will be
appended to the end of the file. This allows the user to select alarms
from various alarm dates together before printing (printing the file
will have to be performed manually).
alarmLogDisp requires the following executables to be available in the
PATH environment variable:
- awk
- lpstat
- sed
- lp
- compress
- uncompress
- gzip (if available)
- gunzip (if available)
Once the alarms for the selected alarm date is displayed, the user is
able to filter the alarms by selecting the View->Filter... menu item.
The filtering allows the user to filter alarms based on the following
conditions:
time Allows the user to specify the start and end times for alarms.
Because acknowledge alarms do not contain a date and time value
in the log, the date and time is parsed from the message (see -x
option).
acked
Allows the user to specify that only acknowledged alarms are to
be displayed.
not acked
Allows the user to specify that only not acknowledged alarms are
to be displayed.
point name
Allows the user to specify a regular expression (see regexp(5))
to be applied against the point name for the alarms to be
displayed.
alarm class name
Allows the user to specify a regular expression (see regexp(5))
to be applied against the alarm class name for the alarms to be
displayed.
alarm severity
Allows the user to specify the alarm severity and criteria of the
alarms to be displayed.
alarm type
Allows the user to specify the alarm type of the alarms to be
displayed.
alarm message
Allows the user to specify a regular expression (see regexp(5))
to be applied against the alarm message for the alarms to be
displayed.
The -b argument specifies the background color to use when displaying
alarms (the default is black).
The -i argument specifies the directory where the alarm files are kept
(the default is . (ie. the current directory)). Note that this
application does not attach itself to an RTAP environment, and
therefore, the initial directory is NOT the environment directory.
However, if this application is scheduled from within RTAP, the
startup directory will be the environment directory. If unsure as to
the startup directory, the user should specify a full path name for
this argument.
The -w argument specifies the initial width of the alarm display
window in terms of characters (the default is 80 characters).
The -r argument specifies the initial number of rows displaying alarms
(the default is 20 rows).
The -f argument specifies the font to be used for displaying the alarm
in (the default is as specified for RTAP).
The -v argument specifies the vertical spacing between alarms (the
default is 0 pixels).
The -t argument specifies that the current days alarms should be
displayed on startup.
The -x argument specifies the regular expression to be used when
parsing for the alarm date and time for acknowledge messages. The
default value is:
"[0-9]\{2\}\-[0-9]\{2\}\-[0-9]\{2\}[ ]+\([0-9]\{2\}\):\([[0-9]\{2\}\):\([0-9]\{2\}\)"
This regular expression matches the date first as two digits for the
year, month and day separated by a dash. The order doesn't matter as
the selected date is assumed. The time value immediately follows the
date separated by spaces and is contained as the hour, minute and
seconds separated by a colon. Note that the hour, minute and second
are contained as sub-expressions.
If no match is found in the message, the alarm time from the last
alarm message is used. Note that this could cause unwanted alarms to
be displayed when filtering based on time.
alarmLogDisp displays diagnostic messages at the centre of the screen.
alarmLogDisp was developed by tesserNet Systems Inc.
alarmSeparate(1), RtapEnvTable(4)