[DOC] expose documentation and Architecture about Alerting to community

Description

the problem: 

the absence of proper documentation about Templates causes troubles and a lot of experiments to write your own Template. this leads to small adoption. 

We need to expose as much as possible from https://confluence.percona.com/display/PMM/Integrated+Alerting
 

Some notes/feedback:  

 

  1. https://www.percona.com/doc/percona-monitoring-and-management/2.x/using/alerting.html#add-an-alert-rule every field should be described - what is expected where, and what is required. What is the expected format of the filter, for example?

  2. When adding an alert template, I see in the docs that some for of format are expected:

  3. If the format must be followed, can it already be pasted into the dialog for creating it? So one doesn’t need to copy it from the docs?

  4. In the docs: https://www.percona.com/doc/percona-monitoring-and-management/2.x/using/alerting.html#add-an-alert-rule-template not all parameters are described, only few

  5. What is the format/language used? That should be named and linked to its description (if it’s not Percona’s proprietary language)

How to test

None

How to document

None

Smart Checklist

Activity

Show:

Catalina Adam February 23, 2022 at 11:27 AM

Updated docs as part of https://github.com/percona/pmm-doc/pull/715#discussion_r811283341. 

This PR was merged into 2.27 and the topic will be published to live when PMM 2.27 goes out (unless we decide to release with Grafana Alerting)

Catalina Adam February 23, 2022 at 11:25 AM

Done

Details

Assignee

Reporter

Priority

Components

Needs QA

Yes

Needs Doc

Yes

Story Points

Smart Checklist

Created August 24, 2021 at 11:15 AM
Updated March 6, 2024 at 2:16 AM
Resolved February 23, 2022 at 11:27 AM