Alerts
Learn how to use alerts to monitor your pipelines.
Last updated
Learn how to use alerts to monitor your pipelines.
Last updated
Important information:
To access the Alerts page and use all the features in this article, you need to have permissions ALERT:READ, ALERT:CREATE, ALERT:UPDATE and ALERT:DELETE. Learn more in the Roles documentation.
The default Support, Developers, and Governance Manager groups already have them, but if you prefer, you can add the system role to your access group.
To access the alerts page, you must be part of groups that are bound to the Alert Manager system role, such as the Support and Governance Manager default groups.
Alerts work by continuously monitoring your pipelines in real-time and sending you a notification when a pipeline metric falls out of a specified range.
Setting up alerts can help you ensure that problems in your integration flows are quickly identified and fixed to reduce the risk of downtime or data loss.
In the alerts page, you can create, edit, activate and delete alerts.
Currently, these are the pipeline metrics you can use to set up alerts:
This page displays the alerts created for the selected environment. You can change the environment using the environment selector in the upper left corner.
The alerts page displays a table with the following variables:
Alert name: the name assigned to the alert.
It’s not possible to add special characters like "_" to the alert name. The only exception is “-”, which can be used as a substitute for a blank space.
Pipeline: the pipeline to which the alert is assigned.
Status: status of the alert, if activated or deactivated.
When we first create an alert, it’s by default deactivated and needs to be manually activated.
You can perform the following actions on the alerts page:
The alert is related to the Major version of the deployed pipeline. If your pipeline has more than one Major version, you must create an alert for each Major version in your pipeline.
However, this does not apply to the Minor versions of the pipeline, that is, if a pipeline has more than one Minor version, the configured alert remains valid for its Major version.
In this article you can find more information about pipeline versioning.
These alerts apply to all pipelines deployed in each realm. Once the alert is configured, all pipelines can generate a notification as long as they reach the threshold for the selected and configured metric.
To learn more about the available metrics, read our documentation.
