Difference between revisions of "/Alarms ODB tree"

From MidasWiki
Jump to navigation Jump to search
m
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<div style="column-count:4;-moz-column-count:4;-webkit-column-count:4">
+
{{Pagelinks}}
* [[Midas_documentation|Midas Documentation]]
 
* [[Feature_listing|Feature Listing]]
 
* [[Application_listing|Application Listing]]
 
* [[Online_Database|Online Database]]
 
</div>
 
 
 
  
 
= Links =
 
= Links =
Line 15: Line 9:
 
</div>
 
</div>
 
= Purpose =
 
= Purpose =
The ODB /Alarms tree contains user and system information related to alarms (see [[Alarm System]]).
+
The ODB /Alarms tree contains user and system information related to alarms (see [[Alarm System]]). The information from this tree is displayed in the [[Alarms Page]].
  
 
= Creating the /Alarms tree =
 
= Creating the /Alarms tree =
Line 24: Line 18:
 
These are shown in the [[#Example of an /Alarms tree|example below]].
 
These are shown in the [[#Example of an /Alarms tree|example below]].
  
The user may create other alarms and classes by copying an existing <alarm-name> or <alarm-class> subtree and editing as required.
+
The user may create other alarms and classes by copying an existing <alarm-name> or <alarm-class> subtree and editing (via [[Alarms Page]] or [[odbedit]]) as required.
 
 
By default, the [[Alarm System]] is NOT active
 
Currently, the overall alarm is checked once every minute. Once the alarm has been triggered, the message associated with the alarm can be repeated at a different rate.  
 
  
 +
By default, the [[Alarm System]] is NOT active. When it is active,
 +
the overall alarm is checked once every minute. Once the alarm has been triggered, the message associated with the alarm can be repeated at a different rate.
  
= Examples =
 
== Default /Alarms tree ==
 
  
This /Alarms tree is shown using [[odbedit]] (see also mhttpd Alarm page).
+
= Example =
 +
This example (using [[odbedit]]) shows the  default <span style="color: purple; font-style:italic;">/Alarms</span> tree. See also [[Alarms Page]].
  
 
  $ odbedit
 
  $ odbedit
Line 106: Line 98:
  
  
 +
= /Alarms tree structure =
 +
The <span  style="color: purple;">/Alarms</span> ODB tree is split into 2 subtrees:
 +
* [[#Alarms subtree|Alarms subtree]] containing as many alarms (i.e. <span  style="color: purple;"><alarm-name></span> subtrees) as the user desires. Each alarm must be one of the four defined [[Alarm System#Alarm Types|Alarm Types]]. These also define the conditions that trigger the alarm.
 +
* [[#Classes subtree|Classes subtree]] containing as many classes (i.e. <span  style="color: purple;"><class-name></span> subtrees)  as the user desires. Each class defines the action to be taken when the alarm occurs. Two Classes (Alarm and Warning) are defined by default (see [[#Example|Example]]).
  
 +
See also [[Alarm System]].
  
== Alarm triggering Email or SMS alerts ==
 
 
It is also possible to have the MIDAS alarm system send email or SMS alerts to cell phones when alarms are triggered. This can be configured by defining an ODB alarm on a critical ODB parameter, e.g.
 
 
/Alarms/Alarms/Liquid Level
 
Active                  y
 
Triggered                0 (0x0)
 
Type                    3 (0x3)
 
Check interval          60 (0x3C)
 
Checked last    1227690148 (0x492D10A4)
 
Time triggered first    (empty)
 
Time triggered last    (empty)
 
Condition              /Equipment/Environment/Variables/Input[0] < 10
 
Alarm Class            Level Alarm
 
Alarm Message          Liquid Level is only %s
 
 
In this example, the alarm triggers an alarm of class "Level Alarm". This alarm class is defined as follows:
 
 
/Alarms/Classes/Level Alarm
 
Write system message    y
 
Write Elog message      n
 
System message interval 600 (0x258)
 
System message last    0 (0x0)
 
Execute command        /home/midas/level_alarm '%s'
 
Execute interval        1800 (0x708)
 
Execute last            0 (0x0)
 
Stop run                n
 
Display BGColor        red
 
Display FGColor        black
 
 
The key here is to call a script "level_alarm", which can send emails. Use something like:
 
 
#/bin/csh
 
echo $1 | mail -s \"Level Alarm\" your.name@domain.edu
 
odbedit -c 'msg 2 level_alarm \"Alarm was sent to your.name@domain.edu\"'
 
 
The second command just generates a MIDAS system message for confirmation. Most cell phones (depends on the provider) have an email address. If you send an email there, it will be translated into a SMS message.
 
 
The script file above can of course be more complicated. A perl script could be used that parses an address list, so other interested parties can register by adding his/her email address to that list. The script may also collects some other slow control variables (like pressure, temperature) and combine them into the SMS message.
 
 
For very sensitive systems, having an alarm via SMS may not be sufficient, since the alarm system could be down (e.g. computer crash, network failure). In this case 'negative alarms' can be used. For example, every 30 minutes the system may send an SMS with the current parameter values. If the expected message is not received, it may indicate that something in the MIDAS system is wrong.
 
 
 
 
<div id="Alarm class"></div>
 
= /Alarms tree structure =
 
The Alarms structure is split into 2 sections:
 
*"Alarms" which define the condition to be tested. The user can create as many Alarms as desired, but each must be one of the four defined Alarm Types .
 
*"Classes" which define the action to be taken when the alarm occurs. Two Classes (Alarm and Warning) are defined by default. The user can add more [[#Classes subtree|Classes]] as desired.
 
 
<br><br>
 
<br><br>
 
In order to make the system flexible, each alarm class may perform different actions when an alarm is given. For example, it may
 
* write a system message (see [[#Write System Message|Write System Message]])
 
* write to the elog (see [[#Write Elog Message|Write Elog Message]])
 
* stop the run (see [[#Stop run|Stop run]])
 
* spawn a detached script listed in the ODB variable [[#Execute command|Execute command]]. This feature is used when an Alarm triggers Email or SMS alerts (see [[#Alarm triggering Email or SMS alerts|example]]).
 
<br>
 
'''<div id="Alarm Type"></div>'''
 
 
The four available Alarm Types are shown in Table 1. They are defined in [http://ladd00.triumf.ca/~daqweb/doc/midas-old/html/midas_8h.html&nbsp midas.h]. The alarm type is entered into the [[/Alarms ODB tree#Type|Type]] key.
 
 
 
{|  style="text-align: left; width: 100%; background-color: white;" border="3" cellpadding="2" cellspacing="2"
 
|+ Table 1 : Defined Alarm Types
 
|-
 
| colspan="2" rowspan="1" style="vertical-align: top; background-color: lavender; font-weight: bold;" | Alarm Type
 
| colspan="1" rowspan="1" style="vertical-align: top; background-color: lavender; font-weight: bold;" | INT value
 
| colspan="1" rowspan="1" style="vertical-align: top; background-color: lavender; font-weight: bold;" | Explanation
 
 
|- 
 
| colspan="1" rowspan="1"  style="vertical-align: top; background-color: white; font-weight: bold;"  |Internal alarms
 
| colspan="1" rowspan="1"  style="vertical-align: top; background-color: white; font-weight: normal;" | AT_INTERNAL
 
|1
 
|Trigger on internal (program) alarm setting through the use of the al_...() functions.
 
 
|- 
 
| style="vertical-align: top; background-color: white; font-weight: bold;" |Program alarms
 
|AT_PROGRAM
 
|2
 
|Triggered on condition of the state of the defined task.
 
 
|- 
 
| style="vertical-align: top; background-color: white; font-weight: bold;" |Evaluated alarms
 
|AT_EVALUATED
 
|3
 
|Triggered by ODB value on given arithmetical condition.
 
 
|- 
 
| style="vertical-align: top; background-color: white; font-weight: bold;" |Periodic alarms
 
|AT_PERIODIC
 
|4
 
|Triggered by timeout condition defined in the alarm setting.
 
 
|}
 
 
 
== Program Alarm ==
 
The Program Alarms are enabled for individual programs by setting [[/Programs ODB tree#Alarm class|Alarm class]] in the ODB <span style="color: purple; font-style:italic;">/Programs/<program></span> subtree. See [[Alarm System]]
 
for details.
 
 
== Periodic Alarm ==
 
The periodic alarm is activated periodically according to the time in [[#Check interval|Check interval]]. An example of a periodic alarm is "Demp Periodic" in the  [[#Default /Alarms tree|example above]].
 
 
== Evaluated Alarm conditions ==
 
 
The alarm condition for evaluated alarms is entered into the ODB key [[#Condition|Condition]] in the  [[#<alarm_name> subtree|<alarm_name> subtree]].
 
The condition may be simply a '''comparison''' between any ODB variable and a threshold parameter, e.g.
 
 
/Runinfo/Run number > 100
 
or it may be an '''evaluated condition'''. One can write conditions like
 
 
  /Equipment/HV/Variables/Input[*] < 100
 
or
 
 
  /Equipment/HV/Variables/Input[2-3] < 100
 
to check all values from an array or a certain range. If one array element fulfills the alarm condition, the alarm is triggerrd. In addition, bit-wise alarm conditions are possible, e.g.
 
 
  /Equipment/Environment/Variables/Input[0] & 8
 
The alarm is triggered if bit #2 is set in Input[0].
 
 
== Internal Alarms ==
 
These 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()]. See also [[Alarm System#Implementation of the MIDAS Alarm System|Alarm System]].
 
  
 
= Keys in the  <span  style="color: purple;">''/Alarms''</span> ODB tree  =
 
= Keys in the  <span  style="color: purple;">''/Alarms''</span> ODB tree  =
Line 416: Line 291:
  
  
This key in the [[#<alarm-name> subtree|<alarm-name> subtree]] is set to one of the existing Alarm classes, e.g. "Alarm","Warning".
+
This key in the [[#<alarm-name> subtree|<alarm-name> subtree]] is set to one of the existing Alarm classes, e.g. the defaults "Alarm","Warning" or a user-defined class, e.g. "Caution".
 
The Alarm class must be defined in the [[#<class-name> subtree|Classes subtree]].  
 
The Alarm class must be defined in the [[#<class-name> subtree|Classes subtree]].  
  
Line 459: Line 334:
 
</div>  
 
</div>  
  
This subtree in the [[#Classes subtree]] defines one of the alarm classes of name ''name'', where ''name'' is substituted for <class-name>. This subtree will be repeated with a different name for each defined class. In the [[#Example of an /Alarms tree|example above]], two <class-name> subtrees are shown, named "Alarm" and "Warning".   
+
This subtree in the [[#Classes subtree|Classes subtree]] defines one of the alarm classes of name ''name'', where ''name'' is substituted for <class-name>. This subtree will be repeated with a different name for each defined class. In the [[#Example of an /Alarms tree|example above]], two <class-name> subtrees are shown, named "Alarm" and "Warning".   
  
  
Line 510: Line 385:
 
   
 
   
 
This key in the [[#<class-name> subtree|<class-name> subtree]] contains the  
 
This key in the [[#<class-name> subtree|<class-name> subtree]] contains the  
interval in seconds between successive system messages when an alarm with this  [[#Alarm class|alarm class]] is triggered
+
interval in seconds between successive system messages when an alarm with this  [[#Alarm class|alarm class]] is triggered.
  
See also [[Alarm System#Implementation of the MIDAS Alarm System]] for note on the implementation of this key by the alarm system.
+
Set this key to 0 to ensure that every alarm is recorded into the [[Message System#MIDAS Log file|MIDAS log file]].
 +
 
 +
'''See important note ''' on the [[Alarm System#Implementation of the MIDAS Alarm System|implementation of this key]] by the alarm system.
  
 
<br>
 
<br>
Line 551: Line 428:
  
  
 +
====  <span  style="color: purple;">''Execute interval''</span> ====
 +
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
 +
* '''Type:''' INT
 +
* '''Default:'''  0
 +
</div>
 +
 +
When an alarm with this  [[#Alarm class|alarm class]] is triggered, if a valid
 +
[[#Execute command|Execute command]] is supplied, the command will be repeated at an interval in seconds designated by this key in the [[#<class-name> subtree|<class-name> subtree]], providing the interval set is greater than 0.
 +
 +
 +
 +
 +
<br>
 +
---------
 +
<br>
  
 
====  <span  style="color: purple;">''Execute last''</span> ====
 
====  <span  style="color: purple;">''Execute last''</span> ====
Line 592: Line 484:
  
 
This key in the [[#<class-name> subtree|<class-name> subtree]] contains the
 
This key in the [[#<class-name> subtree|<class-name> subtree]] contains the
background colour of alarm banner ([[mhttpd|mhttpd only]]).
+
background colour of the alarm banner on the [[mhttpd]] [[Status Page]]. The alarm banner
 +
appears if the alarm is triggered.
  
  
Line 609: Line 502:
  
 
This key in the [[#<class-name> subtree|<class-name> subtree]] contains the
 
This key in the [[#<class-name> subtree|<class-name> subtree]] contains the
foreground colour of alarm banner ([[mhttpd|mhttpd only]]).
+
foreground colour of the alarm banner on the [[mhttpd]] [[Status Page]].  The alarm banner
 +
appears if the alarm is triggered.
  
 
[[Category:ODB Tree]]
 
[[Category:ODB Tree]]
 
[[Category:Alarms]]
 
[[Category:Alarms]]

Latest revision as of 15:57, 6 August 2015


Links

Purpose

The ODB /Alarms tree contains user and system information related to alarms (see Alarm System). The information from this tree is displayed in the Alarms Page.

Creating the /Alarms tree

When the ODB is created, the /Alarms tree is automatically created, with

These are shown in the example below.

The user may create other alarms and classes by copying an existing <alarm-name> or <alarm-class> subtree and editing (via Alarms Page or odbedit) as required.

By default, the Alarm System is NOT active. When it is active, the overall alarm is checked once every minute. Once the alarm has been triggered, the message associated with the alarm can be repeated at a different rate.


Example

This example (using odbedit) shows the default /Alarms tree. See also Alarms Page.

$ odbedit
[local:pol:S]/>cd /alarms
[local:pol:S]/Alarms>ls
Alarm system active             y
Alarms
Classes
[local:pol:S]/Alarms>ls -r -lt
Key name                        Type    #Val  Size  Last Opn Mode Value
---------------------------------------------------------------------------
Alarms                          DIR
   Alarm system active         BOOL    1     4     4h   0   RWD  y
   Alarms                      DIR
       Demo ODB                DIR
           Active              BOOL    1     4     >99d 0   RWD  n
           Triggered           INT     1     4     >99d 0   RWD  0
           Type                INT     1     4     >99d 0   RWD  3
           Check interval      INT     1     4     >99d 0   RWD  60
           Checked last        DWORD   1     4     >99d 0   RWD  0
           Time triggered firstSTRING  1     32    >99d 0   RWD
           Time triggered last STRING  1     32    >99d 0   RWD
           Condition           STRING  1     256   >99d 0   RWD  /Runinfo/Run number > 100
           Alarm Class         STRING  1     32    >99d 0   RWD  Alarm
           Alarm Message       STRING  1     80    >99d 0   RWD  Run number became too large
       Demo periodic           DIR
             Active              BOOL    1     4     >99d 0   RWD  n
           Triggered           INT     1     4     >99d 0   RWD  0
           Type                INT     1     4     >99d 0   RWD  4
           Check interval      INT     1     4     >99d 0   RWD  28800
           Checked last        DWORD   1     4     >99d 0   RWD  1058817867
           Time triggered firstSTRING  1     32    >99d 0   RWD
           Time triggered last STRING  1     32    >99d 0   RWD
           Condition           STRING  1     256   >99d 0   RWD
           Alarm Class         STRING  1     32    >99d 0   RWD  Warning
           Alarm Message       STRING  1     80    >99d 0   RWD  Please do your shift checks
     fePOL                   DIR
           Active              BOOL    1     4     19s  0   RWD  y
           Triggered           INT     1     4     19s  0   RWD  205
           Type                INT     1     4     3s   0   RWD  2
           Check interval      INT     1     4     19s  0   RWD  60
           Checked last        DWORD   1     4     19s  0   RWD  1259196026
           Time triggered firstSTRING  1     32    19s  0   RWD  Wed Nov 25 12:59:33 2009
           Time triggered last STRING  1     32    19s  0   RWD  Wed Nov 25 16:40:26 2009
           Condition           STRING  1     256   3s   0   RWD  Program not running
           Alarm Class         STRING  1     32    19s  0   RWD  Caution
           Alarm Message       STRING  1     80    19s  0   RWD  Program fePOL is not running
 Classes                      DIR
       Alarm                   DIR
           Write system messageBOOL    1     4     27h  0   RWD  y
           Write Elog message  BOOL    1     4     27h  0   RWD  n
           System message interINT     1     4     27h  0   RWD  60
           System message last DWORD   1     4     27h  0   RWD  0
           Execute command     STRING  1     256   27h  0   RWD
           Execute interval    INT     1     4     27h  0   RWD  0
           Execute last        DWORD   1     4     27h  0   RWD  0
           Stop run            BOOL    1     4     27h  0   RWD  n
           Display BGColor     STRING  1     32    27h  0   RWD  red
           Display FGColor     STRING  1     32    27h  0   RWD  black
       Warning                 DIR
           Write system messageBOOL    1     4     >99d 0   RWD  y
           Write Elog message  BOOL    1     4     >99d 0   RWD  n
           System message interINT     1     4     >99d 0   RWD  60
           System message last DWORD   1     4     >99d 0   RWD  0
           Execute command     STRING  1     256   >99d 0   RWD
           Execute interval    INT     1     4     >99d 0   RWD  0
           Execute last        DWORD   1     4     >99d 0   RWD  0
           Stop run            BOOL    1     4     >99d 0   RWD  n
           Display BGColor     STRING  1     32    >99d 0   RWD  red
           Display FGColor     STRING  1     32    >99d 0   RWD  black


/Alarms tree structure

The /Alarms ODB tree is split into 2 subtrees:

  • Alarms subtree containing as many alarms (i.e. <alarm-name> subtrees) as the user desires. Each alarm must be one of the four defined Alarm Types. These also define the conditions that trigger the alarm.
  • Classes subtree containing as many classes (i.e. <class-name> subtrees) as the user desires. Each class defines the action to be taken when the alarm occurs. Two Classes (Alarm and Warning) are defined by default (see Example).

See also Alarm System.



Keys in the /Alarms ODB tree

Alarm system active

  • Type: BOOL
  • Default: "n"

If this key in the /Alarms ODB tree is set to "y", the alarm system is active. Set to "n" to deactivate.





Alarms subtree

  • Type: DIR


Sub-tree in the /Alarms ODB tree defining each individual alarm condition.






<alarm-name> subtree

  • Type: DIR


This subtree in the /Alarms/alarms subtree specifies the name of one of the defined alarms, where name is substituted for <alarm-name>. This subtree will be repeated with a different name for each defined alarm. In the example two <alarm-name> subtrees are shown, called "demo odb" and "demo periodic"






Active

  • Type: BOOL
  • Default: "n"

If this key in the <alarm-name> subtree is set to "y" , this particular alarm is active.







Triggered

  • Type: INT
  • Default: 0

If this key in the <alarm-name> subtree is non-zero, this alarm has been triggered. Filled by System.







Type

  • Type: INT
  • Default:

This key in the <alarm-name> subtree must be one of the listed Alarm Types.






Check interval

  • Type: INT
  • Default: 60


This key in the <alarm-name> subtree contains the frequency in seconds at which this alarm condition is to be checked by the alarm system.






Checked last

  • Type: DWORD
  • Default:


This key in the <alarm-name> subtree is written by the Alarm System.







Time triggered first

  • Type: STRING
  • Default:


This key in the <alarm-name> subtree is written by the Alarm System.






Time triggered last

  • Type: STRING
  • Default:


This key in the <alarm-name> subtree is written by the Alarm System.







Condition

  • Type: STRING
  • Default:


This key in the <alarm-name> subtree contains the condition on which alarm should trigger for evaluated alarms. See #Evaluated Alarm conditions.






Alarm class

  • Type: STRING
  • Default:


This key in the <alarm-name> subtree is set to one of the existing Alarm classes, e.g. the defaults "Alarm","Warning" or a user-defined class, e.g. "Caution". The Alarm class must be defined in the Classes subtree.





Alarm message

  • Type: STRING
  • Default:

This key in the <alarm-name> subtree constains the message to be written when alarm triggers.






Classes subtree

  • Type: DIR

Sub-tree in the /Alarms ODB tree defining each individual alarm class. Each class defines the individual action to be performed by a predefined and requested alarm.





<class-name> subtree

  • Type: DIR

This subtree in the Classes subtree defines one of the alarm classes of name name, where name is substituted for <class-name>. This subtree will be repeated with a different name for each defined class. In the example above, two <class-name> subtrees are shown, named "Alarm" and "Warning".






Write System Message

  • Type: BOOL
  • Default: "y"


If this key in the <class-name> subtree is set to "y", a message will be sent to the System log when an alarm with this alarm class is triggered.





Write Elog Message

  • Type: BOOL
  • Default: "n"


If this key in the <class-name> subtree is set to "y", a message will be written to the Elog when an alarm with this alarm class is triggered.







System message interval

  • Type: INT
  • Default: 60

This key in the <class-name> subtree contains the interval in seconds between successive system messages when an alarm with this alarm class is triggered.

Set this key to 0 to ensure that every alarm is recorded into the MIDAS log file.

See important note on the implementation of this key by the alarm system.




System message last

  • Type: DWORD
  • Default: 0

This key in the <class-name> subtree contains the time when the last alarm system message was written. It is filled by the alarm system.






Execute command

  • Type: STRING
  • Default: ""

This key in the <class-name> subtree may contain a command to be executed when an alarm with this alarm class is triggered. This parameter can be used to trigger Email or SMS alerts.






Execute interval

  • Type: INT
  • Default: 0

When an alarm with this alarm class is triggered, if a valid Execute command is supplied, the command will be repeated at an interval in seconds designated by this key in the <class-name> subtree, providing the interval set is greater than 0.






Execute last

  • Type: DWORD
  • Default: 0

This key in the <class-name> subtree contains the time when the alarm system last executed the command in the key Execute command. It is filled by the alarm system.






Stop run

  • Type: BOOL
  • Default: "n"

This key in the <class-name> subtree if set to "y" will cause the run to stop when an alarm with this alarm class is triggered.






Display BGColor

  • Type: STRING
  • Default: "red"

This key in the <class-name> subtree contains the background colour of the alarm banner on the mhttpd Status Page. The alarm banner appears if the alarm is triggered.






Display FGColor

  • Type: STRING
  • Default: "black"

This key in the <class-name> subtree contains the foreground colour of the alarm banner on the mhttpd Status Page. The alarm banner appears if the alarm is triggered.