diff --git a/doc/source/internal/apimon_training/alerts.rst b/doc/source/internal/apimon_training/alerts.rst index 846330a..d110994 100644 --- a/doc/source/internal/apimon_training/alerts.rst +++ b/doc/source/internal/apimon_training/alerts.rst @@ -2,21 +2,30 @@ Alerts ====== -https://alerts.eco.tsi-dev.otc-service.com/ +Alerta is the component of the ApiMon that is designed to integrate alerts +from multiple sources. It supports many different standard sources like Syslog, +SNMP, Prometheus, Nagios, Zabbix, etc. Additioanlly any other type of source +using URL request or command line can be integrated as well. +Native functions like correlation and de-duplication help to manage thousands of +alerts in transparent way and consolidate alerts in proper categories based on +environment, service, resource, failure type, etc. + +Alerta is hosted on https://alerts.eco.tsi-dev.otc-service.com/ . The authentication is centrally managed by LDAP. -- Alerta is a monitoring tool to integrate alerts from multiple sources. -- The alerts from different sources can be consolidated and de-duplicated. -- On ApiMon it is hosted on same instance as Grafana just listening on - different port. -- The Zulip API was integrated with Alerta, to send notification of - errors/alerts on zulip stream. -- Alerts displayed on OTC Alerta are generated either by Executor or by - Grafana. +The Zulip API was integrated with Alerta, to send notification of errors/alerts +on zulip stream. - - “Executor alerts” focus on playbook results, whether playbook has completed or failed. - - “Grafana alerts” focus on breaching the defined thresholds. For example API response time is higher than defined threshold. +Alerts displayed on OTC Alerta are generated either by Executor, Scheduler, +EpMon or by Grafana. + + - “Executor alerts” focus on playbook results, whether playbook has completed + or failed. + - “Grafana alerts” focus on breaching the defined thresholds. For example API + response time is higher than defined threshold. + - "Scheduler alerts" TBD + - "EpMon alerts" provide information about failed endpoint queries with details + of the request in curl form and the respective error response details .. image:: training_images/alerta_dashboard.png - diff --git a/doc/source/internal/apimon_training/faq/how_to_read_the_logs_and_understand_the_issue.rst b/doc/source/internal/apimon_training/faq/how_to_read_the_logs_and_understand_the_issue.rst index 834dcc0..c709f90 100644 --- a/doc/source/internal/apimon_training/faq/how_to_read_the_logs_and_understand_the_issue.rst +++ b/doc/source/internal/apimon_training/faq/how_to_read_the_logs_and_understand_the_issue.rst @@ -8,16 +8,22 @@ accessed from multiple locations: - Zulip notifications: + .. image:: faq_images/zulip_notification_links.jpg + - Alerts in Alerta + .. image:: faq_images/alerta_alerts_detail.png + - Tables in dashboards + .. image:: faq_images/dashboard_log_links.jpg + The logs contain whole ansible playbook output and help to analyse the problem in detail. For example following log detail describes the failed scenario for ECS deployment:: diff --git a/doc/source/internal/apimon_training/notifications.rst b/doc/source/internal/apimon_training/notifications.rst index 052537a..541d191 100644 --- a/doc/source/internal/apimon_training/notifications.rst +++ b/doc/source/internal/apimon_training/notifications.rst @@ -2,7 +2,8 @@ Notifications ============= -You will see notifications of errors on OTC Zulip: +Zulip as officialt OTC communication channels supports API interface for pushing +the notifications from ApiMon to various zulip streams: - #Alerts Stream - #Alerts-Hybrid Stream