Alarm System: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
(The midas documentation has moved to https://midas.triumf.ca/docs/)
Tag: Replaced
 
(23 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<div style="column-count:4;-moz-column-count:4;-webkit-column-count:4">
The midas documentation has moved. The new documentation about the alarm system is in:
* [[Midas_documentation|Midas Documentation]]
* [https://midas.triumf.ca/docs/develop/features/monitoring_and_control/alarms/ Alarms: overview] (alarms and alarm classes, web interfaces)
* [[Feature_listing|Feature Listing]]
* [https://midas.triumf.ca/docs/develop/features/monitoring_and_control/alarms/configuring/ Alarms: configuring] (alarm types, and scripts that send email, Slack, Telegram, Mattermost or phone alerts)
* [[Application_listing|Application Listing]]
* [https://midas.triumf.ca/docs/develop/features/monitoring_and_control/alarms/programming/ Alarms: programming] (implementation details and the alarm functions)
* [[Online_Database|Online Database]]
</div>
 
 
= Links =
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
* [[/Alarms ODB tree]]
* [[Alarms Page]]
* [[Mhttpd|mhttpd MIDAS web server]]
</div>
 
= Introduction =
MIDAS provides an alarm system, which by default is turned off. When the alarm system is [[/Alarms ODB tree##Alarm system active|activated]] and an alarm condition is detected, alarm messages are sent by the system which appear as an alarm banner on the [[Status Page|mhttpd status page]], and as a message on any windows running [[odbedit]] clients. The alarm system is flexible and can be extensively customized for each experiment
using the [[Alarms Page|mhttpd Alarms Page]] or [[odbedit]].
 
The alarm system is built-in and part of the main experiment scheduler. This means no separate task is necessary to benefit from the alarm system. Its setup and activation is done through the '''[[/Alarms ODB tree]]'''. The alarm system includes several other features such as sequencing and control of the experiment. The alarm capabilities are:
* Alarm setting on any ODB variable against a threshold parameter.
* Alarm triggered by evaluated condition
* Selection of Alarm check frequency
* Selection of Alarm trigger frequency
* Customization alarm scheme; under this scheme multiple choices of alarm type can be selected
* Selection of alarm message destination (to system message log or to elog)
* email or SMS alerts can be sent
* Program control on run transition
 
 
= Implementation of the MIDAS Alarm System =
 
The alarm system source code is [http://ladd00.triumf.ca/~daqweb/doc/midas/doc/html/alarm_8c_source.html alarm.c].
Alarms are checked inside [http://ladd00.triumf.ca/~daqweb/doc/midas/doc/html/group__alfunctioncode.html#gaf31864a8bc5fe779057e81bde12167a9 alarm.c::al_check()]. This function is called by cm_yield() every 10 seconds and by rpc_server_thread(), also every 10 seconds. For remote MIDAS clients, their al_check() issues an RPC_AL_CHECK RPC call into the MIDAS server utility [[mserver]], where rpc_server_dispatch() calls the local al_check(). As result, all alarm checks run inside a process directly attached to the local MIDAS shared memory (inside a local client or inside an mserver process for a remote client). Each and every MIDAS client runs the alarm checks. To prevent race conditions between different MIDAS clients, access to al_check() is serialized using the ALARM semaphore. Inside al_check(), alarms are triggered using
[http://ladd00.triumf.ca/~daqweb/doc/midas/doc/html/group__alfunctioncode.html#gac024cd8160dc8b9418f05a63678f6c68&nbsp al_trigger_alarm()], which in turn calls al_trigger_class(). Inside al_trigger_class(), the alarm is recorded into an elog or into [[Message System|midas.log]] using cm_msg(MTALK).
 
Special note should be made of the ODB setting [[/Alarms ODB tree#System message interval|system message interval]], which has a surprising effect - after an alarm is recorded into system messages (using cm_msg(MTALK)), no record is made of any subsequent alarms until the time interval set by this variable elapses. With default value of 60 seconds, after one alarm, no more alarms are recorded for 60 seconds. Also, because all the alarms are checked at the same time, '''only the first''' triggered alarm will be recorded.
 
As of alarm.c rev 4683, "System message interval" is set to 0 ensures that every alarm is recorded into the MIDAS log file. (In previous revisions, this setting may still miss some alarms).
 
= Types of alarm =
There are four [[/Programs ODB tree#Alarm Type|types of alarm]]:
 
==  ''program not running'' alarms ==
 
These alarms are controlled through the [[/Programs ODB tree]] rather than the [[/Alarms ODB tree]] except of course for the [[/Alarms ODB tree#Alarms class|alarm class]].  All the ODB
keys mentioned in this section are in the <span style="color: purple; font-style:italic;">/Programs/<client-name></span> subtree unless otherwise specified.
 
These alarms are enabled by setting the ODB key [[/Programs ODB tree#Alarm class|Alarm class]] to a valid Alarm class specified in the [[/Alarms ODB tree]]. Each time al_check() runs, every client listed in the <span style="color: purple; font-style:italic;">/Programs</span> ODB tree is tested using "cm_exist()" and if the client is not running, the time of first failure is recorded in the ODB key [[/Programs ODB tree#First failed|First failed]].
 
If the client has not been running for longer than the time set in ODB key [[/Programs ODB tree#Check interval|Check interval]], an alarm is triggered (if enabled by [[/Programs ODB tree#Alarm class|Alarm class]] and the program is restarted (if enabled by [[/Programs ODB tree#Auto restart|Auto restart]]).
 
The "not running" condition is tested every 10 seconds (each time al_check() is called), but the frequency of "program not running" alarms can be reduced by increasing the value of
[[/Programs ODB tree#Check interval|Check interval]]
(default value 60 seconds). This can be useful if  [[/Alarms ODB tree#System message interval|System message interval]] in the specified alarm class subtree is set to zero.
 
==  ''evaluated alarms'' ==
are programmed through the [[/Alarms ODB tree]]. See [[/Alarms ODB tree#Evaluated Alarm conditions|evaluated alarms]].
 
==  ''periodic alarms'' ==
are programmed through the [[/Alarms ODB tree]]. See[[/Alarms ODB tree#Periodic Alarm|periodic alarms]].
 
==  ''internal'' alarms ==
are triggered in a program using a call to
[http://ladd00.triumf.ca/~daqweb/doc/midas/doc/html/group__alfunctioncode.html#gac024cd8160dc8b9418f05a63678f6c68&nbsp al_trigger_alarm()]. The alarm is configured through the [[/Alarms ODB tree]].
 
There is nothing surprising in these alarms. Except "program not running" alarms (see above), each alarm is checked with a time period set by ODB key [[ /Alarms ODB tree#Check interval|Check interval]] in the [[/Alarms ODB tree]]. The value of an evaluated alarm is computed using al_evaluate_condition().
 
= Setting up the Alarm system =
See the [[/Alarms ODB tree]] for details and
[[/Alarms ODB tree#/Alarms tree structure|Alarms tree structure]].  See also [[/Alarms ODB tree#Examples|Examples]].
 
[[Category:Alarms]]

Latest revision as of 22:00, 30 October 2026

The midas documentation has moved. The new documentation about the alarm system is in:

Retrieved from "https://daq00.triumf.ca/MidasWiki/index.php?title=Alarm_System&oldid=3669"