Alarming
DataMiner provides the possibility to define alarm templates. An alarm template is an XML file containing all alarm thresholds for all parameters that support alarming in a DataMiner protocol. For more information about alarm templates in DataMiner, refer to Alarm templates.
Basic configuration
Only a subset of the parameters defined in a protocol should support alarming, to make sure the alarm template overview does not get cluttered with parameters for which monitoring makes no sense. This is because many parameters in a protocol are defined to implement internal protocol logic.
Whether a parameter supports alarming (and therefore will be shown in alarm templates) is determined by the Monitored element in the parameter definition. This defaults to false, meaning that by default parameters do not support alarming.
To configure a parameter so it supports alarming, set Monitored to true in the parameter definition:
<Alarm>
<Monitored>true</Monitored>
</Alarm>
In an alarm template, a user can specify values for different alarm severity levels. In order to avoid users having to spend too much time specifying these values, default values can be provided using the Alarm element of the protocol (which can then be overridden by a user in DataMiner if desired).
It is possible to define default values for the following alarm levels:
| Alarm severity level | Tag |
|---|---|
| - | Info |
| Critical low | CL |
| Major low | MaL |
| Minor low | MiL |
| Warning low | WaL |
| Normal | Normal |
| Warning high | WaH |
| Minor high | MiH |
| Major high | MaH |
| Critical high | CH |
Keep in mind:
- The
Normaltag is optional and is not required to clear an alarm; when a previously alarmed value returns to a non-alarmed state, DataMiner drops the alarm. - Defining default alarm template values does not enable monitoring for the parameter in a new alarm template; it only allows the user to configure the alarm template more quickly by already providing default values. An
Infodefault is the exception: it enables information event generation by default in a new alarm template. - For parameters with measurement type set to
discreetorstring, the low severity levels are not applicable (i.e., only the tagsNormal,WaH,MiH,MaH, andCHcan be used in this case). - For parameters holding discrete values, the discrete value can be used for setting default alarm values. In DataMiner, the corresponding display value (as indicated in the
Displaytag) will be displayed in the alarm template. (See example below.) - The principle mentioned above also applies to column parameters. In this case, DataMiner provides additional functionality. The alarm template allows you to define multiple entries for the same column parameter, but with a different filter. In case an alarm occurs for the column parameter, the parameter description is used in combination with the key in the alarm.
Tip
For more information on how to implement alarming in a protocol, see Alarm element.
Best practices
- Set
Monitoredtotrueonly for parameters that should be available for alarm monitoring, and keep internal or write parameters out of the monitored set. - A parameter that supports alarming must be visualized to the user (i.e., have a position on a page).
- Monitoring must never be applied on parameters of type "write".
Examples
The example below shows a numeric parameter, for which a nominal value of 40 is defined with Normal, and 80 is defined as the warning-high (WaH) threshold. The parameter will only be in alarm when its value crosses that threshold.
<Param id="22" trending="false" save="true">
<Name>CpuUsage</Name>
<Description>CPU Usage</Description>
<Information>…</Information>
<Type>read</Type>
<Interprete>
<RawType>numeric text</RawType>
<LengthType>next param</LengthType>
<Type>double</Type>
</Interprete>
<Display>…</Display>
<Measurement>
<Type>number</Type>
</Measurement>
<Alarm>
<Monitored>true</Monitored>
<Normal>40</Normal>
<WaH>80</WaH>
</Alarm>
</Param>
The example below shows how the discrete value of a parameter can be used for setting default alarm values:
<Param id="10" trending="true">
<Name>OperationalStatus</Name>
<Description>Operational Status</Description>
<Information>…</Information>
<Type>read</Type>
<Interprete>
<RawType>numeric text</RawType>
<LengthType>next param</LengthType>
<Type>double</Type>
</Interprete>
<Display>…</Display>
<Measurement>
<Type>discreet</Type>
<Discreets>
<Discreet>
<Display>OK</Display>
<Value>0</Value>
</Discreet>
<Discreet>
<Display>Alarm</Display>
<Value>1</Value>
</Discreet>
</Discreets>
</Measurement>
<Alarm>
<Monitored>true</Monitored>
<Normal>0</Normal>
<CH>1</CH>
</Alarm>
</Param>
Exception values
In case you want to define default alarm values for exception values, use the value mentioned in the Value tag of the exception and use $ as prefix.
<Interprete>
<RawType>numeric text</RawType>
<LengthType>next param</LengthType>
<Type>double</Type>
<Exceptions>
<Exception id="1" value="-9999">
<Display state="disabled">Invalid</Display>
<Value>-9999</Value>
</Exception>
<Exception id="2" value="-9998">
<Display state="disabled">Transponder disabled</Display>
<Value>-9998</Value>
</Exception>
</Exceptions>
</Interprete>
<Alarm>
<Monitored>true</Monitored>
<WaL>$-9999;$-9998</WaL>
</Alarm>
Note
If no exception values are defined for alarm thresholds, a parameter's alarm will be cleared when it goes from an alarmed value to an exception value. If this default behavior is undesired, exception values will need to be defined for the alarm thresholds. For more information on how exception values are configured in alarm templates, see Configuring alarm thresholds for hybrid parameters.
Threshold
With the threshold option, you can define that when the value of the second parameter is lower than the first, no alarm should be created.
<Alarm options="threshold:102,2206">
Conditional parameter alarming
Alarm monitoring of a parameter can be deactivated based on a condition.
In the example below, if parameter 10003 equals "Not Monitored", the parameter will no longer be monitored until the condition is again not met.
<Alarm>
<Monitored disabledIf="10003,Not Monitored">true</Monitored>
</Alarm>
Note
In case a condition is defined in the protocol, this condition acts as a default condition in the alarm template. This default can be disabled in the alarm template. For more information about using conditions in an alarm template, see Using conditions in an alarm template.