Alarms

Alarm (sometimes referred to as Incident) is an emergency situation that was detected on an object or a link during monitoring process.

Detected alarms are displayed in the alarms interface. You can also display historic alarms in the alarms interface. You can open alarms page with the button on the views panel.

You can configure alarm levels on the Incidents page of the system configuration.

You can manually or automatically clear an alarm to move it to alarm history.

Alarms generation

The system has two ways of generating an alarm – either setting an entity to an alarm state or meeting an alarm generation conditions.

Set object to an alarm state

The system generates an alarm for every entity whose state is set to one with defined severity.

In this case, every object can generate only one alarm.

An entity can change state using State change conditions.

You can set alarm severity can in the System configuration window, on the States tab.

By default the following states have pre-set alarm severity:

ALARM → ALARM
OVERLOADED → WARNING
NO DATA → MAJOR
DOWN → MAJOR

The incident will be cleared – CLEARED – if the object changes its state to any without selected alarm severity.

When an object inherits an alarm state from its children, a new alarm for the parent object is not generated.

Alarm generation conditions

The system can generate an alarm when object’s Alarm generation conditions are met.

In this case, a single object can generate multiple alarms.

Incident functionality is optional and disabled by default. To enable it, set the following parameters:

in the section Server of the server configuration file:
```
"conditional_incidents_enabled": true
```
in the client configuration file:
```
enableConditionalIncidents: true
```

If alarm generation conditions for the object are set, then the alarm generation on state change will be disabled for this object.

The alarm will be cleared if no Alarm generation conditions defined for this entity are met and the additional clear conditions, if present, are met.

Alarm model

Field Type Description

Field	Type	Description
acknowledgedBy	String	ID of a user who acknowledged the incident.
acknowledgementTimestamp	Integer	A timestamp when the incident was acknowledged.
branchId	String	Condition branch ID. Used for incidents generated by custom incident conditions.
clearTimestamp	Integer	A timestamp when the incident was cleared.
comment	String	Incident’s latest comment.
commentedBy	String	ID of a user who last commented on the incident.
commentTimestamp	Integer	A timestamp when the latest comment was added to an incident.
commentsCount	Integer	Amount of comments on this incident.
count	Integer	Number of times this alarm has been generated.
data	String	Entity’s data.
entityId	String	ID of an entity for which the incident happened.
entityType	Integer	Type of the entity. It’s equal to `1` for objects and `2` for links.
id	String	Incident’s ID.
lastState	String	The ID of the Incident Level that the incident had before it has been marked for clearing.
localTimestamp	Integer	The time the incident occurred.
owner	Object/Link	Information about the entity that triggered the incident.
parentChainId	String	Origin of a link that triggered an incident. Included only for incidents of type `2`.
properties	Array<Key-Value Pair>	A list of incident’s properties.
reason	Object	Reason for an incident generation. See Reason article for more information.
reason.code	Integer	ID of the reason for an incident generation. See the Reason Codes section for a list of all reason code.
reason.data	Object	Additional information about the state change condition.
reason.rootCause	String	Root-cause transition information. See the Root cause section.
reason.branch	Object	Condition that triggered the incident. See the Branch section for more information.
removed	Object	Information about incident removal with the Clear and Remove Incident request.
removed.userId	Object	ID of a user who removed the incident.
removed.timestamp	Object	Time of the incident removal.
state	String	The ID of the current Incident Level.
text	String	Incident’s description.
timestamp	Integer	The timestamp when the incident was registered in the system.
type	Integer	The type of incident. Possible types are: `1` – entity changed state, `2` – incident generation condition was met. `3` – alarm was generated via REST API with the Create Incident request.

acknowledgedBy

String

ID of a user who acknowledged the incident.

acknowledgementTimestamp

Integer

A timestamp when the incident was acknowledged.

branchId

String

Condition branch ID. Used for incidents generated by custom incident conditions.

clearTimestamp

Integer

A timestamp when the incident was cleared.

comment

String

Incident’s latest comment.

commentedBy

String

ID of a user who last commented on the incident.

commentTimestamp

Integer

A timestamp when the latest comment was added to an incident.

commentsCount

Integer

Amount of comments on this incident.

count

Integer

Number of times this alarm has been generated.

data

String

Entity’s data.

entityId

String

ID of an entity for which the incident happened.

entityType

Integer

Type of the entity. It’s equal to 1 for objects and 2 for links.

String

Incident’s ID.

lastState

String

The ID of the Incident Level that the incident had before it has been marked for clearing.

localTimestamp

Integer

The time the incident occurred.

owner

Object/Link

Information about the entity that triggered the incident.

parentChainId

String

Origin of a link that triggered an incident. Included only for incidents of type 2.

properties

Array<Key-Value Pair>

A list of incident’s properties.

reason

Object

Reason for an incident generation. See Reason article for more information.

reason.code

Integer

ID of the reason for an incident generation. See the Reason Codes section for a list of all reason code.

reason.data

Object

Additional information about the state change condition.

reason.rootCause

String

Root-cause transition information. See the Root cause section.

reason.branch

Object

Condition that triggered the incident. See the Branch section for more information.

removed

Object

Information about incident removal with the Clear and Remove Incident request.

removed.userId

Object

ID of a user who removed the incident.

removed.timestamp

Object

Time of the incident removal.

state

String

The ID of the current Incident Level.

text

String

Incident’s description.

timestamp

Integer

The timestamp when the incident was registered in the system.

type

Integer

The type of incident. Possible types are:

1 – entity changed state,
2 – incident generation condition was met.
3 – alarm was generated via REST API with the Create Incident request.