Alerts help page

On this page you can configure rules that will monitor data from pipelines and generate alerts if certain conditions are met. The page is divided into two main parts - a list of the rules on the machine and tabs, where you can find settings for the selected rule as well as its templates.

Note that for any changes to take effect, you need to press the save button in the header of the page.

List view

In the list view you can see basic information about the rules on the machine, and you can sort them by clicking on the columns. There are buttons to add, clone and delete rules at the top.

Clicking on add rule will open a dialog window to set it up. First you select a category according to which the alert will be sent via the notification channels. Next you input a name, this is only for your convenience, so choose something that describes the rule. Last, you can decide whether to set up the rule in basic mode or expert mode.

Basic mode is an easy clicking tool where all the variables are suggested to you. Choose the type of rule you want to create on the left and select the appropriate variables.

In expert mode you need to write the rule in jsonLogic format, but you have much more freedom with the rules you create. To make it easier, you can choose one of the example rules from the categories on the left side of the dialog window and simply edit it with your constants or variables. Please note, that the rules are linked to MQTT topics, messages on individual topics are structured differently and contain different data. We advise using the MQTT viewer page (expert mode), to see what the data actually looks like.

You can learn more about the analytics we generate here.

Tabs

Rules configuration is split into settings tab and beginning, continue and end templates tabs.

In the settings tab you can again change name and alert category. Next you can enable the rule and create a schedule, when the rule should be active, simply by clicking on schedule. This will open a dialog window with the scheduler.

In basic mode you can next change repeated events mode, changing what parts of the event will trigger the rule. Under this you can specify how often can the alert be generated and if the rule reacts to end, after how long the event is evaluated as ended.

In expert mode you once again have more options. Like in basic mode, you can change repeated events mode, changing what parts of the event will trigger the rule. There are no sliders in expert mode, so you can write any number (in seconds). In how often to react to repeated events you can input a list, meaning the alerts will be generated after different intervals. This is only applicable on modes with repeating. For example "60,120,300" would mean generate alert after one minute, then after two minutes and every other alert after five minutes. You can also use 0 in this list, meaning no alerts will be generated.
Lastly you can specify user tags, as dictionary and you can also see the alert file name at the bottom.

In the template tabs you can configure what kind of message should be sent on the corresponding event type (beginning, continue, end). Note that templates that don't correspond to the rule repeated events mode will be disabled. The template can be simple text or you can use pyratemp syntax to introduce variables.