Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
110ca12
release setup
catalinaadam Jun 18, 2026
101c84d
PMM-13306
catalinaadam Jun 29, 2026
148b5bf
PMM-13306
catalinaadam Jun 29, 2026
119fd08
PMM-15029
catalinaadam Jun 29, 2026
5448a22
PMM-15030
catalinaadam Jun 29, 2026
f27fed4
PMM-14661
catalinaadam Jun 29, 2026
faac310
PMM-14661
catalinaadam Jul 1, 2026
9da5eb8
PMM-14576
catalinaadam Jul 6, 2026
f8d0003
PMM-14193
catalinaadam Jul 6, 2026
f7cd284
PMM-14519
catalinaadam Jul 6, 2026
15f50c5
PMM-15145]
catalinaadam Jul 6, 2026
decaa71
PMM-13910
catalinaadam Jul 6, 2026
6ff9d42
PMM-15139
catalinaadam Jul 7, 2026
b7a7ad8
PMM-14193
catalinaadam Jul 7, 2026
fe1b01c
[DOC] Document low-memory ClickHouse configuration and deprecate swit…
catalinaadam Jul 7, 2026
9a53292
Merge branch 'main' into doc-3.9.0
catalinaadam Jul 7, 2026
47b4ac3
PMM-15118
catalinaadam Jul 7, 2026
e9ab499
PMM-15114
catalinaadam Jul 7, 2026
3924c23
[DOC] PMM-15001: Document OVF removal (#5607)
catalinaadam Jul 8, 2026
35e0da3
[DOC] Clarify Nomad prerequisites: require PMM_PUBLIC_ADDRESS for Nom…
catalinaadam Jul 8, 2026
8ec48da
mentioned error
catalinaadam Jul 8, 2026
4a0abab
Merge origin/main and resolve documentation conflicts
Copilot Jul 8, 2026
15928bb
[DOC] Remove unused images from documentation (#5626)
catalinaadam Jul 9, 2026
07f811a
draft
catalinaadam Jul 14, 2026
aa775b4
[DOC] RTA data export (PMM-14609) (#5642)
catalinaadam Jul 14, 2026
4fa193c
draft
catalinaadam Jul 16, 2026
99544e3
[DOC] Quick-Install feature
catalinaadam Jul 17, 2026
9895057
Merge branch 'doc-3.9.0' into doc-one-click-client-install
catalinaadam Jul 20, 2026
d49e451
feedback from Shruti
catalinaadam Jul 20, 2026
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
20 changes: 20 additions & 0 deletions documentation/docs/admin/security/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,23 @@ Taking the following precautions will ensure that you are truly secure:
- [Grafana HTTPS secure cookies](../../admin/security/grafana_cookies.md)
- [Encrypt the PMM Client configuration file](client_config_encryption.md) to protect stored credentials on client hosts

## Manually configure the PostgreSQL Grafana datasource

Starting with PMM 3.9.0, PMM no longer provisions a PostgreSQL Grafana datasource by default. If you need to query PMM's internal PostgreSQL database directly, you can add the datasource manually.

To prevent unauthorized data modification, configure the datasource with a database user that has **SELECT**-only permissions.

To add the PostgreSQL datasource:
{.power-number}

1. From the **Home** page, locate the Search icon (top right on the screen).
2. Type "plugins" and select **Administration > Plugins and data > Plugins**.
3. Find and open the **Postgres** plugin.
4. Select **Add new datasource**.
5. Configure the connection parameters and click **Save & test**.
6. If the test is successful, you can start using the datasource from the **Explore** page.

!!! note

You might see this datasource labeled as unsupported. You can safely disregard that label. The PostgreSQL datasource works as expected.

Binary file added documentation/docs/images/ExportRTA.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 removed documentation/docs/images/PMM-manage-users.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
4 changes: 2 additions & 2 deletions documentation/docs/install-pmm/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Before ou install PMM, ensure your environment is properly prepared:

### PMM Server deployment options

Compare the available deployment methods to choose what works best for your setup. For a fast evaluation setup, Docker is the quickest option. For production environments, consider your existing infrastructure stack and operational preferences when choosing between Docker, Kubernetes (Helm), or Virtual Appliance deployments:
Compare the available deployment methods to choose what works best for your setup. For a fast evaluation setup, Docker is the quickest option. For production environments, consider your existing infrastructure stack and operational preferences when choosing between Docker or Kubernetes (Helm) deployments:

| Deployment Method | Best for | Advantages | Considerations |
| Deployment method | Best for | Advantages | Considerations |
|-------------------|----------|------------|----------------|
| [Docker](../install-pmm/install-pmm-server/deployment-options/docker/index.md) | Quick setup, development environments | • Fast deployment<br>• Easy to manage<br>• Runs without root privileges<br>• Minimal resource overhead | • Requires Docker knowledge<br>• May need additional network configuration |
| [Podman](../install-pmm/install-pmm-server/deployment-options/podman/index.md) | Security-conscious environments | • Rootless by default<br>• Enhanced security<br>• Docker-compatible commands<br>• No daemon required | • Requires Podman installation<br>• Less common than Docker |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,7 @@ After configuring your database server, add a MongoDB service using either the u

!!! hint alert alert-success "Tips"
- When adding members of a replica set or sharded cluster, ensure to add each node using the same `--cluster my_cluster_or_rs_name`. This allows the [MongoDB Cluster Summary](../../../reference/dashboards/dashboard-mongodb-cluster-summary.md) and [MongoDB ReplSetSummary](../../../reference/dashboards/dashboard-mongodb-replset-summary.md) dashboards to populate correctly.
- Some dashboard panels, such as **Total data size** on the [MongoDB ReplSet Summary](../../../reference/dashboards/dashboard-mongodb-replset-summary.md) and [MongoDB Sharded Cluster Summary](../../../reference/dashboards/dashboard-mongodb-cluster-summary.md) dashboards, require the `dbstats` collector. Pass [`--enable-all-collectors`](../../../use/commands/pmm-admin/add.md#collector-options) when adding the service to enable it.
- PMM does not gather collection and index metrics if it detects you have more than 200 collections, in order to limit the resource consumption. Check the [advanced options](../../../use/commands/pmm-admin/add.md#collector-options) section if you want to modify this behaviour.
- When running mongos routers in containers, specify the `diagnosticDataCollectionDirectoryPath` to ensure that pmm-agent can properly capture mongos metrics. For example: `mongos --setParameter diagnosticDataCollectionDirectoryPath=/var/log/mongo/mongos.diagnostic.data/`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Install PMM Client using one of the following deployment methods:

| **Your setup** | **Recommended deployment** |
|----------------|----------------------------|
| **Quick one-step installation from the UI | **[Quick-Install PMM Client (Technical Preview) →](one-click-install.md)** |
| **Production** environments on supported Linux distributions | **[Package Manager →](package_manager.md)** |
| Unsupported Linux distributions or **non-root** installation | **[Binary Package →](binary_package.md)** |
| **Containerized** environments or testing | **[Docker →](docker.md)** |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Quick-Install PMM Client


!!! warning "Technical Preview status"
This feature is not production-ready yet. Try it out and share your feedback on the [PMM forum](https://forums.percona.com/c/percona-monitoring-and-management-pmm/pmm-3/84) or [JIRA Tracker](https://perconadev.atlassian.net/jira/software/c/projects/PMM/issues/).

Instead of manually installing PMM Client, registering the node, and adding a database service separately, you can do it all with a single command generated from the PMM UI.

## Prerequisites

- A running PMM Server instance.
- A Linux host with root or sudo access where your database is running.
- A database monitoring user with the appropriate permissions for your database type.
- The PMM Server must be reachable from the database host over HTTPS.

## Generate and run the install command

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Please add some screenshots for this new page


Generate and run the install command from the PMM UI:
{.power-number}

1. Log in to the PMM web interface as an Admin user.

2. In the left sidebar, go to **Inventory > Install PMM Client**.

3. Select your database technology from the **Technology** dropdown: **MySQL**, **PostgreSQL**, **MongoDB**, or **Valkey**.

4. Check the **PMM host** field. It is pre-filled with the current server's hostname. Change it only if your database host connects to PMM Server at a different address. Do not include http/https or paths.

5. Click **Generate install token**. PMM creates a temporary Admin-level token and fills it into the **Service token** field automatically. The token expires in 15 minutes. Do not share the generated command as it contains an Admin-level token.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Click "Generate short-lived token"


6. By default, the command prompts for your database credentials when you run it on the terminal. To skip the prompt, toggle on **Running in CI/automation?** and enter your database username and password before copying the command.

7. (Optional) Expand **Advanced options** to customize your service name, port, and node settings.

8. Copy the generated command and run it on your database host with `sudo`:

```sh
curl -fsSLk -o '/tmp/install-pmm-client.sh' 'https://<pmm-server-IP>/pmm-static/install-pmm-client.sh'
sudo -E bash '/tmp/install-pmm-client.sh'
--pmm-server-url 'https://<service_token>:@<pmm-server-IP'
--tech '<technology>'
--pmm-server-insecure-tls
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

curl -fsSLk -o '/tmp/install-pmm-client.sh' 'https:///pmm-static/install-pmm-client.sh'
sudo -E bash '/tmp/install-pmm-client.sh'
--pmm-server-url 'https://service_token:@'
--tech 'technology'
--pmm-server-insecure-tls

Please refer this for the command


The command installs PMM Client, registers the node with PMM Server, and adds the first monitored service automatically.

9. Verify that the node and service appear in PMM under **Inventory > Services**.

## Add more databases on the same node

To monitor a second database on the same node, generate a new command for the additional technology and set a different port in **Advanced options**. The command skips node re-registration after the first run, so your existing monitored services are not affected.

## Re-add a previously removed service

If you removed a service from PMM and the command now fails with an authentication error, the token has expired. Regenerate the command here and re-run it. The command re-adds the service without affecting other services on the node.

!!! warning
Do not use **Force re-register node** in **Advanced options** when re-adding a service. This removes the node and all its services from PMM and should only be used to recover from a failed first install.

## Related topics

- [Connect database services](connect-database/index.md)
- [PMM Client installation overview](index.md)
- [Install PMM Client with Package Manager](package_manager.md)
Original file line number Diff line number Diff line change
Expand Up @@ -166,14 +166,15 @@ Control how PMM Server presents itself on the network:

| Variable | Description |
|----------|-------------|
| `PMM_PUBLIC_ADDRESS` | External DNS/IP for PMM server |
| `PMM_PUBLIC_ADDRESS` | External DNS/IP for PMM Server. Also required for Nomad to start. Setting `PMM_ENABLE_NOMAD=1` without this variable has no effect. |
| `PMM_INTERFACE_TO_BIND` | Network interface binding |

### Database connections
Configure connections to external database services:

| Variable | Purpose |
|----------|----------|
| `PMM_CLICKHOUSE_CONFIG` | Set to `low-memory` to activate the built-in ClickHouse profile optimized for hosts with less than 16 GB RAM. Omit or set to `default` for standard deployments. See [ClickHouse memory issues](../../../../troubleshoot/qan_issues.md#clickhouse-memory-issues-in-low-memory-environments). |
| `PMM_CLICKHOUSE_*` | ClickHouse connection settings |
| `PMM_POSTGRES_*` | PostgreSQL connection settings |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ For information on PMM's architecture, see [PMM architecture](../../reference/in
## PMM Server deployment options

| **Method** | **Best for** | **Advantages** | **Considerations** |
|-----------|------------|---------------|--------------------|
|-----------|------------|---------------|-----------------|
| [**:material-docker: Docker**](../install-pmm-server/deployment-options/docker/index.md) | Development, testing & production | ✔ Quick setup<br>✔ Simple upgrades<br>✔ Works in various environments | ⚠ Requires Docker knowledge<br>⚠ May need additional configuration for production |
| [**:material-shield-lock: Podman**](../install-pmm-server/deployment-options/podman/index.md) | Security-focused setups | ✔ Rootless containers<br> ✔ Enhanced security<br> ✔ OCI-compatible | ⚠ Requires Podman installation & knowledge |
| [**:material-kubernetes: Helm**](../install-pmm-server/deployment-options/helm/index.md) | Cloud-native environments | ✔ Scalable & high availability<br> ✔ Kubernetes-native | ⚠ Requires existing Kubernetes cluster<br>⚠ More complex setup |
Expand All @@ -56,7 +56,7 @@ Based on the scale and environment of your monitoring needs, we recommend differ

=== "Small-scale (1-30 database instances)"

- **PMM Server**: Docker or Virtual Appliance
- **PMM Server**: Docker
- **PMM Client**: Package Manager
- **Implementation tips**:
- for Docker, use the easy install script for quick setup
Expand Down Expand Up @@ -121,4 +121,3 @@ Review this checklist to help you plan and size your monitoring environment and

[Hardware and system requirements](../plan-pmm-installation/hardware_and_system.md){.md-button}


2 changes: 1 addition & 1 deletion documentation/docs/pmm-upgrade/migrating_from_pmm_2.md
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ The following table lists all the environment variable changes between PMM v2 an

#### ClickHouse configuration
| PMM 2 | PMM 3 | Comments |
|-------------------------------------|------------------------------------|--------------------------|
|-------------------------------------|------------------------------------|---------------------------|
| `PERCONA_TEST_PMM_CLICKHOUSE_ADDR` | `PMM_CLICKHOUSE_ADDR` | |
| `PERCONA_TEST_PMM_CLICKHOUSE_DATABASE` | `PMM_CLICKHOUSE_DATABASE` | |
| `PERCONA_TEST_PMM_CLICKHOUSE_DATASOURCE` | `PMM_CLICKHOUSE_DATASOURCE` | |
Expand Down
Loading