Alerts allow you to alert your end users when a metric reaches a specified threshold. Composer API endpoints can be used to manage (list, create, update, and delete) alert definitions, each describing an alert condition, the schedule by which it is evaluated, and how notification is handled when the alert condition is met. See Alerts API.
This is an experimental feature.
The following prerequisites must be met for Composer alert processing:
The mail service must be correctly configured.
Notification recipients must have valid email addresses specified in their Composer user definitions.
Users that create alert definitions must be granted the ROLE_CREATE_ALERTS (or ROLE_ADMINISTER_ALERTS) privilege. Currently, this privilege not available in the Composer UI, but must be granted using the Composer REST API. Composer administrators are granted this privilege by default.
Users that create alert definitions must have read permission for the data source used in the alert conditions. See About Data Source Permissions.
The users receiving the alert notifications should also have read permission for the data source used in the alert conditions. The condition will not be evaluated for users without read permission for the data source and will not receive any alert notifications. The corresponding alert messages will appear in the scheduler report.
The following limitations currently exist for this experimental feature:
The ROLE_CREATE_ALERTS and ROLE_ADMINISTER_ALERTS privileges are not available in the Composer UI, but must be granted using the Composer REST API. Composer administrators are granted this privilege by default.
The job scheduler console UI does not display alert-related notifications, but the job scheduler REST API does.
There is no Composer UI implementation for alert definition creation and management at this time.
See the following sections: