Messaging and Alerting

Table of Contents

Messaging Service Configuration
- Enabling Messaging Services
- String Templates
Triggering Messages and Alerts
- Messaging and Alerting Pipeline Stages
- Setting Properties Upstream

Messaging in Fusion 5.2+ is replaced by Grafana alerts.

Fusion’s messaging services provide implementations to send messages and alerts to any application or device capable of displaying the supported message types.

Messaging Service Configuration

The Message Services as a whole can be configured via the Configurations API with these attributes:

Attribute Description

Attribute	Description
`rateLimit`	The time, in milliseconds, to wait between sending messages on a per-second basis. This does not synchronize throttling between requests.
`storeAllMessages`	Boolean flag that indicates whether messages should be indexed and stored. By default, only scheduled messages are stored, as they need to be retrieved by the scheduler at a later time. Storing all messages can be useful for auditing the system, but it will have an impact on the system storage requirements.

rateLimit

The time, in milliseconds, to wait between sending messages on a per-second basis. This does not synchronize throttling between requests.

storeAllMessages

Boolean flag that indicates whether messages should be indexed and stored. By default, only scheduled messages are stored, as they need to be retrieved by the scheduler at a later time. Storing all messages can be useful for auditing the system, but it will have an impact on the system storage requirements.

Enabling Messaging Services

The logging service is enabled by default, but messaging services must be explicitly enabled.

You can do this through the UI at System > System > Messaging Services, or through the Messaging API.

How to see which messaging services are currently enabled:

curl -u USERNAME:PASSWORD http://FUSION_HOST:FUSION_PORT/api/messaging/service

String Templates

String templates are libraries used for structured text generation outputs. They are a powerful way of doing variable substitution into a provided template using values contained in documents, requests, and contexts. String templates are made available in the Messaging Service System setup, where users can fill in these portions with document or query values from the working system.

Triggering Messages and Alerts

The messaging services can be invoked in several ways:

Via the Scheduler API to send messages at designated intervals.
Via the Messaging API.
Through an index or query pipeline; see Messaging and Alerting Pipeline Stages below.

By default, only scheduled messages are stored. To configure Fusion to store all messages, see Messaging Service Configuration above. The default collection for message storage is system_messages, which is created on startup.

Messaging and Alerting Pipeline Stages

The Messaging Service supports the Set Property Index Stage.

The pipeline stage sends messages and alerts when specific conditions are met. Conditions can be specified using regular expressions, database lookups, and more. Any upstream stage can affect how Fusion behaves when a match occurs, so pay special attention to the order in which stages occur.

Additionally, the Set Property Index Stage allows conditions to be specified before messages are sent.

Setting Properties Upstream

Fusion includes two index pipeline stages that are useful for setting properties on indexed documents so that you can evaluate those properties in one of the messaging stages, either downstream in the index pipeline or in a query pipeline:

The Set Property Index Stage can be used to set a property on a document, or a context, by evaluating one or more simple conditions. It’s an index-only, conditional stage that allows the setting of properties without the use of JavaScript.
The JavaScript Index Stage provides a more sophisticated means of setting properties upstream from the messaging stages.