Skip to content
This repository has been archived by the owner on Jan 15, 2025. It is now read-only.

Commit

Permalink
Documentation for 2.44.0 (#1334)
Browse files Browse the repository at this point in the history
* rel notes draft for 2.44

* feedback from Nailya

* updated rel date

* added screenshot

* added 2.44 topic in ToC

* feedback from Roma and Nurlan

* feedback from Roma

* Update docs/release-notes/2.44.0.md

Co-authored-by: Roman Novikov <[email protected]>

* Update docs/release-notes/2.44.0.md

Co-authored-by: Roman Novikov <[email protected]>

* feedback from Roma

* fixed formatting

* feedback from Radoslaw

* Update pmm-admin.md

* updated screenshot and link

* Update docs/release-notes/2.44.0.md

Co-authored-by: Steve Hoffman <[email protected]>

* Update docs/release-notes/2.44.0.md

Co-authored-by: Steve Hoffman <[email protected]>

* Update docs/release-notes/2.44.0.md

Co-authored-by: Steve Hoffman <[email protected]>

* feedback from Steve

* mentioned PMM-13602

* feedback from Nurlan

* feedback from Nailya

* updated release date

---------

Co-authored-by: Roman Novikov <[email protected]>
Co-authored-by: Steve Hoffman <[email protected]>
  • Loading branch information
3 people authored Dec 13, 2024
1 parent 4bb46aa commit bbd7a3b
Show file tree
Hide file tree
Showing 6 changed files with 61 additions and 12 deletions.
Binary file added docs/_images/Oplog_Details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 9 additions & 6 deletions docs/details/commands/pmm-admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ PMM communicates with the PMM Server via a PMM agent process.
- `--service-id=service-id`: Service ID.
- `--force`: Remove service with that name or ID and all dependent services and agents.

Note: When you remove a service, collected data remains on PMM Server for the specified [retention period](../../faq.md#retention).
Note: When you remove a service, collected data remains on PMM Server for the specified [retention period](../../faq.md).

=== "pmm-admin annotate"

Expand Down Expand Up @@ -337,7 +337,7 @@ MongoDB exporter includes the following collectors:
- `topmetrics`
- `currentop`: This only collects operations running for longer than one minute and ignores operations in the admin and local databases.
- `fcv` (Feature Compatibility Version)

##### Advanced options

PMM starts the MongoDB exporter by default only with `diagnosticdata` and `replicasetstatus` collectors enabled.
Expand Down Expand Up @@ -370,10 +370,13 @@ FLAGS:

=== "Enable all collectors"

!!! caution alert alert-warning "Warning"
Before using `--enable-all-collectors` with MongoDB Service, be aware that the MongoDB exporter's memory usage may increase significantly when monitoring MongoDB clusters, especially with sharding and multiple collections. If you frequently create new collections or work with many collections, disable the `collstats`collector to prevent memory consumption issues.
To enable all collectors, pass the parameter `--enable-all-collectors` in the `pmm-admin add mongodb` command.
This will enable `collstats`, `dbstats`, `indexstats`, `topmetrics`, `currentopmetrics` and `fcv` collectors.

Examples:
Examples:

1. To add MongoDB with all collectors (`diagnosticdata`, `replicasetstatus`, `collstats`, `dbstats`, `indexstats`, `currentopmetrics`, `topmetrics` and `fcv`) with default limit detected by PMM (currently <=200 collections, but subject to change):

Expand Down Expand Up @@ -420,15 +423,15 @@ FLAGS:
| `db2` | **Only** for collection `col1` |

5. Enable all collectors and limit monitoring for `dbstats`, `indexstats`, `collstats` and `topmetrics` for all collections in `db1` and `col1` collection in `db2`, without limiting `max-collections-limit` for a number of collections in `db1`:

```
pmm-admin add mongodb --username=admin --password=admin_pass --enable-all-collectors --max-collections-limit=0 --stats-collections=db1,db2.col1 mongodb_srv_1 127.0.0.1:27017
```
=== "Disable some collectors"

To enable only some collectors, pass the parameter `--enable-all-collectors` along with the parameter `--disable-collectors`.

Examples:
Examples:

1. If you want all collectors except `topmetrics`, specify ```
--enable-all-collectors --disable-collectors=topmetrics
Expand Down Expand Up @@ -612,7 +615,7 @@ In low resolution we collect metrics from collectors which could take some time:

`--disable-queryexamples`
: Disable collection of query examples. Applicable only if `query-source` is set to `pgstatmonitor`.

`--environment=<environment>`
: Environment name.

Expand Down
2 changes: 1 addition & 1 deletion docs/details/dashboards/dashboard-mongodb_oplog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This realtime dashboard contains Oplog details such as Recovery Window, Processing Time, Buffer Capacity, and Oplog Operations.

![!image](../../_images/Mongodb_Oplog.png)
![Updated Oplog Details dashboard](../../_images/Oplog_Details.png)
45 changes: 45 additions & 0 deletions docs/release-notes/2.44.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Percona Monitoring and Management 2.44.0

| **Release date** | December 13th, 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.

## Support for version 8.0 of Percona Server for MongoDB (PSMDB), MongoDB Community, and MongoDB Enterprise

The latest version of MongoDB Community edition, along with the upcoming [PSMDB 8.0](https://www.percona.com/software/mongodb/percona-server-for-mongodb), introduce [numerous improvements and significant performance enhancements](https://www.mongodb.com/docs/manual/release-notes/8.0/).

We have updated PMM 2 to include support for these new versions, including changes to `mongodb_exporter` to accommodate the revised metrics structure (e.g., `wiredTiger.concurrentTransactions` is now `queues.execution`).

The MongoDB **Oplog Details** dashboard has also been adapted to support MongoDB 8.0's new oplog metrics, with updated panels for **Oplog Buffered Operations** and **Buffer Capacity**.

![Updated Oplog Details dashboard](../_images/Oplog_Details.png)

!!! hint alert alert-success "Important notes"
- This enhancement requires PMM Agent version 2.43.1 or later.

- MongoDB 8.0 introduces significant changes to its internal metrics structure. While we have updated PMM’s built-in dashboards to reflect these changes, you may need to update any custom dashboards to align with the new metrics.

- When using the `--enable-all-collectors` flag, monitor memory usage carefully with MongoDB clusters, especially in sharded environments with multiple collections. If you frequently create new collections or work with many collections, disable the `collstats` collector to prevent memory consumption issues.

## Improved PostgreSQL 17 metrics collection

PMM 2.44.0 strengthens monitoring capabilities for PostgreSQL 17, building on the recent support for Query Analytics (QAN) introduced in PMM 2.43.2.

This previous release updated field names for PostgreSQL 17 compatibility (e.g., `blk_read_time` to `shared_blk_read_time`).

This release further enhances PostgreSQL monitoring with updated queries aligned with PostgreSQL 17's schema changes to ensure accurate metrics collection in the [PostgreSQL Instances Overview dashboard](../details/dashboards/dashboard-postgresql-instances-overview.md).

We've also improved collector support, including proper recognition of PostgreSQL 17 columns like `checkpoints_timed` in the `stat_bgwriter` collector.


## Fixed metrics collection for MongoDB backups

We've resolved an issue where Percona Backup for MongoDB (PBM) metrics were not being scraped by default and required the `--enable-all-collectors` flag.

With this fix, PBM metrics are now automatically collected when MongoDB services are added to PMM, without requiring additional configuration.

However, PBM metrics collection is disabled for PMM Clients 2.43.0 and 2.43.1 due to a memory leak identified in these versions. This functionality is supported starting with PMM Client 2.43.2 and later.
5 changes: 3 additions & 2 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ plugins:
with-pdf:
output_path: "_pdf/PerconaMonitoringAndManagement-2.43.0.pdf"
cover_title: "Percona Monitoring and Management Documentation"
cover_subtitle: 2.43.2 (October 30, 2024)
cover_subtitle: 2.44.0 (December 13th, 2024)
author: "Percona Technical Documentation Team"
cover_logo: docs/_images/pmm_pdf_logo.png
custom_template_path: _resources/templates
Expand Down Expand Up @@ -345,7 +345,8 @@ nav:
- "Backup and restore": dbaas/backup_restore.md
- faq.md
- Release notes:
- release-notes/index.md
- release-notes/index.md
- "PMM 2.44.0": release-notes/2.44.0.md
- "PMM 2.43.2": release-notes/2.43.2.md
- "PMM 2.43.1": release-notes/2.43.1.md
- "PMM 2.43.0": release-notes/2.43.0.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.43.2'
version: '2.43.2'
release_date: 2024-10-30
release: '2.44.0'
version: '2.44.0'
release_date: 2024-12-13

# 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

0 comments on commit bbd7a3b

Please sign in to comment.