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

2.39.0 #1108

Merged
merged 21 commits into from
Aug 14, 2023
Merged

2.39.0 #1108

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
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.
Binary file modified docs/_images/PMM_Home_Dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/PMM_Home_Dashboard.psd
Binary file not shown.
Binary file modified docs/_images/PMM_Home_Dashboard_Numbered.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Home_Dashboard_Numbered_old.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/PMM_Home_Dashboard_Search.png
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.
Binary file added docs/_images/PMM_Login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_MongoDB_Cluster_Summary.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_MongoDB_ReplSet_Summary.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Node_Summary.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Nodes_Overview.jpg
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.
Binary file added docs/_images/PMM_QAN_metadata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/PMM_Query_Analytics.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Query_Analytics_Main_Metric_Sparkline.jpg
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.
Binary file modified docs/_images/PMM_Query_Analytics_Metric_Tooltip.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Query_Analytics_Share_Link.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Query_Analytics_Tabs_Details.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Query_Analytics_Tabs_Details_Histogram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Query_Analytics_Tabs_Examples.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Query_Analytics_Tabs_Explain.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Query_Analytics_Tabs_Plan.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/PMM_Query_Analytics_Tabs_Tables.jpg
Binary file modified docs/_images/PMM_Query_Analytics_Time_Range.jpg
Binary file modified docs/_images/PMM_Query_Analytics_Tooltips_Metric_Tooltip.jpg
Binary file added docs/_images/pmm-logo.png
Binary file added docs/_images/pmm_logo.png
2 changes: 1 addition & 1 deletion docs/details/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The main menu is part of the Grafana framework and is visible on every page.

| Item (Top) | Name | Description
|:----------------------------------:|----------------------|-------------------------------
| {{icon.percona}} | Home | Link to home dashboard.
| ![!image](../_images/pmm-logo.png) | Home | Link to home dashboard.
| <i class="uil uil-search"></i> | Search | Search dashboards by name.
| <i class="uil uil-star"></i> | Starred | Mark your favorite dashboards.
| <i class="uil uil-apps"></i> | Dashboards | Create dashboards or [folders][Folders], manage dashboards, import dashboards, create playlists, manage snapshots.
Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/alerting.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ In this scenario, you will need to manually recreate any custom rule templates t
If you have existing YAML alert templates that you want to leverage in Percona Alerting:

1. Go to **Alerting > Alert Rule Templates** tab and click **Add** at the top right-hand side of the table.
2. Click **Add** and upload a local .yaml file from your computer.
2. Click **Add** and upload a local .yaml file that contains the definition of one or more alert templates. Alert templates added in bulk will be displayed individually on **Alert rule templates** page.

#### Migrate alert rules

Expand Down
1 change: 0 additions & 1 deletion docs/get-started/backup/mongodb_limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

Creating and restoring MongoDB backups in PMM currently has the following limitations and requirements:

