forked from docs/docsportal
44 lines
1.7 KiB
ReStructuredText
44 lines
1.7 KiB
ReStructuredText
=============
|
|
Notifications
|
|
=============
|
|
|
|
Zulip as official OTC communication channel supports API interface for pushing
|
|
the notifications from ApiMon to various Zulip streams:
|
|
|
|
- #Alerts Stream
|
|
- #Alerts-Hybrid Stream
|
|
- #Alerts-Preprod Stream
|
|
|
|
Every stream contains topics based on the service type (if represented by
|
|
standalone Ansible playbook) and general apimon_endpoint_monitor topic which
|
|
contains alerts of GET queries towards all services.
|
|
|
|
If the error has been acknowledged on Alerta, the new notification message for
|
|
repeating error wont get posted again on Zulip.
|
|
|
|
Notifications contain further details which help to identify root cause faster
|
|
and more effectively.
|
|
|
|
The ApiMon notification consists of several fields:
|
|
|
|
- **APIMon Alert link** - reference to alert in Alerta
|
|
- **Status** - Status of the alert in Alerta
|
|
- **Environment** - information about affected environment/region
|
|
- **Severity** - severity of the alarm
|
|
- **Origin** - information about origin location from where the job has been executed
|
|
- **Service** - information about affected service and type of monitoring
|
|
- **Resource** - further details in which particular resource issue has happened
|
|
- **Error message Summary** - Short description of error result
|
|
- **Execution Log link** - reference to job execution output on Swift object storage
|
|
|
|
Th EpMon notification consists of several fields:
|
|
|
|
- **APIMon Alert link** - reference to alert in Alerta
|
|
- **Environment** - information about affected environment/region
|
|
- **Curl command** - interpreted request in curl format for reproducible applications
|
|
- **Request error response** - Error result of the requested API call
|
|
|
|
|
|
|
|
.. image:: training_images/zulip_notifications.png
|