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 #3435

Merged
Merged
Show file tree
Hide file tree
Changes from all 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 percona/pmm-server:3
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.
Time specified in mute timing must be in UTC format, i.e. 14:00, not 2:00 PM.
Copy link
Member Author

@ademidoff ademidoff Jan 8, 2025

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 when it comes to date formats, I suggest we remove it to avoid confusion.

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 want to use custom expressions in alert rules, you can create your own alert rule templates.
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 makes it a bit more clear.

- **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
2 changes: 1 addition & 1 deletion documentation/docs/release-notes/3.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,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
## Component upgrades

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

Expand Down
32 changes: 32 additions & 0 deletions documentation/docs/release-notes/3.0.0_GA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Percona Monitoring and Management 3.0.0

| **Release date** | January 22nd, 2025 |
| ----------------- | :---------------------------------------------------------------------------------------------- |
| **Installation** | [Installing Percona Monitoring and Management](../quickstart/index.md) |

Percona Monitoring and Management (PMM) is an open source database monitoring, management, and observability solution for MySQL, PostgreSQL, and MongoDB.

It enables you to observe the health of your database systems, explore new patterns in their behavior, troubleshoot them and execute database management operations—regardless of whether your databases are located on-premises or in the cloud.

## Release summary
PMM 3.0.0 introduces this and that


## Release highlights

### Finalized Integrated Alerting deprecation and API removal

This release completes the deprecation of Integrated Alerting started in PMM 2.31.0 by removing its remaining components and APIs:

- Removed all Integrated Alerting API endpoints, including `/v1/Settings/TestEmailAlertingSettings`
- Removed Integrated Alerting-related fields from the PMM Settings API (`email_alerting_settings` and `slack_alerting_settings`)

ademidoff marked this conversation as resolved.
Show resolved Hide resolved
If you still have alert rules that haven't been migrated to Percona Alerting, use the [Integrated Alerting Migration Script](https://github.com/percona/pmm/blob/main/ia_migration.py) to migrate them. [Percona Alerting](../alert/index.md) provides enhanced capabilities through Grafana's alerting infrastructure and pre-configured Alert Rule Templates.

## Improvements

- [PMM-xxx](https://perconadev.atlassian.net/browse/PMM-xxx) -

## Fixed issues

- [PMM-13360](https://perconadev.atlassian.net/browse/PMM-13360) - Fixed an issue in the MongoDB ReplSet Summary dashboard where nodes in `down` state would sometimes disappear from the **States** panel and their version information would be removed from the MongoDB Versions panel. Nodes in `down` state now remain visible with their last known version information preserved.
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
Copy link
Member Author

@ademidoff ademidoff Jan 8, 2025

Choose a reason for hiding this comment

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

This was rendering as None for such page is absent.

Screenshot 2025-01-08 at 12 03 55

- 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