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

puting content in the table

Browse Source
This commit is contained in:
Hasko, Vladimir 2023-05-24 17:02:01 +00:00
parent 8bee665b08
commit c8ecb34e4e
4 changed files with 58 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/internal/apimon_training/dashboards.rst
View File

@ -64,7 +64,7 @@ Endpoint Monitoring dashboards uses metrics from GET query requests towards OTC
platform (:ref:`EpMon Overview <epmon_overview>`) and visualize it in:
- General endpoint availability dashboard
- Endpoint dasbhoard response times
- Endpoint dashboard response times
- No Response dashboard
- Error count dashboard

44
doc/source/internal/apimon_training/difference_cmo_fmo.rst
View File

@ -1,34 +1,34 @@
.. _difference_apimon_cmo_fmo:
===================================
========== =======================
Difference ApiMon(CMO)/ApiMon(FMO)
===================================
========== =======================
Due to the ongoing transformation of ApiMon and integration to a more robust
CloudMon there are two operation modes right now. Therefore it's important to
understand what is supported in which mode.
This pages aims to provide navigation links and understand the changes once the
This page aims to provide navigation links and understand the changes once the
transformation is completed and some of the locations will change.
The most important differences are described in the table below:
+-----------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| **Differences** | **ApiMon (CMO)** | **ApiMon(FMO)** |
+=======================+============================================================================================================+==========================================================================+
| Playbook scenarios | https://github.com/opentelekomcloud-infra/apimon-test | https://github.com/stackmon/apimon-tests/tree/main/playbooks |
+-----------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| Dashboards setup | https://github.com/opentelekomcloud-infra/system-config/tree/main/playbooks/templates/grafana/apimon | https://github.com/stackmon/apimon-tests/tree/main/dashboards |
+-----------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| Environment setup | https://github.com/opentelekomcloud-infra/system-config/blob/main/inventory/service/group_vars/apimon.yaml | https://github.com/opentelekomcloud-infra/stackmon-config |
+-----------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| Implementation mode | standalone app | plugin based |
+-----------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| Source of information | opentelekomcloud-infra | stackmon |
+-----------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| Dashboards | https://dashboard.tsi-dev.otc-service.com/ | https://dashboard.tsi-dev.otc-service.com/ |
| | https://dashboard.tsi-dev.otc-service.com/dashboards/f/UaB8meoZk/apimon | https://dashboard.tsi-dev.otc-service.com/dashboards/f/CloudMon/cloudmon |
+-----------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| Documentation | https://confluence.tsi-dev.otc-service.com/display/ES/API-Monitoring | https://stackmon.github.io/ |
| | | https://stackmon-cloudmon.readthedocs.io/en/latest/index.html |
+-----------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
+---------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| **Differences** | **ApiMon (CMO)** | **ApiMon(FMO)** |
+=====================+============================================================================================================+==========================================================================+
| Playbook scenarios | https://github.com/opentelekomcloud-infra/apimon-test | https://github.com/stackmon/apimon-tests/tree/main/playbooks |
+---------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| Dashboards setup | https://github.com/opentelekomcloud-infra/system-config/tree/main/playbooks/templates/grafana/apimon | https://github.com/stackmon/apimon-tests/tree/main/dashboards |
+---------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| Environment setup | https://github.com/opentelekomcloud-infra/system-config/blob/main/inventory/service/group_vars/apimon.yaml | https://github.com/opentelekomcloud-infra/stackmon-config |
+---------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| Implementation mode | standalone app | plugin based |
+---------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| Organization | opentelekomcloud-infra | stackmon |
+---------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| Dashboards | https://dashboard.tsi-dev.otc-service.com/ | https://dashboard.tsi-dev.otc-service.com/ |
| | https://dashboard.tsi-dev.otc-service.com/dashboards/f/UaB8meoZk/apimon | https://dashboard.tsi-dev.otc-service.com/dashboards/f/CloudMon/cloudmon |
+---------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+
| Documentation | https://confluence.tsi-dev.otc-service.com/display/ES/API-Monitoring | https://stackmon.github.io/ |
| | | https://stackmon-cloudmon.readthedocs.io/en/latest/index.html |
+---------------------+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+

2
doc/source/internal/apimon_training/faq/what_are_the_annotations.rst
View File

@ -9,7 +9,7 @@ field can include links to other systems with more detail.
.. image:: faq_images/annotations.jpg
In Cloudmon Dashboards annotations are used to show the JIRA change issue types
In ApiMon Dashboards annotations are used to show the JIRA change issue types
which change the transition from SCHEDULED to IN EXECUTION. This helps to
identify if some JIRA change has negative impact on platform in real time. The
annotations contain several fields which help to correlate the platform behavior

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

@ -21,23 +21,42 @@ 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
+---------------------------+------------------------------------------------------------------------+
| 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:
- **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
+----------------------------+------------------------------------------------------------------+
| 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 |
+----------------------------+------------------------------------------------------------------+
.. image:: training_images/zulip_notifications.png