ikvrivis/docsportal_forked
1
0
Fork 0
forked from docs/docsportal
Code Pull Requests Activity

fixing alerts and notifcation content

Browse Source
This commit is contained in:
Hasko, Vladimir 2023-05-21 21:25:32 +00:00
parent 5d25748c82
commit f7ad5765ac
3 changed files with 29 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
doc/source/internal/apimon_training/alerts.rst
View File

@ -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

6
doc/source/internal/apimon_training/faq/how_to_read_the_logs_and_understand_the_issue.rst
View File

@ -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::

3
doc/source/internal/apimon_training/notifications.rst
View File

@ -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