- Restoring on different Replica set/cluster is not supported.
- Physical backups and restores are supported only for **Percona Server for MongoDB**.
- Physical restores are not supported for deployments with arbiter nodes. For more information, see the [Percona Backup for MongoDB documentation](https://docs.percona.com/percona-backup-mongodb/usage/restore.html#physical-restore-known-limitations).
- Creating backups for sharded clusters was included in PMM 2.38 and is available straight from the UI. However, restoring these backup artifacts is only possible via the CLI, using Percona Backup for MongoDB. For information on restoring sharded backups, check the [PBM documentation](https://docs.percona.com/percona-backup-mongodb/usage/restore.html).
Expand Down
1 change: 0 additions & 1 deletion docs/get-started/backup/mysql_prerequisites.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# MySQL backup prerequisites


Before creating MySQL backups, make sure to:

1. Check that **Backup Management** is enabled and the <i class="uil uil-history"></i> Backup option is available on the side menu. If Backup Managemt has been disabled on your instance, go to <i class="uil uil-cog"></i> **Configuration > PMM Settings > Advanced Settings**, re-enable **Backup Management** then click **Apply changes**.
Expand Down
4 changes: 2 additions & 2 deletions docs/get-started/backup/restore_MongoDB_backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ This opens the **Restore from backup** dialog, with the **Same service** option
!!! caution alert alert-warning "Important"
Make sure not to run pbm backup from the new environment while the Percona Backup for MongoDB config is pointing to the remote storage location of the original environment.

### Restoring from a sharded cluster
Backups of sharded clusters is supported starting with PMM 2.38, and PMM handles the backup process end-to-end. However, restoring such artifacts is currenlty possibile only via the CLI, using Percona Backup for MongoDB.
### Restoring from a sharded cluster
Sharded cluster backups are supported starting with PMM 2.38 and PMM handles the backup process end-to-end. However, restoring such artifacts is currently possible only via the CLI, using Percona Backup for MongoDB.

For information on restoring sharded backups, check the [PBM documentation](https://docs.percona.com/percona-backup-mongodb/usage/restore.html)
6 changes: 3 additions & 3 deletions docs/get-started/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ PMM's user interface is a browser application based on [Grafana].

2. The page loads showing the PMM login screen.

![!](../_images/PMM_Login.jpg)
![!](../_images/PMM_Login.png)

3. Enter the username and password given to you by your system administrator. The defaults are:

Expand Down Expand Up @@ -66,11 +66,11 @@ There are two ways to open the dashboard search page. (Each takes you to the sam

- Click the dashboard name in the navigation bar (top row, to the right of the <i class="uil uil-apps"></i> icon). (To search within the current folder, click the folder name instead of the dashboard name.)

![!Search dashboards by name](../_images/PMM_Home_Dashboard_Search.jpg)
![!Search dashboards by name](../_images/PMM_Home_Dashboard_Search.png)

1. Click _Search dashboards by name_ and begin typing any part of the dashboard name (in this example, "_Instances_").

![!Search dashboards by name](../_images/PMM_Home_Dashboard_Search_String.jpg)
![!Search dashboards by name](../_images/PMM_Home_Dashboard_Search_String.png)

2. Click one of the search results to go to that dashboard. Change the search text to refine the list.

Expand Down
19 changes: 18 additions & 1 deletion docs/get-started/query-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The *Query Analytics* dashboard shows how queries are executed and where they spend their time. It helps you analyze database queries over time, optimize database performance, and find and remedy the source of problems.

![!image](../_images/PMM_Query_Analytics.jpg)
![!image](../_images/PMM_Query_Analytics.png)

Query Analytics supports MySQL, MongoDB and PostgreSQL. The minimum requirements for MySQL are:

Expand Down Expand Up @@ -192,6 +192,23 @@ The *Details* tab contains a *Query time distribution* bar (only for MySQL datab

- Each row in the table is a metric. The contents depends on the chosen dimension.

- *Metadata* table:

PMM 2.39.0 now includes a metadata table for QAN to address the issue of identifying problematic queries. This feature allows you easily identify the services, nodes, and labels associated with your identified queries.

The **Metadata** table shows the following information:

- *Database*: The database being monitored.
- *Environment*: Environment being used such as Dev, Staging, Production, etc.
- *Node Name*: Name or identifier of a node.
- *Node type*: Type of the node.
- *User name*: User name of database being monitored.
- *Service Name*: The name or identifier of the service.
- *Service type*: The service which is being monitored. For example, MySQL, PostgreSQl, etc.

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


For PostgreSQL queries (when using `pg_stat_monitor`) the top query will also be shown in the details section if the query was called by an outer query.

![!image](../_images/PMM_Query_Analytics_Tabs_Details_TopQuery.png)
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Welcome

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

It allows you to observe the health of your database systems, explore new patterns in their behavior, troubleshoot them and perform database management operations no matter where they are located on-prem or in the cloud.

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

| **Release date:** | Aug 14, 2023 |
| ----------------- | ----------------------------------------------------------------------------------------------- |
| **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/Caution"
Crucial points that need emphasis:

- Important: A significant point that deserves emphasis.
- Caution: Used to mean 'Continue with care'.
--->

## Release Highlights

### MongoDB backups: UI-based restore on a new replica set cluster

Building on the recent MongoDB backup management enhancements, we have now added the option to restore backups on different clusters with the same configuration. This enables you to test restore data before deploying it on Dev environments.

Restoring on different clusters is not available for sharded clusters. This is a complicated process that still requires manual intervention. For more information, see [Restoring from a sharded cluster]()

### Query Analytics - Meta information

QAN is an important tool that can help filter data and identify problematic queries. However, it can be challenging to determine which services, nodes, and other labels are linked to these queries.

PMM 2.39.0 now includes a metadata table for QAN to address this issue. This table contains information such as Node name, Node name, Service name, Service type, and user name for each selected query. With this feature, you can easily identify the services, nodes, and labels associated with your identified queries.

To view the metadata table, navigate to the **Main** menu and click on **Query Analytics (QAN)**. This will bring you to the **Query Analytics** page. Next, select the desired query and expand the **Metadata** tab. The metadata for that specific query will then be displayed.

![clouds](../_images/PMM_QAN_metadata.png)


## Improvements

- [PMM-6279](https://jira.percona.com/browse/PMM-6279) - [QAN]: PMM 2.39.0 now includes a metadata table for each query. This table contains information such as Node name, Node name, Service name, Service type, and user name for each selected query.
- [PMM-10270](https://jira.percona.com/browse/PMM-10270) - [Backup Management]: Enhanced MongoDB Backup Management to support restoring to different replica set clusters with the same configuration.
- [PMM-11999](https://jira.percona.com/browse/PMM-11999), [PMM-12257](https://jira.percona.com/browse/PMM-12257) - [Advisors] - The **Advisors** page now contains a new **Technology** column that shows the database type for each advisor. This helps you distinguish between MongoDB, MySQL, and PostgreSQL advisors.
- [PMM-11206](https://jira.percona.com/browse/PMM-11206) - [Alerting]: You can now easily add multiple **Alert rule templates** at once, whether through the API or UI. When added in bulk, each template will be displayed separately on the **Alert rule templates** page. This makes it quicker and more efficient to manage your alert rules.
- [PMM-11637](https://jira.percona.com/browse/PMM-11637) - PMM UI now reflects the new PMM logo as per the new branding.
- [PMM-12070](https://jira.percona.com/browse/PMM-12070) - We have updated the deprecated [Boomtable plugin](https://github.com/percona/grafana-dashboards/tree/main/panels/yesoreyeram-boomtable-panel) to the Grafana table plugin.
- [PMM-12389](https://jira.percona.com/browse/PMM-12389) - The postgres_exporter now provides more comprehensive logs that display the specific namespace and error message for any issue.

## Bugs Fixed

- [PMM-12151](https://jira.percona.com/browse/PMM-12151) - [QAN]: The Explain plan was not displayed in a few scenarios. The issue has been resolved now.
- [PMM-11658](https://jira.percona.com/browse/PMM-11658) - Fixed issue that caused the pmm-agent to crash on AMI and OVF distributions.
- [PMM-11992](https://jira.percona.com/browse/PMM-11992) - Postgres databases with names other than **Postgres** could not be added. The issue has been resolved now.
- [PMM-12263](https://jira.percona.com/browse/PMM-12263) - On the MongoDB Cluster Summary dashboard, the **Replication Lag by Set** graph showed the wrong value if **rs** was in the primary-secondary-arbiter (PSA) configuration. It calculated the arbiter's lag from the beginning of the UNIX time (currently >54 years instead of a few seconds). The issue has been resolved now.
- [PMM-12280](https://jira.percona.com/browse/PMM-12280) - Fixed an issue where the **Service Summary Panel** on Home Dashboard used the incorrect units to display `Available Memory`.
- [PMM-10665](https://jira.percona.com/browse/PMM-10665) - Fixed issue that caused QAN to show incorrect values when setting non-default values for performance schema. Make sure to restart pmm-agent after changing the settings for perfschema in MySQL.
- [PMM-10391](https://jira.percona.com/browse/PMM-10391) - PMM did not work with external Clickhouse versions greater than 22.5.2. The issue has been resolved now.
- [PMM-12231](https://jira.percona.com/browse/PMM-12231) - In the recent versions of PMM, users have encountered issues with installing, updating and removing plugins from PMM. For more information on this issue, see [Troubleshooting Plugin issues](https://docs.percona.com/percona-monitoring-and-management/how-to/troubleshoot.html#plugins-issues).
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.39.0](2.39.0.md)
- [Percona Monitoring and Management 2.38.1](2.38.1.md)
- [Percona Monitoring and Management 2.38.0](2.38.0.md)
- [Percona Monitoring and Management 2.37.1](2.37.1.md)
Expand Down
4 changes: 3 additions & 1 deletion docs/setting-up/client/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,10 @@ You need to get the Client ID, Client Secret, Tenant ID and Subscription ID.
### Create a new application to get the tenant ID, client ID and the client secret.
1. Search for **Azure Active Directory**
![!](../../_images/azure_active_directory_section.png)
2. Register a new application
2. Register a new application:

![!](../../_images/azure_app_registrations_section.png)

![!](../../_images/azure_app_new_registration.png)
![!](../../_images/azure_app_new_details.png)
3. At this point you can copy the client and tenant IDs.
Expand Down
5 changes: 4 additions & 1 deletion docs/setting-up/client/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,10 @@ This section covers how to configure a MySQL-based database server to use *Perfo

PMM's [*MySQL Performance Schema Details* dashboard](../../details/dashboards/dashboard-mysql-performance-schema-details.md) charts the various [`performance_schema`][performance-schema-startup-configuration] metrics.

To use *Performance Schema*, set these variables.
To use *Performance Schema*, set the variables below.

!!! caution alert alert-warning "Important"
Make sure to restart pmm-agent after making any changes to MySQL perfschema.

| Variable | Value | Description
|--------------------------------------------------------------------------------------------|--------------------|---------------------------------------------------------------------------------
Expand Down
1 change: 0 additions & 1 deletion docs/setting-up/server/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,6 @@ You can store data from your PMM in:

3. Visit `https://localhost:443` to see the PMM user interface in a web browser. (If you are accessing the docker host remotely, replace `localhost` with the IP or server name of the host.)


### Migrate from data container to host directory/volume

To migrate your PMM from data container to host directory or volume run the following command:
Expand Down
3 changes: 2 additions & 1 deletion mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ plugins:
with-pdf:
output_path: '_pdf/PerconaMonitoringAndManagement-2.38.0.pdf'
cover_title: 'Percona Monitoring and Management Documentation'
cover_subtitle: 2.38.0 (May 02, 2023)
cover_subtitle: 2.39.0 (Aug 14, 2023)

author: "Percona Technical Documentation Team"
cover_logo: docs/_images/Percona_Logo_Color.png
Expand Down Expand Up @@ -317,6 +317,7 @@ nav:
- faq.md
- Release Notes:
- release-notes/index.md
- "PMM 2.39.0": release-notes/2.39.0.md
- "PMM 2.38.1": release-notes/2.38.1.md
- "PMM 2.38.0": release-notes/2.38.0.md
- "PMM 2.37.1": release-notes/2.37.1.md
Expand Down
6 changes: 3 additions & 3 deletions variables.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# PMM Version for HTML
# See also mkdocs.yml plugins.with-pdf.cover_subtitle and output_path

release: '2.38.1'
version: '2.38.1'
release_date: 2023-07-13
release: '2.39.0'
version: '2.39.0'
release_date: 2023-08-09
# SVG icons. Use in markdown as {{icon.<name>}}
# For the Percona image icon (encoded inline SVG), see https://css-tricks.com/using-svg/
icon:
Expand Down
Loading