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.43.0 updates #1271

Merged
merged 57 commits into from
Sep 19, 2024
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
57 commits
Select commit Hold shift + click to select a range
32b3937
release setup
catalinaadam Jun 21, 2024
87081bd
PMM-13133
catalinaadam Jun 21, 2024
7b8b936
improved wording
catalinaadam Jun 21, 2024
2e504b7
Update query-analytics.md
catalinaadam Jul 2, 2024
a3ec401
Download server diagnostics endpoint
catalinaadam Jul 2, 2024
6ebfceb
Update troubleshoot.md
catalinaadam Jul 3, 2024
49dc0f8
PMM-13054
catalinaadam Jul 5, 2024
58f0d69
fortmatting
catalinaadam Jul 5, 2024
59da3e8
typo
catalinaadam Jul 5, 2024
e67a7ff
Merge branch 'main' into 2.43.0_updates
ademidoff Jul 8, 2024
654d784
Update docs/get-started/query-analytics.md
catalinaadam Aug 20, 2024
803b8b7
Update docs/get-started/query-analytics.md
catalinaadam Aug 20, 2024
fd1669f
transferred RelNotes
catalinaadam Aug 23, 2024
7b47fe3
formatting
catalinaadam Aug 23, 2024
1b3611e
resized image
catalinaadam Aug 23, 2024
a3f52d2
feedback from Steve
catalinaadam Aug 24, 2024
c5cd3b3
Update docs/release-notes/2.43.0.md
catalinaadam Aug 24, 2024
d565a58
Merge branch 'main' into 2.43.0_updates
catalinaadam Aug 29, 2024
7ac103e
feedback from Steve
catalinaadam Aug 29, 2024
4027a19
Update docs/release-notes/2.43.0.md
catalinaadam Aug 29, 2024
8191b2b
release date
catalinaadam Aug 29, 2024
de61cda
Merge branch '2.43.0_updates' of https://github.com/percona/pmm-doc i…
catalinaadam Aug 29, 2024
f020bae
Update 2.43.0.md
catalinaadam Aug 29, 2024
6d6dfc1
feedback from Roma
catalinaadam Aug 30, 2024
580ef67
IMPROVED Monitoring PBM SECTION
catalinaadam Aug 30, 2024
bd9906e
formatting
catalinaadam Aug 30, 2024
0f9a783
formatting
catalinaadam Aug 30, 2024
30ea379
formatting
catalinaadam Aug 30, 2024
a1319b7
formatting
catalinaadam Aug 30, 2024
0cd2860
typo
catalinaadam Aug 30, 2024
e75b276
Update docs/release-notes/2.43.0.md
catalinaadam Aug 30, 2024
fd4b3b6
updated release date
catalinaadam Aug 30, 2024
9d9b232
Merge branch '2.43.0_updates' of https://github.com/percona/pmm-doc i…
catalinaadam Aug 30, 2024
1a1fe5f
updated link text
catalinaadam Sep 2, 2024
9b4d272
Update 2.43.0.md
catalinaadam Sep 3, 2024
b1a8909
PMM-13243
catalinaadam Sep 5, 2024
e8c558f
PMM-13327 - New MongoDB Router Summary (#1306)
sleto-it Sep 6, 2024
9071814
PMM-13244
catalinaadam Sep 6, 2024
13ff35a
GAed and redesigned MongoDB dashboards (#1305)
catalinaadam Sep 6, 2024
07f359b
added rederence to roma's blogpost
catalinaadam Sep 6, 2024
d47cc50
New MongoDB dashboards - attempt to fix multiple issues on ` 2.43.0_u…
sleto-it Sep 9, 2024
f55d9b3
fix Toclinks
catalinaadam Sep 9, 2024
46b8644
Merge branch '2.43.0_updates' of https://github.com/percona/pmm-doc i…
catalinaadam Sep 9, 2024
7a86779
fix ToC links
catalinaadam Sep 9, 2024
18cadb3
fix links
catalinaadam Sep 10, 2024
2596632
added known issue
catalinaadam Sep 10, 2024
225a95e
PMM-13348
catalinaadam Sep 11, 2024
dc81f71
Update docs/release-notes/2.43.0.md
catalinaadam Sep 11, 2024
840d7e3
feedback from Nurlan
catalinaadam Sep 11, 2024
fd5fdc8
feedback from Santo
catalinaadam Sep 13, 2024
ac5af9d
feedback from Ivan
catalinaadam Sep 13, 2024
06c9a0b
removed known issues
catalinaadam Sep 16, 2024
e6b7c2b
PMM-13141
catalinaadam Sep 17, 2024
838fc4f
format
catalinaadam Sep 17, 2024
06350eb
PMM-13362 - feedback from Santo
catalinaadam Sep 17, 2024
86a6baf
feedback from Nurlan
catalinaadam Sep 17, 2024
a83eadd
PMM-13141
catalinaadam Sep 18, 2024
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
45 changes: 27 additions & 18 deletions docs/get-started/query-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The dashboard contains three panels:

![!image](../_images/PMM_Query_Analytics_Panels_Filters.jpg)

- The *Filter* panel on the left hand side of the dashboard lists the filters grouped by category. It also shows the percentage of the main metrics (explained below). If you select a different metric, the percentages on the left panel will change as per this metric. When you select a metric, it reduces the overview list as per the matching filter.
- The *Filter* panel on the left-hand side of the dashboard lists the filters grouped by category. It also shows the percentage of the main metrics (explained below). If you select a different metric, the percentages on the left panel will change as per this metric. When you select a metric, it reduces the overview list as per the matching filter.
- The first five of each category are shown. If there are more, the list is expanded by clicking *Show all* beside the category name, and collapsed again with *Show top 5*.
- Applying a filter may make other filters inapplicable. These become grayed out and inactive.
- Click the chart symbol <i class="uil uil-graph-bar"></i> to navigate directly to an item's associated dashboard.
Expand Down Expand Up @@ -120,12 +120,12 @@ Delete the search text and press Enter to see the full list again.

- The first column is the object’s identifier. For *Query*, it is the query’s [Fingerprint](../details/glossary/#fingerprint).
- The second column is the *Main metric*, containing a reduced graphical representation of the metric over time, called a *sparkline*, and a horizontal meter, filled to reflect a percentage of the total value.
- Additional values are revealed as mouse-over tool-tips.
- Additional values are revealed as mouse-over tooltips.

### Tool-tips

- For the *Query* dimension, hovering over the information icon <i class="fa fa-info-circle"></i> reveals the query ID and its example.
- Hovering on a column header reveals an informative tool-tip for that column.
- Hovering on a column header reveals an informative tooltip for that column.
- Hovering on the main metric sparkline highlights the data point and a tooltip shows the data value under the cursor.

![!image](../_images/PMM_Query_Analytics_Main_Metric_Sparkline.jpg)
Expand All @@ -144,7 +144,7 @@ Delete the search text and press Enter to see the full list again.

![!image](../_images/PMM_Query_Analytics_Devices_Add_Columns.jpg)

- When clicked, a text field and list of available metrics are revealed. Select a metric or enter a search string to reduce the list. Selecting a metric adds it to the panel.
- When clicked, a text field and a list of available metrics are revealed. Select a metric or enter a search string to reduce the list. Selecting a metric adds it to the panel.
- A metric column is removed by clicking on the column heading and selecting *Remove column*.
- The value plotted in the *main metric* column can be changed by clicking a metric column heading and selecting *Swap with main metric*.

Expand All @@ -155,7 +155,7 @@ Delete the search text and press Enter to see the full list again.

### Pagination

- The pagination device lets you move forwards or backwards through pages, jump to a specific page, and choose how many items are listed per page.
- The pagination device lets you move forward or backward through pages, jump to a specific page, and choose how many items are listed per page.

![!image](../_images/PMM_Query_Analytics_Devices_Pagination.jpg)

Expand Down Expand Up @@ -190,21 +190,21 @@ The *Details* tab contains a *Query time distribution* bar (only for MySQL datab
- *Sum*: A summation of the metric for the selected query, and the percentage of the total;
- *Per Query Stats*: The value of the metric per query.

- Each row in the table is a metric. The contents depends on the chosen dimension.
- Each row in the table is a metric. The contents depend 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.
PMM 2.39.0 now includes a metadata table for QAN to address the issue of identifying problematic queries. This feature allows you to 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.
- *User name*: Username of the 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.
- *Service type*: The service that is being monitored. For example, MySQL, PostgreSQl, etc.
catalinaadam marked this conversation as resolved.
Show resolved Hide resolved

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

Expand All @@ -216,7 +216,7 @@ For PostgreSQL queries (when using `pg_stat_monitor`) the top query will also be
Other useful metrics (when using *pg_stat_monitor*) to monitor PostgreSQL Server performance are [Histograms](https://github.com/percona/pg_stat_monitor/blob/master/docs/USER_GUIDE.md#histogram).
*Histograms* provide more explicit information about number of queries for fingerprint (`queryid`). Ranges are from 0 seconds up to 100 seconds.

Here is picture of *histogram* in graph:
Here is a picture of *histogram* in graph:
![!image](../_images/PMM_Query_Analytics_Tabs_Details_Histogram.png)

### Examples Tab
Expand Down Expand Up @@ -250,11 +250,11 @@ 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.
You will get results like in previous PMM versions. This method of `explain` prevents data leaks.

!!! 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.
To run the `EXPLAIN` command, you need the same permissions as for executing the original query. For example, if you want to run `EXPLAIN` on an `UPDATE` query, you need to have update permissions
catalinaadam marked this conversation as resolved.
Show resolved Hide resolved

Example: Grant the `explainRole` with update permissions.

Expand Down Expand Up @@ -285,28 +285,37 @@ The *Plan* tab shows the plan for PostgreSQL queries (only available when using
QAN offers support for two types of query sources: `pg_stat_monitor` (PGSM) and `pg_stat_statements` (PGSS). While PGSS used to be the default query source, recent PMM versions have transitioned to PGSM.
If PGSM is unavailable on your system, QAN will seamlessly fall back to PGSS and you will be notified of this in pmm-admin.


PMM has integrated support for [pg_stat_monitor](https://docs.percona.com/pg-stat-monitor/index.html) 2.0 (PGSM 2.0) into QAN starting with version 2.36. This robust tool enhances PostgreSQL query performance monitoring by providing access to the latest improvements and fixes included in PGSM2, including:

- Improved internal architecture that results in fewer lock acquisitions and increases performance by approximately 20%.
- Support for PostgreSQL 15
- Enhanced consistency with `pg_stat_statements` so that the `pg_stat_monitor` view has identical column names, columns, and data types as `pg_stat_statements` for every major version of PostgreSQL from versions 11 to 15.
- A bucket status indication (done vs. current) eliminates the need for the tool to evaluate bucket status and facilitates accurate data display.
- The generation of a unique ID for a query makes it easier to monitor query planning, execution, and performance regardless of version, database, user, or schema.
- It has backward compatibility with your historical data (data collected by older PMM and PGSM)
- Backward compatibility with your historical data (data collected by older PMM and PGSM)
- More detailed histogram ranges
- Security improvements
- All previous PGSM versions are still supported
- Support for all previous PGSM versions

### PostreSQL 9.x

PMM 2.43.0 upgraded the 'pg_query_go' package to version 5. This version helps parse PostgreSQL queries in QAN, provides improved functionality, and enables subsequent upgrades of important dependencies.

However, this new version does not support listing PostgreSQL database tables for versions 9.4, 9.5, and 9.6 in QAN. Since all PostgreSQL 9.x versions have already reached their end-of-life status, we recommend upgrading to a supported version of PostgreSQL.

!!! note alert alert-primary "Postgres 15"
You will probably need to grant more permissions to the user in PostgreSQL 15. An error message will appear in the `pmm-agent` log if more permissions are required. This behavior is pertaining to PostgreSQL and not PMM.
If you're looking to upgrade, you can easily [install the latest version of Percona Distribution for PostgreSQL](https://docs.percona.com/postgresql/16/installing.html).

You can use this query:

### PostreSQL 15
You will probably need to grant more permissions to the user in PostgreSQL 15. An error message will appear in the `pmm-agent` log if more permissions are required. This behavior pertains to PostgreSQL and not PMM.

You can use this query:
```
CREATE USER pmm WITH SUPERUSER ENCRYPTED PASSWORD 'USERNAME';
```
where `USERNAME` should be replaced by the user.


## Query Analytics for MongoDB

MongoDB is conceptually different from relational database management systems, such as MySQL and MariaDB.
Expand Down
17 changes: 10 additions & 7 deletions docs/how-to/troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,17 +111,20 @@ Logs obtained in this way include PMM Client logs and logs received from the PMM

Beginning with [PMM 2.4.0](../release-notes/2.4.0.md), there is a flag that enables the fetching of [`pprof`](https://github.com/google/pprof) debug profiles and adds them to the diagnostics data. To enable, run `pmm-admin summary --pprof`.

You can get PMM Server logs with either of these methods:
## Accessing logs and PMM Server data

**Direct download**
Download logs and components configuration to troubleshoot any issues with the PMM Server:

In a browser, visit `https://<address-of-your-pmm-server>/logs.zip`.
1. Through direct URL, by visiting `https://<address-of-your-pmm-server>/logs.zip`.
2. By calling the Logs endpoint, which enables you to customize the log content using the `line-count` parameter: For example:

**From Help menu**
- Default 50,000 lines: `https://<pmm-server>/logs.zip`
- Custom number of lines: `https://<pmm-server>/logs.zip?line-count=10000`
- Unlimited, full log: `https://<pmm-server>/logs.zip?line-count=-1`
3. Through the UI, by selecting the **Help > PMM Logs** option from the main menu.

1. Select <i class="uil uil-question-circle"></i> *Help* → <i class="uil uil-download-alt"></i> *PMM Logs*.

2. Click *PMM Logs* to retrieve PMM diagnostics data which can be examined and shared with our support team should you need help.
If you need to share logs with Percona Support via an SFTP server, you can also use the **PMM Dump** option from the Help menu to generate a compressed tarball file containing a comprehensive export of your PMM metrics and QAN data.
For more information, see [Export PMM data with PMM Dump](../how-to/PMM_dump.md) topic in the product documentation.

#### Connection difficulties

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

| **Release date** | July , 2024 |
| ----------------- | ----------------------------------------------------------------------------------------------- |
| **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.

## What's new in this release

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.43.0](2.43.0.md)
- [Percona Monitoring and Management 2.42.0](2.42.0.md)
- [Percona Monitoring and Management 2.41.2](2.41.2.md)
- [Percona Monitoring and Management 2.41.1](2.41.1.md)
Expand Down
1 change: 1 addition & 0 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,7 @@ nav:
- faq.md
- Release notes:
- release-notes/index.md
- "PMM 2.43.0": release-notes/2.43.0.md
- "PMM 2.42.0": release-notes/2.42.0.md
- "PMM 2.41.2": release-notes/2.41.2.md
- "PMM 2.41.1": release-notes/2.41.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.42.0'
version: '2.42.0'
release_date: 2024-06-11
release: '2.43.0'
version: '2.43.0'
release_date: 2024-07-11
catalinaadam marked this conversation as resolved.
Show resolved Hide resolved

# SVG icons. Use in markdown as {{icon.<name>}}
# For the Percona image icon (encoded inline SVG), see https://css-tricks.com/using-svg/
Expand Down
Loading