Skip to content

Commit

Permalink
Doc and Config Changes for PMM Rel 2.33.0 (#931)
Browse files Browse the repository at this point in the history
* PMM Config Changes for PMM Rel 2.33.0

* PMM-11159 Doc changes for new MySQL explain method. (#936)

* PMM-10385 Doc changes.

* PMM-10385 Remove empty lines.

* Update docs/using/query-analytics.md

Co-authored-by: Rasika Chivate <[email protected]>

* Update docs/using/query-analytics.md

Co-authored-by: Rasika Chivate <[email protected]>

* Update docs/using/query-analytics.md

Co-authored-by: Rasika Chivate <[email protected]>

* Update index.md (#937)

* Update index.md

replaced Integrated Alerting  with a proper name

* Update index.md

* fixed remaining references

Co-authored-by: Catalina A <[email protected]>
Co-authored-by: Catalina A <[email protected]>

* Fixing broken link MySQL Exporter (#939)

* PMM-10385 Update.

* Revert "Merge branch 'main' into PMM-10385-disable-examples"

This reverts commit c952845.

* Update query-analytics.md

* Update query-analytics.md

* Update docs/using/query-analytics.md

Co-authored-by: Jiří Čtvrtka <[email protected]>

* Update docs/using/query-analytics.md

Co-authored-by: Jiří Čtvrtka <[email protected]>

Co-authored-by: Rasika Chivate <[email protected]>
Co-authored-by: Roma Novikov <[email protected]>
Co-authored-by: Catalina A <[email protected]>
Co-authored-by: Catalina A <[email protected]>
Co-authored-by: Mike Benshoof <[email protected]>

* Release Notes PMM 2.33.0 (#932)

* Release Notes PMM 2.33.0

* Update 2.33.0.md

* Update 2.33.0.md

* Updated Highlights

* added Server Features items

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Updated the Index and config file

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update docs/release-notes/2.33.0.md

Co-authored-by: Denys Kondratenko <[email protected]>

* Update docs/release-notes/2.33.0.md

Co-authored-by: Denys Kondratenko <[email protected]>

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update docs/release-notes/2.33.0.md

Co-authored-by: Holman Romero <[email protected]>

* Update docs/release-notes/2.33.0.md

Co-authored-by: Holman Romero <[email protected]>

* Update docs/release-notes/2.33.0.md

Co-authored-by: Holman Romero <[email protected]>

* Update docs/release-notes/2.33.0.md

Co-authored-by: Holman Romero <[email protected]>

* Update 2.33.0.md

* Update 2.33.0.md

* Update docs/release-notes/2.33.0.md

Co-authored-by: Pavel Khripkov <[email protected]>

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* implemented feedback from Pavel

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Added PMM-11126 as known issue

* Update 2.33.0.md

* Update docs/release-notes/2.33.0.md

Co-authored-by: Denys Kondratenko <[email protected]>

* Update 2.33.0.md

* Update 2.33.0.md

* Added PMM-10062

* Added PMM-10558

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Updated Release Noes

* Changes for PMM-10135.

* Edited description for PMM_10135

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

* Update 2.33.0.md

Co-authored-by: Catalina A <[email protected]>
Co-authored-by: Denys Kondratenko <[email protected]>
Co-authored-by: Holman Romero <[email protected]>
Co-authored-by: Catalina A <[email protected]>
Co-authored-by: Pavel Khripkov <[email protected]>
Co-authored-by: Jiří Čtvrtka <[email protected]>

* Update pmm_components_and_versions.md (#940)

* Update pmm_components_and_versions.md

* Update pmm_components_and_versions.md

* Update pmm_components_and_versions.md

* Update pmm_components_and_versions.md

* Update pmm_components_and_versions.md

* Update pmm_components_and_versions.md

* Update 2.33.0.md

Co-authored-by: Jiří Čtvrtka <[email protected]>
Co-authored-by: Roma Novikov <[email protected]>
Co-authored-by: Catalina A <[email protected]>
Co-authored-by: Catalina A <[email protected]>
Co-authored-by: Mike Benshoof <[email protected]>
Co-authored-by: Denys Kondratenko <[email protected]>
Co-authored-by: Holman Romero <[email protected]>
Co-authored-by: Pavel Khripkov <[email protected]>
Co-authored-by: Jiří Čtvrtka <[email protected]>
  • Loading branch information
10 people authored Dec 13, 2022
1 parent 103e1bc commit 579f39f
Show file tree
Hide file tree
Showing 8 changed files with 202 additions and 10 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 7 additions & 5 deletions docs/details/pmm_components_and_versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,19 @@ The following table lists all the PMM client/server components and their version

| Component| Version| Documentation | Repository |
|----------|--------|---------------------------------------------- |-------------------------------------------------------------------------------------------------------------|
| Grafana | 9.1 | [Grafana Documentation](https://grafana.com/docs/grafana/latest/)|[Github Grafana](https://github.com/percona-platform/grafana)|
| VictoriaMetrics| 1.77.1 | [VictoriaMetrics Documentation](https://docs.victoriametrics.com/)|[Github VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics) |
| Grafana | 9.2.5 | [Grafana Documentation](https://grafana.com/docs/grafana/latest/)|[Github Grafana](https://github.com/percona-platform/grafana)|
| VictoriaMetrics| 1.82.1 | [VictoriaMetrics Documentation](https://docs.victoriametrics.com/)|[Github VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics) |
| Nginx | 1.20.1 | [Nginx Documentation](http://nginx.org/en/docs/)|[Github Nginx](https://github.com/nginx/nginx-releases) |
| Percona Distribution for PostgreSQL | 14.5 | [Percona Distribution for PostgreSQL 14 Documentation](https://www.percona.com/doc/postgresql/LATEST/index.html)| |
| Clickhouse| 21.3.20.1 |[ClickHouse Documentation Documentation](https://clickhouse.com/docs/en/)|[Github ClickHouse](https://github.com/ClickHouse/ClickHouse)|
| PerconaToolkit | 3.4.0 | [Percona Toolkit Documentation](https://www.percona.com/doc/percona-toolkit/3.0/index.html)|[Github Percona Toolkit](https://github.com/percona/percona-toolkit)|
| Alertmanager | 0.22.0 | [Alertmanager Documentation](https://prometheus.io/docs/alerting/latest/alertmanager/)|[Github Alertmanager](https://github.com/prometheus/alertmanager)|
| MongoDB exporter | 0.34.0 | |[Github percona/mongodb_exporter](https://github.com/percona/mongodb_exporter)|
| RDS exporter | 0.7.2 | |[Github percona/rds_exporter](https://github.com/percona/rds_exporter)|
| MySQL exporter| v0.14.0 and Percona changes | [MySQL Server Exporter Documentation](https://grafana.com/oss/prometheus/exporters/mysql-exporter/)|[Github Prometheus MySQL Exporter](https://github.com/percona/mysqld_exporter) |
| Node exporter|v1.3.1 and Percona changes| [Node Exporter Documentation](https://prometheus.io/docs/guides/node-exporter/)|[Github node exporter](https://github.com/percona/node_exporter) |
| Azure exporter| [2.30.0](https://github.com/percona/azure_metrics_exporter/tree/pmm-2.30.0) | | [Github azure_metrics_exporter](https://github.com/percona/azure_metrics_exporter) |
| MySQL exporter| v0.14.0[^1] | [MySQL Server Exporter Documentation](https://grafana.com/oss/prometheus/exporters/mysql-exporter/)|[Github Prometheus MySQL Exporter](github.com/percona/mysqld_exporter) |
| Node exporter|v1.3.1[^1]| [Node Exporter Documentation](https://prometheus.io/docs/guides/node-exporter/)|[Github node exporter](https://github.com/percona/node_exporter) |
| Azure exporter| 2.30.0 | | [Github azure_metrics_exporter](https://github.com/percona/azure_metrics_exporter) |
|[^1]: Original upstream version along with some changes authored by Percona |



176 changes: 176 additions & 0 deletions docs/release-notes/2.33.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
# Percona Monitoring and Management 2.33.0

| **Release date:** | Dec 13, 2022 |
| ----------------- | ----------------------------------------------------------------------------------------------- |
| **Installation:** | [Installing Percona Monitoring and Management](https://www.percona.com/software/pmm/quickstart) |

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

!!! caution alert alert-warning "Important"
PMM upgrade **fails** for versions prior to 2.33.0. Although there is a [workaround](2.33.0.md#known-issues), we highly recommend using the latest version of PMM. This ensures that you have access to the latest PMM features and that your environment runs on the latest version of the underlying components with all the bug fixes in place.


## Release Highlights


### Data loss prevention for PMM server outages

Starting with PMM 2.33.0, we have introduced a new solution to prevent data loss in PMM. A network outage between the PMM server and the client prevented metrics from being collected. As a result, the historical data was lost, which can be useful when analyzing trends, diagnosing problems, or investigating issues from a previous period.

In order to address the problem mentioned above, for the PMM server and PMM client running version 2.33.0, in case of a brief outage or network issue, metrics are stored on the monitored instance until the PMM server is up and running. At this point, the metrics will be pushed to the server. It only applies to PMM Clients that run in push mode, which is the default mode. The same holds when a brief network outage occurs on the client side.

!!! caution alert alert-warning "Caution"
The client node can currently store only 1 GB of offline data. So, for example, if your instance is down for three days, all the data will not be retrieved.

With the implementation of the above feature, we have taken the first step toward PMM HA. Furthermore, we are happy to provide a roadmap for PMM HA implementation, a much-anticipated solution by our users. In the event of a failover, your PMM setup will experience near-zero downtime, and monitoring will continue without any data loss.

To ensure a smooth rollout, PMM HA will be introduced in phases, in line with your requirements and feedback.

!!! caution alert alert-warning "Important"
PMM HA will be rolled out in three stages. Stage one of PMM HA is the implementation to prevent data loss with VictoriaMetrics integration for short outages **included** as part of **PMM 2.33.0**. HA stages two and three will be rolled out next year.

The following features/use cases will be covered as part of the various stages of PMM HA:


|**Stages of PMM HA** | **Solutions Provided** |
|-------------------------------------|---------------------------------|
|**Stage one (included in PMM 2.33.0)** |As an initial step towards preventing data loss, we have developed the following:<br><br>**Prevent data loss with VM integration for short outages**|
|**Stage two (will be rolled out in 2023)** |As part of PMM HA stage two, we plan to implement the following:<br><br>**HA data sources**<br>As part of stage two we will let the users use external data sources, thereby decreasing dependency on the file system.
|**Stage three (will be rolled out in 2023)** |As part of PMM HA stage three, we plan to implement the following:<br><br>**Clusterized HA**<br>Clustered PMM will be the focus of stage three. Detailed information will be included in the upcoming release notes.



### Guided tour of Percona Alerting


Following the recent improvements to PMM Alerting, we have added a short tutorial to help you explore our streamlined alerting system based on Grafana.
The in-app tutorial automatically pops up when you first open the **Alerting** page to help you uncover the fundamentals of Percona Alerting.


### Restore MongoDB backups easier

Building on the significant improvements for MongoDB Backup Management introduced in the previous release. We are now simplifying the process for restoring physical MongoDB backups.
Starting with this release, you can restore physical backups straight from the UI, and PMM will handle the process end-to-end. Prior to this, you would require to perform additional manual steps to restart your MongoDB database service so that your applications could make use of the restored data.

### Components Upgrade

- VictoriaMetrics has been upgraded from 1.77.1 to 1.82.1.
- As part of PMM 2.33.0, Grafana has been updated to 9.2.5, which fixes some critical vulnerabilities. For more information, see [Grafana 9.2.5](https://grafana.com/blog/2022/11/08/security-release-new-versions-of-grafana-with-critical-and-moderate-fixes-for-cve-2022-39328-cve-2022-39307-and-cve-2022-39306/)


## New Features

- [PMM-10889](https://jira.percona.com/browse/PMM-10889) - Starting with PMM2.33.0, while using the pmm-admin CLI command, you do not have to know the entire command. Just type the initial command and press Tab. The rest of the command will be autocompleted.

Depending on the shell you are using, add the following to your shells .rc file for autocomplete to work:

```sh
source <(pmm-admin completion -c <your shell>)
E.g. source <(pmm-admin completion -c bash)
```

- [PMM-10955](https://jira.percona.com/browse/PMM-10955): [Backup Management]: After restoring a backup, you can now check the time when the restore was finalized. For PITR backups, you can also check the time to which the restore was performed.
This information is available on the tab **Backup > Restores** page, in the new **Finished at** column, and in the **PITR timestamp** field under the **Actions** menu.

## Improvements

- [PMM-7000](https://jira.percona.com/browse/PMM-7000): [HA]: Staring with PMM 2.33.0, if the PMM Server goes down, metrics will be buffered on the monitored instance until PMM Server goes back online, which is when metrics will get pushed to the PMM Server.

- [PMM-10901](https://jira.percona.com/browse/PMM-10901): [Documentation]: To enable the users to use High Availability easily, we have added exclusive documentation for HA.

- [PMM-8516](https://jira.percona.com/browse/PMM-8516): [Backup Management]: When creating a backup, the Vendor field was not automatically populated in the Back-up on demand dialog. This issue is now fixed.

- [PMM-10627](https://jira.percona.com/browse/PMM-10627): [DBaaS]: You can now create a single node cluster for PSMDB.

- [PMM-10855](https://jira.percona.com/browse/PMM-10855): Avoid massive gRPC messages formatting for disabled log level


- [PMM-10903](https://jira.percona.com/browse/PMM-10903): [DBaaS]: To simplify DBaas, you no longer have to manually enter the Public Address on the **PMM Settings > Advanced Settings** page. With DBaaS enabled, PMM will automatically detect and populate the **Public Address**.


- [PMM-11085](https://jira.percona.com/browse/PMM-11085): [Backup Management]: We've removed the **Create backup** option under **All backups** page > **Actions** menu because this option can only create on-demand backups. You can continue to create both on-demand and scheduled backups using the **Create backup** button on this page.
- [PMM-10881](https://jira.percona.com/browse/PMM-10881): [CVE]: As part of PMM 2.33.0, Grafana was updated to 9.2.5, which fixes some critical vulnerabilities. For more information, see [Grafana 9.2.5](https://grafana.com/blog/2022/11/08/security-release-new-versions-of-grafana-with-critical-and-moderate-fixes-for-cve-2022-39328-cve-2022-39307-and-cve-2022-39306/).
- [PMM-10385](https://jira.percona.com/browse/PMM-10385): Starting with PMM 2.33.0, for MySQL, the *Explain* tab is supported without the *Examples* tab. If a query in the *Explain* tab contains sensitive data, placeholders will replace them.
- [PMM-8655](https://jira.percona.com/browse/PMM-8655): Latest state of agents is now available on the PMM server after the connection is re-established between the client and server.
- [PMM-10969](https://jira.percona.com/browse/PMM-10969): VictoriaMetrics operator has been upgraded from 0.24 to 0.29.0.
- [PMM-10554](https://jira.percona.com/browse/PMM-10554): Postgres collector now provides runtime duration for scrapes at the collector level. As a result, we can identify collectors who take too long. By utilizing this data, corrective action can be taken.
- [PMM-10629](https://jira.percona.com/browse/PMM-10629): [Components Upgrade]: VictoriaMetrics has been upgraded from 1.77.1 to 1.82.1.
## Bugs Fixed
- [PMM-10858](https://jira.percona.com/browse/PMM-10858): In specific environments, including AWS, some EPEL repository mirrors did not respond within the time limit defined by `pmm-update`, currently set to 30 seconds. This was causing `supervisord` to kill `pmm-update-checker`, the component responsible for verifying if a newer version of the PMM Server is available for upgrade. This issue has been resolved now.
- [PMM-10683](https://jira.percona.com/browse/PMM-10683): [DBaaS]: While registering a K8s cluster on the **Manage Components Versions** modal, the versions were not getting unchecked. The issue has now been resolved.
- [PMM-11082](https://jira.percona.com/browse/PMM-11082): When adding RDS MySQL instances to PMM, some queries pertaining to table stats were executed, despite table stats being disabled.
- [PMM-10637](https://jira.percona.com/browse/PMM-10637): Fixed an issue where the queries for some panels on the PostgreSQL Instance Summary dashboards were broken.
- [PMM-11029](https://jira.percona.com/browse/PMM-11029): Whenever the `max-query-length` parameter was set to 3, 2, or 1, the PMM agent would be terminated. The issue has now been resolved.
- [PMM-10732](https://jira.percona.com/browse/PMM-10732): Checking the select all checkbox on the **Services**, **Agents**, and **Nodes** modal in the **PMM Inventory** window deleted all entries on all the pages. The issue has been resolved now.
- [PMM-10062](https://jira.percona.com/browse/PMM-10062): While monitoring a large number of nodes, some dashboards had incredibly long load times, resulting in an unresponsive UI. The issue has been fixed now.
- [PMM-10983](https://jira.percona.com/browse/PMM-10983): Some panels on the dashboards were showing only short names. The issue has been resolved now.
- [PMM-11041](https://jira.percona.com/browse/PMM-11041): There was typo on the Home dashboard: **COMMAND CENTER** graphs. This has been fixed now.
- [PMM-10996](https://jira.percona.com/browse/PMM-10996): [Backup Management]: Fixed an issue where the initial description text for a storage location could not be updated.
- [PMM-10718](https://jira.percona.com/browse/PMM-10718): [Backup Management]: When taking backups, PMM now shows a clearer error if the pmm-agent is incompatible with the specified backup operation.
- [PMM-10558](https://jira.percona.com/browse/PMM-10558): Top 5 Collections by Documents Changed panel on the MongoDB Collection Details dashboard did not display data correctly based on the selected filters. It has now been resolved.
- [PMM-10493](https://jira.percona.com/browse/PMM-10493): [Portal Integration]: In some specific scenarios, disconnecting from Platform Portal as an Administrator would sometimes show a token error. This issue is now fixed.
- [PMM-10845](https://jira.percona.com/browse/PMM-10845): [Advisors] Fixed specific error that occurred when working with Advisors that do not specify a frequency for executing the advisor check.
- [PMM-10029](https://jira.percona.com/browse/PMM-10029): There was a potential issue with the network request exceeding the maximum message size. The issue has been resolved now.
## Known issues
- [PMM-11126](https://jira.percona.com/browse/PMM-11126): **PMM server cannot be upgraded to version 2.32.0**
A bug in PMM Server ansible scripts caused PMM to upgrade Nginx's dependencies without updating Nginx itself. Due to this, PMM throws an error while upgrading and cannot upgrade to a newer version.


!!! caution alert alert-warning "Important"
This issue has been resolved for PMM version 2.33.0. However, the issue persists on all the versions prior to 2.33.0.


**Solution**

While PMM is being upgraded, log in to the PMM server and run the following command:

```sh
sed -i 's/- nginx/- nginx*/' /usr/share/pmm-update/ansible/playbook/tasks/update.yml
```


- [PMM-10858](https://jira.percona.com/browse/PMM-10858): **PMM server does not show latest versions available with the instances created with AWS**

For PMM versions prior to 2.33.0, in specific environments, including AWS, some EPEL repository mirrors did not respond within the time limit defined by pmm-update (currently set to 30 seconds). It was causing supervisord to kill pmm-update-checker, which determines if a newer PMM Server is available for upgrade.

**Solution**

Log in to the PMM Server and run the following command as a root user:

```
$ yum-config-manager --setopt=epel.timeout=1 --save
```
1 change: 1 addition & 0 deletions docs/release-notes/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Release Notes
- [Percona Monitoring and Management 2.33.0](2.33.0.md)
- [Percona Monitoring and Management 2.32.0](2.32.0.md)
- [Percona Monitoring and Management 2.31.0](2.31.0.md)
- [Percona Monitoring and Management 2.30.0](2.30.0.md)
Expand Down
12 changes: 12 additions & 0 deletions docs/using/query-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,18 @@ The *Explain* tab shows the `explain` output for the selected query, in Classic
- MongoDB: JSON only.
- PostgreSQL: Not supported.

Starting with PMM 2.33.0, for MySQL, the *Explain* tab is supported without the *Examples* enabled. If a query in the *Explain* tab contains sensitive data, placeholders will replace them.
Before you can run Explain, you must specify the values for these placeholders. This image illustrates the query with placeholders.

![!image](../_images/PMM_Query_Analytics_Tabs_Explain_With_Placeholders.png)

Below is an illustration of the same query using values instead of placeholders.

![!image](../_images/PMM_Query_Analytics_Tabs_Explain_With_Values.png)

The image shown above illustrates a query with two placeholders. Therefore, you must enter the correct values in both fields. After filling in these values, click *Explain* to get the results like in the previous PMM versions without data leaks.
You will get result like in previous PMM versions. This method of `explain` prevents data leak.

!!! note alert alert-primary "'Explain' for MongoDB"

To run Explain you need the same permissions as for executing the original query. For example, to run explain on `updates` you need update permissions.
Expand Down
5 changes: 3 additions & 2 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,9 @@ plugins:
- "setting-up/client/docker.md"
# https://github.com/orzih/mkdocs-with-pdf
with-pdf:
output_path: "_pdf/PerconaMonitoringAndManagement-2.32.0.pdf"
output_path: "_pdf/PerconaMonitoringAndManagement-2.33.0.pdf"
cover_title: "Documentation"
cover_subtitle: 2.32.0 (Nov 8, 2022)
cover_subtitle: 2.33.0 (Dec 13, 2022)
author: "Percona Technical Documentation Team"
cover_logo: docs/_images/PMM_Logo.svg
custom_template_path: _resources/templates
Expand Down Expand Up @@ -233,6 +233,7 @@ nav:
- faq.md
- Release Notes:
- release-notes/index.md
- "PMM 2.33.0": release-notes/2.33.0.md
- "PMM 2.32.0": release-notes/2.32.0.md
- "PMM 2.31.0": release-notes/2.31.0.md
- "PMM 2.30.0": release-notes/2.30.0.md
Expand Down
Loading

0 comments on commit 579f39f

Please sign in to comment.