Sipmon Broker Event Mapping | Sipmon Documentation

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Sipmon Broker uses global mapping tables for events that can be exchanged. This page list properties available for each event type.

NEB

Acknowledgement

The acknowledgement of an incident means that the problem has been taken into account by a user of the monitoring. When the user acknowledges the problem, Sipmon Engine emits an acknowledgement event.

Comment

In several situations, the user has to enter a comment in the Sipmon interface. When they validate it, Sipmon Engine emits a comment event.

Custom variable

A custom variable is essentially a variable with a name and a value. It often comes from Sipmon Engine macros. For Sipmon to work correctly, these custom variables must be sent to Sipmon Broker. Each one is sent thanks to a custom variable event.

Custom variable status

Custom variable status events are generated when a custom variable needs to be updated.

Downtime

This event is emitted by Sipmon Engine when a downtime is set on a resource.

Event handler

Event handlers are optional system commands (scripts or executables) that are run whenever a resource state change occurs. When such a command is configured, an event handler event is emitted by Sipmon Engine. These BBDO events are usually sent when Sipmon Engine is restarted or reloaded.

Flapping status

When the status of a resource is unstable, Sipmon Engine tags it as flapping.

Tag

The tag is a new configuration event currently used for categories and groups.

At the moment, it is used in parallel with group events and other things but in a near future should be more global.

This event is emitted every time a change is made to the configuration of a host and the configuration is deployed.

Host

Host check

This type of event is emitted by Sipmon Engine when a check is performed on a host.

Host dependency

This event is emitted when a dependency between hosts is defined, and the configuration is deployed.

Host group

This event is emitted when a host group is created.

Host group member

This is a configuration event. It is sent just after a hostgroup event to detail members of the group to configure. Even in BBDO v3, we still use the BBDO v2 version of this event.

Host parent

This is a configuration event sent when a host parent is defined. Even in BBDO v3, we still use the BBDO v2 version of this event.

Host status

This is an event emitted by Sipmon Engine when a host has real time modifications (status, output, metrics...).

Instance

This event is emitted by Sipmon Engine when Engine starts to send its configuration or when Engine stops.

Instance status

This event is emitted by Sipmon Engine regularly as a watchdog. This event tells Broker that the poller is still alive (with various other information).

Log entry

Sipmon Engine generates many logs. Some of them are sent to Sipmon Broker to be stored into the database. These logs are sent using log entry events.

Module

Module events are generated when Sipmon Broker modules get loaded or unloaded.

Service

This is a configuration event. It is emitted by Sipmon Engine when a change is made to the configuration of a service, and the configuration is deployed.

Service check

This event is emitted by Sipmon Engine when a check is performed on a service.

Service dependency

This is a configuration event sent when a dependency between services is defined.

Service group

This is a configuration event that is emitted when a service group is created.

Service group member

This is a configuration event. It is sent just after a servicegroup event to detail members of the group to configure. Even in BBDO v3, we still use the BBDO v2 version of this event.

Service status

This is an event emitted by Sipmon Engine when a service has real time modifications.

Instance configuration

Here is a configuration event announcing all the configuration events that are going to be sent by a poller.

Responsive instance

This event is emitted by cbd. It tells if a poller is responsive or not.

Adaptive service

This event was introduced with BBDO v3. It is emitted when a service has its configuration updated on the fly (for example with an external command)

Adaptive host

This event was introduced with BBDO v3. It is emitted when a host has its configuration updated on the fly (for example with an external command).

Severity

This is a configuration event. It defines a severity. This event was introduced with BBDO v3.

Tag

This event comes with BBDO 3. It is used to associate a tag to a resource. There are four types of tag, SERVICEGROUP, HOSTGROUP, SERVICECATEGORY, HOSTCATEGORY. A tag is not associated with a poller, but we must know for internal handling which poller sent the tag, that is why there is a poller_id item in the message.

Storage

Metric

This event is generated by a Storage endpoint to notify that a RRD metric graph should be updated.

Rebuild

Rebuild events are generated when a Storage endpoint detects that some graph should be rebuild. It first sends a rebuild start event (end =3D false), then metric values (metric event with is_for_rebuild set to true) and finally a rebuild end event (end =3D true).

Remove graph

A Storage endpoint generates a remove graph event when some graph must be deleted.

Status

This event is emitted by cbd when a Service Status or a Host Status event is received. It essentially contains a resource with its status.

Metric mapping

This event is emitted by Sipmon Broker when a new service configuration is received. It associates an index ID (the one created for a service - see Index mapping) to a metric ID.

Index mapping

This event is emitted by Sipmon Broker when a new service configuration is received. It associates an ID to the pair (host ID/service ID). This new ID is useful for the service metrics declaration.

Rebuild Message

This event comes with BBDO 3, when some graphs have to be rebuilt. Messages handling these rebuilds are of that type. They replace the old BBDO v2 rebuild message.

Remove Graph Message

This event comes with BBDO 3. When we want to remove graph files, we can use the centengine gRPC API and this call makes cbd generate a Storage::PbRemoveGraphMessage event. There are two possibilities concerning this event. We can remove graphs matching some index data or graphs matching some metric data. It is also possible to mix the two kinds.

BBDO

Version response

This is the negociation message. Each time a BBDO connection is established, this message is sent by the connector and by the acceptor to negociate options.

Ack

Usually, a BBDO sender sends events and a BBDO receiver consumes events. But the sender keeps events until the receiver tells it they have been handled. To do that, the receiver emits an Ack message with the number of events already handled.

Stop

When one side of a BBDO connection is going to exit, it emits a Stop event so that if the other side has events already handled it can send an Ack event.

BAM

BA status event

This event is sent when a BA's status changed.

KPI status event

This event is sent when a KPI's status changed.

Meta service status event

This event is sent when a meta service's status changed.

BA-event event

This event is sent when a new BA event is opened, or an old one is closed.

KPI-event event

This event is sent when a new KPI event is opened, or an old one is closed.