forked from docs/internal-documentation
tischrei
0618989a8a
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com> Co-authored-by: tischrei <tino.schreiber@t-systems.com> Co-committed-by: tischrei <tino.schreiber@t-systems.com>
66 lines
4.0 KiB
ReStructuredText
66 lines
4.0 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.
|
|
|
|
|
|
.. image:: training_images/zulip_notifications.png
|
|
|
|
|
|
If the error has been acknowledged on Alerta, the new notification message for
|
|
repeating error won't get posted again on Zulip.
|
|
|
|
Notifications contain further details which help to identify root cause faster
|
|
and more effectively.
|
|
|
|
Notification parameters
|
|
#######################
|
|
|
|
The ApiMon notification consists of several fields:
|
|
|
|
+---------------------------+------------------------------------------------------------------------+
|
|
| Notification Field | Description |
|
|
+===========================+========================================================================+
|
|
| **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:
|
|
|
|
+----------------------------+------------------------------------------------------------------+
|
|
| Notification Field | Description |
|
|
+============================+==================================================================+
|
|
| **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 |
|
|
+----------------------------+------------------------------------------------------------------+
|