dispose.POOL Stream¶

dispose.POOL stream is a part of Events Pipeline. Message processed by classifier service which may be related with alarm condition are passed to correlator service.

Each system Pool has separate dispose stream instance. i.e. DEFAULT pool will use dispose.DEFAULT stream, while CORE pool will use dispose.CORE stream.

Publishers¶

classifier service.
discovery service.
ping service.

Subscribers¶

correlator service.

Message Headers¶

dispose stream doesn't use additional headers.

Message Format¶

dispose stream carries JSON-encoded messages of several types. The type of message is encoded in the $op field. Unknown message types and malformed messages are discarded.

event message¶

event messages represent classified events that may raise and clear alarms.

Field	Type	Description
`$op`	String	Equals to `event`
`event_id`	String	Registered event id
`event`	Object	Event data

raise message¶

raise message represents a direct alarm rising request, issued by an external mechanism.

Field	Type	Description
`$op`	String	Equals to `raise`
`reference`	String	Alarm reference. See alarm reference format for details
`timestamp`	String	Optional timestamp in ISO 8601 format
`managed_object`	String	Managed Object'd ID. If prefixed with `bi_id:` use BI ID.
`alarm_class`	String	Alarm class name
`groups`	Array of Object	Optional static groups
`reference`	String	Optional Group Alarm reference. See alarm reference format for details
`name`	String	Optional group name
`alarm_class`	String	Optional group alarm class name
`vars`	Object	Alarm variables
`labels`	Array of String	Optional list of alarm labels
`remote_system`	String	Optional Remote System ID
`remote_id`	String	Optional Remote ID

clear message¶

clear message represents a direct alarm clear request, issued by an external mechanism.

Field	Type	Description
`$op`	String	Equals to `clear`
`reference`	String	Alarm reference. Should be the same as in previous raise message.
`timestamp`	String	Optional timestamp in ISO 8601 format

clearid message¶

clearid message represents a direct alarm clear request, issued by an external mechanism.

Field	Type	Description
`$op`	String	Equals to `clearid`
`id`	String	Alarm id
`timestamp`	String	Optional timestamp in ISO 8601 format
`message`	String	Optional closing message
`source`	String	Optional closing source/user

ensure_group message¶

ensure_group message creates and synchronizes group with given set of alarms.

Field	Type	Descriptionn
`$op`	String	Equals to `ensure_group`
`reference`	String	Alarm reference. See alarm reference format for details
`name`	String	Group alarm title
`alarm_class`	String	Optional group alarm class
`labels`	Array of String	Optional list of group alarm labels
`alarms`	Array of Object	List of active alarms
`reference`	String	Alarm reference. See alarm reference format for details
`timestamp`	String	Optional timestamp in ISO 8601 format
`managed_object`	String	Managed Object'd ID
`alarm_class`	String	Alarm class name
`vars`	Object	Alarm variables
`labels`	Array of String	Optional list of alarm labels