STANDARD: Messages & alarm messages

Last modified by Wim Verheirstraeten on 2023/10/06 18:41

InfluxDB background information

See STANDARD: Metrics data collection for more information about how the InfluxDB is constructed, retention policies, measurements, tags and fields.

Alarm messages

Alarms and alarm messages must be sent to the measurement "messages", within the "autogen" retention policy. It is best practice to only log when an alarm occurs, but also when it is cleared.

Tags

Tags must always be strings (see also our MQTT documentation). An alarm message has the following tags:

Tag	Possible values	Meaning
nodeId	Any string	Use nodeId for identification. See also the metadata standard.
msgType	alarm	Indicates what kind of message this is. For now, the message can be an "alarm". Future expansion is possible.
alarmSeverity	debug info warning error critical undefined	Messages with msgType alarm have a severity assigned to them. debug: Debug alarm messages. info: Information alarm messages, e.g. for when an alarm has been cleared. warning: Typically for when a system has an abnormal condition, but that does not cause to system to stop or go to an error state. error: When a system has an abnormal condition that causes it to stop, but that does not imply damage to the system, such as an overvoltage. critical: When a system has an abnormal condition that causes it to stop and is associated with failure, such as a broken component. undefined: Severity is not (yet) defined.
alarmType	See separate list	The type of alarm. E.g. "overvoltageAlarm" for an overvoltage.

It is important to use these tags for the alarm management and data analysis to work correctly!

Fields

An alarm message must have the following fields:

Tag	Possible values	Meaning
alarmActive	True False	Indicates if an alarm is currently active or not.
msg	Any string	For displaying a predefined message to the end user in Eniris Insights.
endTime	Timestamp	When the alarm was no longer active. Optional field.

Example

Example of how an alarm message is stored in the database:

Standardized alarm types

Alarm type	Meaning
overfrequency
overvoltageL1 overvoltageL2 overvoltageL3
underfrequency
undervoltageL1 undervoltageL2 undervoltageL3