Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PMM-12287 Document removal of Integrated Alerting in v3 #3430

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions documentation/docs/alert/contact_points.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ To use SMTP with a PMM Docker installation:
- `GF_SMTP_FROM_NAME`: Name to be used when sending out emails.

*NB: If you are using your Gmail’s SMTP credentials as shown above, you will have to generate an app password and fill it in as the value of your $GF_SMTP_PASSWORD variable.*

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This fixes the bullet point rendering.

2. Pass in the `.env` file to Docker run using the `--env-file` flag:
```
docker run --env-file=.env -p 443:443 -p 80:80 perconalab/pmm-server:3.0.0-beta
Expand Down Expand Up @@ -122,7 +123,7 @@ A policy will match an alert if the alert’s labels match all the matching labe
This can be useful, for example, when you want to send notifications to a catch-all contact point as well as to one of more specific contact points handled by subsequent policies.
6. Toggle **Override grouping** if you do not want to use root policy grouping.
7. Toggle **Override general timings** to specify how often you want to wait until the initial notification is sent for a new group. When this is disabled, PMM uses root policy group timings instead.
8. Add a mute timing if you want to mute notifications or this policy for a specific, regular interval. For example, you can create a mute to suppress trivial notifications during weekends. Mute timings are different from silences in the sense that they are recurring, while silences have a fixed start and end time.
8. Add a mute timing if you want to mute notifications or this policy for a specific, regular interval. For example, you can create a mute to suppress trivial notifications during weekends. Mute timings are different from silences in the sense that they are recurring, while silences have a fixed start and end time.

!!! caution alert alert-warning "Important"
Time specified in mute timing must be in UTC and military format i.e. 14:00 not 2:00 PM.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Military is not a well-known term, so I removed it to avoid confusion.

Time specified in mute timing must be in UTC format, i.e. 14:00, not 2:00 PM.
2 changes: 1 addition & 1 deletion documentation/docs/alert/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ Percona Alerting is powered by Grafana infrastructure. It leverages Grafana's ad
Depending on the datasources that you want to query, and the complexity of your required evaluation criteria, Percona Alerting enables you to create the following types of alerts:

- **Percona templated alerts**: alerts based on a set of Percona-supplied templates with common events and expressions for alerting.
If you need custom expressions on which to base your alert rules, you can also create your own templates.
If you you want to use custom expressions for the alert rules, you can create your own alert rule templates.
- **Grafana managed alerts**: alerts that handle complex conditions and can span multiple different data sources like SQL, Prometheus, InfluxDB, etc. These alerts are stored and executed by Grafana.
2 changes: 1 addition & 1 deletion documentation/docs/configure-pmm/alertmanager.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Alertmanager manages alerts, de-duplicating, grouping, and routing them to the a
This section lets you configure how VictoriaMetrics integrates with an external Alertmanager.

!!! hint alert alert-success "Tip"
If possible, use [Integrated Alerting](../alert/index.md) instead of Alertmanager.
If possible, use [Percona Alerting](../alert/index.md) instead of Alertmanager.

- The **Alertmanager URL** field should contain the URL of the Alertmanager which would serve your PMM alerts.
- The **Prometheus Alerting rules** field is used to specify alerting rules in the YAML configuration format.
Expand Down
19 changes: 16 additions & 3 deletions documentation/docs/release-notes/3.0.0_Beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,20 @@ This release introduces major breaking API changes:

For detailed information about all these API changes and new endpoints, see the [PMM API documentation](https://percona-pmm.readme.io/v3/reference/release-notes-3-0-0-beta).

### New upgrade environment variables
### Removal of Integrated Alerting

This release removes what was known as "Integrated Alerting" in PMM 2.x. This feature was based on Grafana's built-in alerting system and was replaced by Percona Alerting in PMM 3.x.

Percona Alerting is a more powerful and flexible alerting system that leverages Grafana's advanced alerting capabilities and provides pre-configured Alert Rule Templates that simplify creating powerful alerting rules.

This change has led to the removal of the **Alertmanager** configuration page in PMM Settings and a minor change in API:

- `/v1/Settings/TestEmailAlertingSettings` endpoint was removed from API
- `email_alerting_settings` and `slack_alerting_settings` fields were removed from the PMM settings API endpoint, which is now `/v1/server/settings`

For more information about Percona Alerting, see [About Percona Alerting](../alert/index.md).

### Updated environment variables

When migrating from PMM v2 to PMM v3, you’ll need to update your environment variables to match the new naming convention. This is because PMM v3 introduces several important changes to improve consistency and clarity:

Expand All @@ -230,7 +243,7 @@ For the full list of affected plugins and guidance on migration, see [Grafana's

We will provide regular updates on our migration progress in future releases to help you prepare for this change and modernize your dashboards.

## Components upgrade
## Upgraded components

We've upgraded following PMM components to their latest stable versions to enhance functionality, security, and performance:

Expand Down Expand Up @@ -265,4 +278,4 @@ While the Nomad binary is now included and properly configured within the PMM Cl

- [PMM-13122](https://perconadev.atlassian.net/browse/PMM-13122) - Fixed navigation between pages to properly maintain selected service names and timeframes when switching between different dashboards and metrics views.

- [PMM-12013](https://perconadev.atlassian.net/browse/PMM-12013) - Fixed reliability and memory usage issues with RDS monitoring in large deployments by running separate RDS exporters per AWS access key. This improves metric collection stability and reduces memory consumption when monitoring multiple RDS instances.
- [PMM-12013](https://perconadev.atlassian.net/browse/PMM-12013) - Fixed reliability and memory usage issues with RDS monitoring in large deployments by running separate RDS exporters per AWS access key. This improves metric collection stability and reduces memory consumption when monitoring multiple RDS instances.
3 changes: 2 additions & 1 deletion documentation/mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -269,9 +269,10 @@ nav:
- Percona Alerting:
- alert/index.md
- alert/alert_rules.md
- alert/alert_notifications.md
- alert/contact_points.md
- alert/templates_list.md
- alert/silence_alerts.md
- alert/disable_alerts.md
- Backup and restore:
- backup/index.md
- backup/prepare_storage_location.md
Expand Down
Loading