From 8bee665b088f983038bfb27a167635491b30cfce Mon Sep 17 00:00:00 2001 From: Vladimir Hasko Date: Wed, 24 May 2023 16:39:44 +0000 Subject: [PATCH] extending notifications content --- .../apimon_training/notifications.rst | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/doc/source/internal/apimon_training/notifications.rst b/doc/source/internal/apimon_training/notifications.rst index 0c0262e..bfbb123 100644 --- a/doc/source/internal/apimon_training/notifications.rst +++ b/doc/source/internal/apimon_training/notifications.rst @@ -16,4 +16,28 @@ 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