diff --git a/documentation/docs/admin/roles/access-control/assign_roles.md b/documentation/docs/admin/roles/access-control/assign_roles.md index c6726024b6a..e6be8948f32 100644 --- a/documentation/docs/admin/roles/access-control/assign_roles.md +++ b/documentation/docs/admin/roles/access-control/assign_roles.md @@ -9,4 +9,4 @@ To assign access roles to users: 4. From the **Roles** drop-down select the appropriate roles. 5. Verify the assigned roles appear in the **Access Role** column. -![PMM Access Control - Assign role](../../../images/lbac/PMM_access_control_select_role.png) + ![PMM Access Control - Assign role](../../../images/lbac/PMM_access_control_select_role.png) diff --git a/documentation/docs/advisors/advisors.md b/documentation/docs/advisors/advisors.md index dfaa17714cd..8f3c5110478 100644 --- a/documentation/docs/advisors/advisors.md +++ b/documentation/docs/advisors/advisors.md @@ -19,7 +19,7 @@ Check results *always* remain on the PMM Server. They are never sent as part of ## Configure execution intervals To control when and how often advisor checks run: -- for all checks: Navigate to **PMM Configuration > Settings > Execution Intervals** to set global default intervals. +- for all checks: Navigate to **Configuration > Settings > Advanced settings** and use the **Rare**, **Standard**, and **Frequent** interval fields in the **Advisors** section to set global default intervals. - for individual checks: Navigate to the specific advisor category (such as **Advisors > Security Advisors**, **Configuration Advisors**, **Query Advisors**, or **Performance Advisors**), then click the Edit icon in the **Actions** column to override the global setting for specific checks. ### Change run interval for automatic advisors diff --git a/documentation/docs/advisors/develop-advisor-checks.md b/documentation/docs/advisors/develop-advisor-checks.md index ff195e4cee1..fb50260da0b 100644 --- a/documentation/docs/advisors/develop-advisor-checks.md +++ b/documentation/docs/advisors/develop-advisor-checks.md @@ -230,7 +230,7 @@ To develop custom checks for PMM: 3. Log into Grafana with credentials **admin/admin**. -4. Go to **PMM Configuration > Settings > Advanced Settings** and make sure the **Advisors** option is enabled. +4. Go to **Configuration > Settings > Advanced settings** and make sure the **Advisors** option is enabled. 5. Create `/srv/custom-checks.yml` inside the `pmm-server` container with the content of your check. Specify **dev** advisor in your check. diff --git a/documentation/docs/alert/alert_rules.md b/documentation/docs/alert/alert_rules.md index 65f5cfa5aee..47e832678a4 100644 --- a/documentation/docs/alert/alert_rules.md +++ b/documentation/docs/alert/alert_rules.md @@ -5,15 +5,16 @@ Alert rules describe the circumstances under which you want to be alerted. The e An alert rule consists of one or more queries and expressions, a condition, the frequency of evaluation, and the duration over which the condition is met. For example, you might configure an alert to fire and trigger a notification when MongoDB is down. -An alert rule can be in three possible states: +During evaluation, an alert rule moves through the following states: -- Normal: Everything is working correctly and the conditions specified in the rule has not been met. This is the default state for newly created rules. -- Pending: The conditions specified in the alert rule has been met, but for a time that is less than the configured duration. -- Firing: Both the conditions and the duration specified in the alert rule have both been met. +- **Normal**: Everything is working correctly, and the conditions specified in the rule have not been met. This is the default state for newly created rules. +- **Pending**: The conditions specified in the alert rule have been met, but for less time than the configured duration. +- **Firing**: Both the alert condition and the configured duration have been met. +- **Recovering**: The alert conditions are no longer met, but the alert remains active until the metric is stable below the threshold. This prevents alerts from repeatedly flipping between **Firing** and **Normal** when metrics briefly cross a threshold. It takes at least one evaluation cycle for an alert rule to transition from one state to another (e.g., from `Normal` to `Pending`). -## Alert rules templates +## Alert rule templates PMM provides a set of Alert Rule templates with common events and expressions for alerting. These templates can be used as a basis for creating Alert Rules. You can also create your own templates if you need custom expressions. @@ -37,7 +38,7 @@ This section focuses on creating an alert rule based on PMM templates. For infor Before creating PMM alert rules, configure the required alert resources: {.power-number} -1. Go to **PMM Configuration > Settings > Advanced Settings** and ensure that the **Percona Alerting** option is enabled. When this is disabled, the **Alerting** page displays only Grafana-managed alert rules. This means that you will not be able to create alerts based on PMM templates. +1. Go to **Configuration > Settings > Advanced settings** and ensure that the **Percona Alerting** option is enabled. When this is disabled, the **Alerting** page displays only Grafana-managed alert rules. This means that you will not be able to create alerts based on PMM templates. 2. Go to **Dashboards** and check the folders available for storing alert rules. If none of the available folders are relevant for your future alert rules, click **New > New Folder** and create a custom one. 3. Go to **Alerting > Alert rule templates** and check the default PMM templates. If none of the templates include a relevant expression for the type of alerts that you want to create, click **Add template** to create a custom template instead. @@ -109,7 +110,7 @@ If you want to create custom templates, you can test the MetricsQL expressions f To test expressions for custom templates: {.power-number} -1. On the main menu in PMM, choose **Explore > Metrics**. +1. On the main menu in PMM, choose **Explore > PromQL builder**. 2. Enter your expression in the **Metrics** field and click **Run query**. For example, to check the CPU usage, Go to **Explore > PromQL builder** and run the query expression below: diff --git a/documentation/docs/alert/disable_alerts.md b/documentation/docs/alert/disable_alerts.md index 67c0dc41e3a..9339cfe7a36 100644 --- a/documentation/docs/alert/disable_alerts.md +++ b/documentation/docs/alert/disable_alerts.md @@ -5,5 +5,5 @@ Percona Alerting is enabled by default in the PMM Settings. This feature adds th If for some reason you want to disable PMM Alert templates and keep only Grafana-managed alerts: {.power-number} -1. Go to **PMM Configuration > Settings > Advanced settings**. +1. Go to **Configuration > Settings > Advanced settings**. 2. Disable the **Alerting** option. The **Alerting** menu will now display only Grafana-managed alert rules. \ No newline at end of file diff --git a/documentation/docs/alert/silence_alerts.md b/documentation/docs/alert/silence_alerts.md index 0fa5855b9e5..90f706f03f3 100644 --- a/documentation/docs/alert/silence_alerts.md +++ b/documentation/docs/alert/silence_alerts.md @@ -22,7 +22,7 @@ To create a new silence: 4. Enter one or more matching labels by filling out the **Name** and **Value** fields. Matchers determine which rules the silence will apply to. Note that all labels specified here must be matched by an alert for it to be silenced. 5. Enter any additional comments you would like about this silence - by default, the date the silence was created is placed here. 6. Review the affected alert instances that will be silenced. -7. Click **Save silece**. +7. Click **Save silence**. For more information on working with silences, see [About alerting silences](https://grafana.com/docs/grafana/latest/alerting/manage-notifications/create-silence/) in the Grafana documentation. @@ -32,7 +32,7 @@ For more information on working with silences, see [About alerting silences](htt After upgrading from the latest PMM 2 version to PMM 3, you will find all your alert templates under **Alerting > Alert rule templates**. -If you have any templates available in the `/srv/ia/templates` folder, make sure to transfer them to `/srv/alerting/templates` as PMM 3 will look for custom templates in this location. +If you have any templates available in the `/srv/ia/templates` folder, make sure to transfer them to `/srv/alerting/templates` as PMM 3 will look for custom templates in this location. ### Template compatibility with other alerting tools diff --git a/documentation/docs/configure-pmm/advanced_settings.md b/documentation/docs/configure-pmm/advanced_settings.md index 86aab4ec9ad..749d65eefd3 100644 --- a/documentation/docs/configure-pmm/advanced_settings.md +++ b/documentation/docs/configure-pmm/advanced_settings.md @@ -16,7 +16,7 @@ PMM Telemetry is based on data collected by various PMM components and stored in !!! note alert alert-primary "" When PMM is installed, telemetry is not sent immediately. Before the first telemetry report is generated, PMM provides users with a 24-hour grace period to disable telemetry. -To see the metrics being collected by telemetry, from the [main menu](../reference/ui/ui_components.md#1-main-menu) navigate to **PMM Configuration** > :material-cog-outline: **Settings** > **Advanced Settings** > **Telemetry** and hover over the exclamation mark. +To see the metrics being collected by telemetry, from the [main menu](../reference/ui/ui_components.md#1-main-menu) navigate to **Configuration > Settings > Advanced settings > Telemetry** and hover over the exclamation mark. ![!image](../images/PMM_Settings_Advanced_Settings_Telemetry.png) @@ -33,7 +33,7 @@ The landing page for this service, [check.percona.com](https://check.percona.com Grafana’s [anonymous usage statistics](https://grafana.com/docs/grafana/latest/administration/configuration/#reporting-enabled) is not managed by PMM. To activate it, you must change the PMM Server container configuration after each update. -As well as via the **PMM Settings** page, you can also disable telemetry with the `-e DISABLE_TELEMETRY=1` option in your docker run statement for the PMM Server. +You can also disable telemetry with the `-e DISABLE_TELEMETRY=1` option in your docker run statement for the PMM Server. For information on the various config parameters for telemetry, see the [config file](https://github.com/percona/pmm/blob/main/managed/services/telemetry/config.default.yml). @@ -47,7 +47,7 @@ Advisors are sets of checks grouped by functionality that run a range of databas The findings are reported on the **Advisors > Advisor Insights** page, and an overview is displayed on the Home dashboard. -The Advisors toggle is enabled by default and located in the **Execution intervals** section. Checks are re-fetched and rerun at the intervals configured there. +The Advisors toggle is enabled by default. When enabled, you can configure how often checks run using the **Rare**, **Standard**, and **Frequent** interval fields in the same section. See [Working with Advisor checks](../advisors/advisors.md). diff --git a/documentation/docs/configure-pmm/configure.md b/documentation/docs/configure-pmm/configure.md index 456136f6065..33d3ff718d1 100644 --- a/documentation/docs/configure-pmm/configure.md +++ b/documentation/docs/configure-pmm/configure.md @@ -2,7 +2,7 @@ This section provides the instructions to configure your PMM instance after you have installed PMM. -The **PMM Configuration** page gives you access to PMM setup's settings and inventory options: +**Configuration > Settings** gives you access to PMM setup's settings and inventory options: * [Metrics resolution](metrics_res.md) * [Advanced Settings](advanced_settings.md) diff --git a/documentation/docs/images/PMM_Add_Instance_AWS_RDS.png b/documentation/docs/images/PMM_Add_Instance_AWS_RDS.png index 1689cce332f..c981607243c 100644 Binary files a/documentation/docs/images/PMM_Add_Instance_AWS_RDS.png and b/documentation/docs/images/PMM_Add_Instance_AWS_RDS.png differ diff --git a/documentation/docs/images/PMM_Add_Instance_Azure_2.png b/documentation/docs/images/PMM_Add_Instance_Azure_2.png index 305efebb53b..f1f0a68b90f 100644 Binary files a/documentation/docs/images/PMM_Add_Instance_Azure_2.png and b/documentation/docs/images/PMM_Add_Instance_Azure_2.png differ diff --git a/documentation/docs/images/PMM_Add_Instance_MongoDB.jpg b/documentation/docs/images/PMM_Add_Instance_MongoDB.jpg index 2e5d388998e..7cc8b63bf6f 100644 Binary files a/documentation/docs/images/PMM_Add_Instance_MongoDB.jpg and b/documentation/docs/images/PMM_Add_Instance_MongoDB.jpg differ diff --git a/documentation/docs/images/PMM_Add_Instance_PostgreSQL.png b/documentation/docs/images/PMM_Add_Instance_PostgreSQL.png index a5d0840f3c6..e99d80e77d0 100644 Binary files a/documentation/docs/images/PMM_Add_Instance_PostgreSQL.png and b/documentation/docs/images/PMM_Add_Instance_PostgreSQL.png differ diff --git a/documentation/docs/images/PMM_Home_Dashboard.png b/documentation/docs/images/PMM_Home_Dashboard.png index 3dfdd66cbf5..e99d80e77d0 100644 Binary files a/documentation/docs/images/PMM_Home_Dashboard.png and b/documentation/docs/images/PMM_Home_Dashboard.png differ diff --git a/documentation/docs/images/PMM_Home_Dashboard_Panels_Upgrade.png b/documentation/docs/images/PMM_Home_Dashboard_Panels_Upgrade.png index 97a58dcb52a..c510c8a384b 100644 Binary files a/documentation/docs/images/PMM_Home_Dashboard_Panels_Upgrade.png and b/documentation/docs/images/PMM_Home_Dashboard_Panels_Upgrade.png differ diff --git a/documentation/docs/images/PMM_PostgreSQL_Instance_Summary.png b/documentation/docs/images/PMM_PostgreSQL_Instance_Summary.png new file mode 100644 index 00000000000..5e39df625b2 Binary files /dev/null and b/documentation/docs/images/PMM_PostgreSQL_Instance_Summary.png differ diff --git a/documentation/docs/images/PMM_Settings_Advanced_Settings.jpg b/documentation/docs/images/PMM_Settings_Advanced_Settings.jpg index f8a8666f4b7..3cf5d38a6ce 100644 Binary files a/documentation/docs/images/PMM_Settings_Advanced_Settings.jpg and b/documentation/docs/images/PMM_Settings_Advanced_Settings.jpg differ diff --git a/documentation/docs/images/PMM_Settings_Advanced_Settings_Telemetry.png b/documentation/docs/images/PMM_Settings_Advanced_Settings_Telemetry.png index 60fa178085f..4298d60c9a4 100644 Binary files a/documentation/docs/images/PMM_Settings_Advanced_Settings_Telemetry.png and b/documentation/docs/images/PMM_Settings_Advanced_Settings_Telemetry.png differ diff --git a/documentation/docs/images/PMM_Settings_Metrics_Resolution.jpg b/documentation/docs/images/PMM_Settings_Metrics_Resolution.jpg index 436454d87f3..6992588ec1b 100644 Binary files a/documentation/docs/images/PMM_Settings_Metrics_Resolution.jpg and b/documentation/docs/images/PMM_Settings_Metrics_Resolution.jpg differ diff --git a/documentation/docs/images/PMM_Settings_SSH_Key.jpg b/documentation/docs/images/PMM_Settings_SSH_Key.jpg index 6113faa8ed2..7a19701f507 100644 Binary files a/documentation/docs/images/PMM_Settings_SSH_Key.jpg and b/documentation/docs/images/PMM_Settings_SSH_Key.jpg differ diff --git a/documentation/docs/images/PMM_Settings_native_ui.png b/documentation/docs/images/PMM_Settings_native_ui.png new file mode 100644 index 00000000000..16be3da43ba Binary files /dev/null and b/documentation/docs/images/PMM_Settings_native_ui.png differ diff --git a/documentation/docs/images/PMM_access_control_select_role.png b/documentation/docs/images/PMM_access_control_select_role.png index 163d3c891cb..ee8c7266b9a 100644 Binary files a/documentation/docs/images/PMM_access_control_select_role.png and b/documentation/docs/images/PMM_access_control_select_role.png differ diff --git a/documentation/docs/images/PMM_timezone_picker.png b/documentation/docs/images/PMM_timezone_picker.png new file mode 100644 index 00000000000..4cf7b78c8b2 Binary files /dev/null and b/documentation/docs/images/PMM_timezone_picker.png differ diff --git a/documentation/docs/images/Update_page.png b/documentation/docs/images/Update_page.png index 184a7c6feef..c921bdc8bf5 100644 Binary files a/documentation/docs/images/Update_page.png and b/documentation/docs/images/Update_page.png differ diff --git a/documentation/docs/images/alerting-sample-query.png b/documentation/docs/images/alerting-sample-query.png index 1b979005572..998d3ddf3fa 100644 Binary files a/documentation/docs/images/alerting-sample-query.png and b/documentation/docs/images/alerting-sample-query.png differ diff --git a/documentation/docs/images/azure-add-mysql-1.png b/documentation/docs/images/azure-add-mysql-1.png index e56fed8e9d9..e99d80e77d0 100644 Binary files a/documentation/docs/images/azure-add-mysql-1.png and b/documentation/docs/images/azure-add-mysql-1.png differ diff --git a/documentation/docs/images/lbac/PMM_access_control_select_role.png b/documentation/docs/images/lbac/PMM_access_control_select_role.png index 957438fa994..ee8c7266b9a 100644 Binary files a/documentation/docs/images/lbac/PMM_access_control_select_role.png and b/documentation/docs/images/lbac/PMM_access_control_select_role.png differ diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/aws.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/aws.md index 9f445bb66b6..63f0c211130 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/aws.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/aws.md @@ -168,14 +168,14 @@ To configure TLS for your RDS instance: It may take longer for PMM to discover Amazon RDS instances in the `creating` state. You must wait a bit longer until PMM discovers these instances. -The preferred method of adding an Amazon RDS database instance to PMM is via the :material-cog: **PMM Configuration > PMM Inventory > Add Instance** menu option. +The preferred method of adding an Amazon RDS database instance to PMM is via the :material-cog: **Inventory > Add service** menu option. This method supports Amazon RDS database instances that use Amazon Aurora, MySQL, or MariaDB engines, as well as any remote PostgreSQL, ProxySQL, MySQL and MongoDB instances. The following steps are needed to add an Amazon RDS database instance to PMM: {.power-number} -1. In the PMM web interface, go to **PMM Configuration > PMM Inventory > Add Instance > Amazon RDS**. +1. In the PMM web interface, go to **Inventory > Add Instance > Amazon RDS**. ![!image](../../../images/PMM_Add_Instance_AWS_RDS.png) @@ -200,7 +200,13 @@ instances. ![!](../../../images/PMM_Add_Instance_AWS_RDS_Additional_Options.png) - The **Additional options** section contains specific flags which allow you to tune the RDS monitoring. They can allow you to skip connection check, to use TLS for the database connection, not to validate the TLS certificate and the hostname, as well as to disable basic and/or enhanced metrics collection for the RDS instance to reduce costs. + The **Additional options** section contains flags that let you tune RDS monitoring: + + - Skip connection check. + - Use TLS for the database connection. + - Skip TLS certificate and hostname validation. + - Disable basic and/or enhanced metrics collection for the RDS instance to reduce costs. + - Set **Connection timeout** to control how long PMM waits when connecting to the instance. Leave empty to use the default of 5s. Also this section contains a database-specific flag, which would allow Query Analytics for the selected remote database: @@ -276,7 +282,7 @@ When using TLS certificates with Amazon RDS MySQL, make sure to: For PostgreSQL, use the same method described above. {.power-number} -1. In the PMM web interface, go to **PMM Configuration > PMM Inventory > Add Instance > Amazon RDS**. +1. In the PMM web interface, go to **PMM Inventory > Add service > Amazon RDS**. ![!image](../../../images/PMM_rds_postgre_02_discover.png) diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/azure.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/azure.md index 3fc39dc0c88..262b592e000 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/azure.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/azure.md @@ -8,7 +8,7 @@ The Microsoft Azure feature is turned off by default. To turn it on: {.power-number} -1. Go to **PMM Configuration > Settings > Advanced Settings**. +1. Go to **Configuration > Settings > Advanced settings**. 2. Click the toggle in the **Technical preview features** section of the page. @@ -105,8 +105,7 @@ To get the tenant ID, client ID and the client secret: ![!](../../../images/azure_app_secret_02.png) ![!](../../../images/azure_app_secret_03.png) -5. Copy the **value** of the application secret. Once you leave this page you won't be able to see the secret again and you will have to generate a new - one. +5. Copy the **value** of the application secret. Once you leave this page you won't be able to see the secret again and you will have to generate a new one. ![!](../../../images/azure_app_secret_04.png) @@ -121,7 +120,7 @@ To get the tenant ID, client ID and the client secret: ![!](../../../images/azure_app_permissions_03.png) ![!](../../../images/azure_app_permissions_04.png) -When you fill in all fields press the *Discover* button and you will see a list of available databases for monitoring. +When you fill in all fields press the **Discover** button and you will see a list of available databases for monitoring. ![!](../../../images/PMM_Add_Instance_Azure_2.png) @@ -140,13 +139,13 @@ You can find more details on how to create DB on Azure at: - !!! hint alert alert-success "Tip" - You must set `pg_stat_statements.track = all` in your PostgreSQL Server settings to use PMM Query Analytics. [Read more](../connect-database/postgresql.md#configure-monitoring-extension. + You must set `pg_stat_statements.track = all` in your PostgreSQL Server settings to use PMM Query Analytics. [Read more](../connect-database/postgresql.md#configure-monitoring-extension). ![!](../../../images/PMM_Add_Instance_Azure_3.png) -In the list of databases on the Discovery page click **Start Monitoring** to add the selected Azure Database to PMM. +In the list of databases on the **Discovery** page click **Start Monitoring** to add the selected Azure Database to PMM. -Fill in all required fields and click **Add service**. +Fill in all required fields. To set how long PMM waits when connecting, enter a value in **Connection timeout**. Leave it empty to use the default of 2s. Click **Add service**. PMM can use 3 exporters to collect metrics: @@ -223,4 +222,4 @@ When using TLS certificates with Azure MySQL, make sure to: - store the downloaded `DigiCertGlobalRootCA.crt.pem` file on the server where PMM Client is installed - provide the full path to the certificate in the `--tls-ca` parameter -- use `--tls-skip-verify` only in development/testing environments to skip hostname validation \ No newline at end of file +- use `--tls-skip-verify` only in development/testing environments to skip hostname validation diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/mongodb.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/mongodb.md index 17df1eb764a..19d49f15f9f 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/mongodb.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/mongodb.md @@ -407,7 +407,7 @@ After configuring your database server, add a MongoDB service using either the u To add a service with the UI: {.power-number} - 1. Select **PMM Configuration > Add Service > MongoDB**. + 1. Select **Inventory > Add service > MongoDB**. 2. Fill in the required fields. @@ -454,7 +454,7 @@ After adding MongoDB service to PMM, verify that it's properly configured and co To check the service from the UI: {.power-number} - 1. Select **PMM Configuration > Inventory > Services**. + 1. Select **Inventory > Services**. 2. Find your MongoDB service in the list and verify it shows **Active** status. 3. Verify the **Service name**, **Addresses**, and other connection details are correct. 4. In the **Options** column, expand the **Details** section to check that agents are properly connected. @@ -486,7 +486,7 @@ If you need to remove MongoDB service from PMM, follow these steps: To remove the services through the PMM interface: {.power-number} - 1. Go to **PMM Configuration > Inventory > Services**. + 1. Go to **Inventory > Services**. 2. In the **Status** column, check the box for the service you want to remove and click **Delete**. 3. On the confirmation pop-up, click **Delete service** and select **Force mode** if you want to also delete associated Clients. diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql/mysql.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql/mysql.md index 9977adda041..511162d96be 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql/mysql.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql/mysql.md @@ -413,7 +413,7 @@ After creating your PMM database user, you can quickly add your MySQL service to To add the service from the user interface: {.power-number} - 1. Go to **PMM Configuration > PMM Inventory > Add Service**. + 1. Go to **Inventory > Add Service**. 2. Select **MySQL** service type. @@ -427,6 +427,7 @@ After creating your PMM database user, you can quickly add your MySQL service to - **Query Source**: Choose between **Slow Log** or **Performance Schema** - **PMM Agent**: Select which PMM agent should monitor this instance - **Disable query examples**: Check this option to prevent collection of actual query values in QAN. When enabled, PMM will continue to collect query metrics and statistics but will not store the actual query examples with real data values. + - **Connection timeout**: How long PMM should wait when connecting to this service. Increase this for remote or high-latency databases. If the connection times out, PMM retries the next time it collects metrics. Leave empty to use the default of 2s. 4. Click **Add Service**. @@ -612,7 +613,7 @@ After adding your MySQL service to PMM, it's important to verify that it's prope To verify your service in the web interface: {.power-number} - 1. Navigate to **PMM Configuration > PMM Inventory**. + 1. Navigate to **Inventory > Services**. 2. In the **Services** tab, find your newly added MySQL service. 3. Verify the **Service Name** and **Address** match your configuration. 4. Check the **Status** column shows as *Active*. diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/postgresql.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/postgresql.md index 048b562805a..bbfe66e89fa 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/postgresql.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/postgresql.md @@ -254,11 +254,11 @@ After configuring your database server with the appropriate extension, you need To add the service from the user interface: {.power-number} - 1. Go to **PMM Configuration > Add Service > PostgreSQL**. + 1. Go to **Inventory > Add service > PostgreSQL**. 2. Enter or select values for the fields. - 3. (Optional) If using `pgstatmonitor`, check **Disable query examples** under **Additional options** to prevent collection of actual query values. This protects sensitive data while preserving all query metrics and performance statistics in QAN. + 3. (Optional) Under **Additional options**, if using `pgstatmonitor`, check **Disable query examples** to prevent collection of actual query values. This protects sensitive data while preserving all query metrics and performance statistics in QAN. 4. Click **Add service**. ![!](../../../images/PMM_Add_Instance_PostgreSQL.png) diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/valkey-redis.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/valkey-redis.md index e3f40f3e0ec..1b70ebc628e 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/valkey-redis.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/valkey-redis.md @@ -46,7 +46,7 @@ You can add your Valkey or Redis service to PMM either through the user interfac To add the service from the user interface: {.power-number} - 1. Go to **PMM Configuration > PMM Inventory > Services > Add Service**. + 1. Go to **Inventory > Services > Add Service**. 2. Select **Valkey/Redis** service type. @@ -57,6 +57,7 @@ You can add your Valkey or Redis service to PMM either through the user interfac - **Agents**: Select the PMM agent that should monitor this instance. - **Hostname/Port**: The address and port (default: `6379`) of your instance. - **Username/Password**: Authentication credentials (if ACL is enabled). + - **Connection timeout**: How long PMM should wait when connecting to this service. Increase this for remote or high-latency databases. If the connection times out, PMM retries the next time it collects metrics. Leave empty to use the default of 3s. 4. Configure **Labels** (optional): Add descriptive tags. For clustered/replicated setups, ensure you set the `role` label here (e.g., `role:primary`). @@ -208,8 +209,7 @@ After adding your Valkey or Redis service to PMM, verify that it's properly conn To verify your service in the web interface: {.power-number} - 1. Navigate to **PMM Configuration > PMM Inventory**. - 2. In the **Services** tab, find your newly added Valkey/Redis service. + 1. Navigate to **Inventory > Services > Valkey** service. 3. Verify the **Service Name** and **Address** match your configuration. 4. Check the **Status** column shows as *Active*. 5. In the **Options** column, expand the **Details** section to confirm the correct agents are running. @@ -263,7 +263,7 @@ If you need to remove a Valkey or Redis service from monitoring: To remove the service from the user interface: {.power-number} - 1. Navigate to **PMM Configuration > PMM Inventory**. + 1. Navigate to **Inventory > Services**. 2. Find your Valkey/Redis service in the **Services** tab. 3. Click the **Remove** button in the **Options** column. 4. Confirm the removal when prompted. diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/env_var.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/env_var.md index ccf834ddfe4..94b46cff0ed 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/env_var.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/env_var.md @@ -35,7 +35,7 @@ Enable or disable specific PMM features: | `PMM_ENABLE_ALERTING` | `true` | Enables Percona Alerting system | | `PMM_ENABLE_BACKUP_MANAGEMENT` | `true` | Enables backup features | | `PMM_ENABLE_AZURE_DISCOVER` | `false` | Enables Azure database discovery | -| `PMM_ENABLE_INTERNAL_PG_QAN` | `0` (disabled) | Enables Query Analytics for PMM Server's internal PostgreSQL. Useful for troubleshooting or HA scenarios. Set to `1` to enable. Can also be controlled via **PMM Configuration > Settings > Advanced Settings**. See [QAN for PMM Server's internal PostgreSQL](../../../../use/qan/QAN-stored-metrics.md#monitor-pmm-servers-internal-postgresql) +| `PMM_ENABLE_INTERNAL_PG_QAN` | `0` (disabled) | Enables Query Analytics for PMM Server's internal PostgreSQL. Useful for troubleshooting or HA scenarios. Set to `1` to enable. Can also be controlled via **Configuration > Settings > Advanced settings**. See [QAN for PMM Server's internal PostgreSQL](../../../../use/qan/QAN-stored-metrics.md#monitor-pmm-servers-internal-postgresql) ### Debugging and troubleshooting Use these variables when diagnosing issues with PMM Server: diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/index.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/index.md index daa4395f004..44fc028314b 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/index.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/index.md @@ -134,7 +134,7 @@ After basic installation, you may want to customize your PMM Server setup: - Disable updates if needed: - **via Docker**: add `-e PMM_ENABLE_UPDATES=0` to the `docker run` command (for the life of the container) - - **via UI**: go to **PMM Configuration > Settings > Advanced Settings** and disable **Check for Updates** (can be turned back on by any admin in the UI) + - **via UI**: go to **Configuration > Settings > Advanced settings** and disable **Check for Updates** (can be turned back on by any admin in the UI) - Enable HTTP (insecure, NOT recommended): add `--publish 80:8080` to the `docker run` command. diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/run_with_vol.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/run_with_vol.md index 94134a864d6..d351c5ea8c6 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/run_with_vol.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/run_with_vol.md @@ -34,11 +34,19 @@ To deploy PMM Server using Docker volumes: percona/pmm-server:3 ``` -4. Set a secure password for the default `admin` user, replacing `your_secure_password` with a strong, unique password: +4. Set a secure password for the default `admin` user. You can do this either at startup using environment variables, or after startup using a helper script: - ```sh - docker exec -t pmm-server change-admin-password your_secure_password - ``` + - **At startup** (add to the `docker run` command in step 3): + + ```sh + --env GF_SECURITY_ADMIN_PASSWORD="your_secure_password" + ``` + + - **After startup:** + + ```sh + docker exec -t pmm-server change-admin-password your_secure_password + ``` 5. Access the PMM web interface at `https://localhost` in a web browser. If you are accessing the Docker host remotely, replace `localhost` with your server's IP address or hostname. diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/ssh.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/ssh.md index 765a495e7f5..be447f56c89 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/ssh.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/ssh.md @@ -1,6 +1,6 @@ # SSH Key -When you run PMM Server as a virtual machine (AMI or OVF), you can upload your public SSH key to access the server via SSH and manage or troubleshoot it directly. +When you run PMM Server as a virtual machine (AMI or OVF), you can upload your public SSH key to enable SSH access for direct management and troubleshooting. ![PMM Settings SSH Key](../../../../images/PMM_Settings_SSH_Key.jpg) @@ -9,33 +9,20 @@ When you run PMM Server as a virtual machine (AMI or OVF), you can upload your p To configure SSH access: {.power-number} -1. Enter your **public key** in the **SSH Key** field. -2. Click **Apply SSH key**. +1. Go to **Configuration > Settings > SSH key**. +2. Enter your public key in the **SSH Key** field. +3. Click **Apply SSH key**. -This adds the key to the virtual machine so you can connect to your PMM Server instance via SSH. - -For more information on virtual machine deployments, see [virtual appliance](../virtual/index.md) index.md. +For more information on virtual machine deployments, see [Virtual appliance](../virtual/index.md). ## Connect via SSH -Once your public key is configured, you can connect to your PMM Server using SSH: - -### Using SSH with a private key - -Connect to your PMM Server using the `admin` user and your private key: +Once your public key is configured, connect using the `admin` user: ```bash ssh -i your-private-key admin@ ``` -where: - -- `your-private-key` is the path to your private key file (can be `.pem`, `.key`, or no extension) -- `` is your PMM Server's IP address or hostname -- The username is always `admin` for PMM virtual machine deployments - -### Examples - === "AWS EC2 instance" ```bash ssh -i ~/keys/my-aws-key.pem admin@ec2-203-0-113-42.compute-1.amazonaws.com @@ -46,7 +33,7 @@ where: ssh -i ~/.ssh/pmm_key admin@192.168.1.100 ``` -=== "Using default SSH key" +=== "Default key location" If your private key is in the default location (`~/.ssh/id_rsa` or `~/.ssh/id_ed25519`), you can omit the `-i` flag: ```bash ssh admin@ diff --git a/documentation/docs/pmm-upgrade/ui_upgrade.md b/documentation/docs/pmm-upgrade/ui_upgrade.md index fa038137ff3..3da96971db1 100644 --- a/documentation/docs/pmm-upgrade/ui_upgrade.md +++ b/documentation/docs/pmm-upgrade/ui_upgrade.md @@ -1,13 +1,9 @@ -# Upgrade PMM v3 Server from the UI +# Upgrade PMM Server from the UI !!! warning "GUI-based upgrades ending in PMM 3.9.0" - GUI-based upgrades are deprecated starting with PMM 3.7.0. This upgrade method will be formally deprecated in PMM 3.8 (end of May 2026) and removed in PMM 3.9 (end of July 2026). + GUI-based upgrades are deprecated and will be removed in PMM 3.9.0 (end of July 2026). - The underlying Watchtower project used for GUI upgrades is no longer maintained. Switch to one of the supported upgrade methods: - - - [Upgrade PMM Server using Docker](upgrade_docker.md) - - [Upgrade PMM Server using Podman](upgrade_podman.md) - - [Upgrade PMM Server using Helm](upgrade_helm.md) + To continue upgrading PMM after version 3.9.0, use [Docker](upgrade_docker.md) (recommended), [Podman](upgrade_podman.md), or [Helm](upgrade_helm.md). PMM Server and Client components are installed and updated separately. @@ -38,4 +34,4 @@ For a quick overview of your PMM v3 Server's update status, you can also check t ![PMM Home Dashboard Upgrade Panel](../images/PMM_Home_Dashboard_Panels_Upgrade.png) !!! note - The Upgrade panel on the Home dashboard will be removed when GUI upgrades are removed in PMM 3.9.0. After that, use `docker pull` or your container runtime's equivalent to check for updates. \ No newline at end of file + The **Upgrade** panel on the Home dashboard will be removed when GUI upgrades are removed in PMM 3.9.0. After that, use `docker pull` or your container runtime's equivalent to check for updates. \ No newline at end of file diff --git a/documentation/docs/pmm-upgrade/upgrade_docker.md b/documentation/docs/pmm-upgrade/upgrade_docker.md index b87ad84d3a7..35418a8bb27 100644 --- a/documentation/docs/pmm-upgrade/upgrade_docker.md +++ b/documentation/docs/pmm-upgrade/upgrade_docker.md @@ -5,9 +5,11 @@ Before starting the upgrade, complete these preparation steps to ensure you can recover your system if needed and confirm compatibility with the new version: {.power-number} -1. [Create a backup](../install-pmm/install-pmm-server/deployment-options/docker/backup_container.md) before upgrading, as downgrades are not possible. Therefore, reverting to a previous version requires an backup made prior to the upgrade. +1. If you are switching from [UI-based upgrades](ui_upgrade.md), stop and remove the Watchtower container before moving to manual Docker upgrades. UI-based upgrades used Watchtower to apply PMM images automatically. If Watchtower is still running, it may update PMM during your manual upgrade and cause conflicts. -2. Verify your current PMM version: Check your current PMM version by navigating to **Configuration > Updates** or by running the following command: +2. [Create a backup](../install-pmm/install-pmm-server/deployment-options/docker/backup_container.md) before upgrading, as downgrades are not possible. Therefore, reverting to a previous version requires an backup made prior to the upgrade. + +3. Verify your current PMM version: Check your current PMM version by navigating to **Configuration > Updates** or by running the following command: ```sh docker exec -it pmm-server curl -ku admin:admin https://localhost:8443/v1/version diff --git a/documentation/docs/pmm-upgrade/upgrade_podman.md b/documentation/docs/pmm-upgrade/upgrade_podman.md index 90c0b71b540..59ee0c9a9d1 100644 --- a/documentation/docs/pmm-upgrade/upgrade_podman.md +++ b/documentation/docs/pmm-upgrade/upgrade_podman.md @@ -5,9 +5,11 @@ Before starting the upgrade, complete these preparation steps to ensure you can recover your system if needed and confirm compatibility with the new version: {.power-number} -1. [Create a backup](../install-pmm/install-pmm-server/deployment-options/podman/backup_container_podman.md) before upgrading, as downgrades are not possible. Therefore, reverting to a previous version requires an backup made prior to the upgrade. +1. If you are switching from [UI-based upgrades](ui_upgrade.md), stop and remove the Watchtower container before moving to manual Podman upgrades. UI-based upgrades used Watchtower to apply PMM images automatically. If Watchtower is still running, it may update PMM during your manual upgrade and cause conflicts. -2. Verify your current PMM version: Check your current PMM version by navigating to **PMM Configuration > Updates** or by running the following command: +2. [Create a backup](../install-pmm/install-pmm-server/deployment-options/podman/backup_container_podman.md) before upgrading, as downgrades are not possible. Therefore, reverting to a previous version requires an backup made prior to the upgrade. + +3. Verify your current PMM version: Check your current PMM version by navigating to **PMM Configuration > Updates** or by running the following command: ```sh podman exec -it pmm-server \ diff --git a/documentation/docs/reference/dashboards/dashboard-postgresql-instance-summary.md b/documentation/docs/reference/dashboards/dashboard-postgresql-instance-summary.md index 6f093f886ce..51467f61ffc 100644 --- a/documentation/docs/reference/dashboards/dashboard-postgresql-instance-summary.md +++ b/documentation/docs/reference/dashboards/dashboard-postgresql-instance-summary.md @@ -6,7 +6,7 @@ This is essential for database administrators who need to troubleshoot specific Start here when you need to focus on one specific PostgreSQL instance, investigate slow queries, check connection usage, or analyze database-specific performance trends. -![!image](../../images/PMM_PostgreSQL_Instance_Summary.jpg) +![PMM_PostgreSQL_Instance_Summary](../../images/PMM_PostgreSQL_Instance_Summary.png) ## Service Shows essential information about your PostgreSQL instance including service name, version, uptime in days, and the server hostname. The server name is clickable to navigate to detailed node monitoring. This gives you quick access to basic instance identification and health information. diff --git a/documentation/docs/reference/faq.md b/documentation/docs/reference/faq.md index 4cd05eed84f..bded98e0119 100644 --- a/documentation/docs/reference/faq.md +++ b/documentation/docs/reference/faq.md @@ -42,7 +42,7 @@ If you encounter errors such as `ERROR: Unsupported distribution` when running t ## Retention -To control data retention, go to **PMM Configuration > Settings > Advanced Settings > Data retention** to adjust the value in days. +To control data retention, go to **Configuration > Settings > Advanced settings > Data retention** to adjust the value in days. !!! seealso alert alert-info "See also" [Configure data retention](../configure-pmm/advanced_settings.md#data-retention) @@ -147,12 +147,16 @@ PMM protects an exporter's output from unauthorized access by adding an authoriz ## How to provision PMM Server with non-default admin password? -Currently, there is no API available to change the `admin` password at deployment time. However, you can use the `GF_SECURITY_ADMIN_PASSWORD` environment variable to set the password for the default `admin` user. +You can set the password for the default `admin` user on first startup with the `GF_SECURITY_ADMIN_PASSWORD` environment variable, and optionally set a custom admin username with `GF_SECURITY_ADMIN_USER`. + +These variables are applied only during initial PMM data initialization. They are ignored on subsequent starts and container restarts. ```sh docker run -d --name pmm-server \ + -e GF_SECURITY_ADMIN_USER="your_username" \ -e GF_SECURITY_ADMIN_PASSWORD="your_secure_password" \ -p 443:8443 \ + --volume pmm-data:/srv \ percona/pmm-server:latest ``` diff --git a/documentation/docs/reference/nomad.md b/documentation/docs/reference/nomad.md index cc60997f9c6..ce0168a1e75 100644 --- a/documentation/docs/reference/nomad.md +++ b/documentation/docs/reference/nomad.md @@ -12,7 +12,7 @@ Nomad is **disabled by default** in PMM and has no impact on system performance ## Prerequisites -Before enabling Nomad, check that PMM Server has a public address configured under **PMM Configuration > Advanced Settings**. This is required for Nomad to function properly and enable communication between Nomad components. +Before enabling Nomad, check that PMM Server has a public address configured under **Configuration > Settings > Advanced settings**. This is required for Nomad to function properly and enable communication between Nomad components. ### Enable Nomad diff --git a/documentation/docs/reference/ui/timezone.md b/documentation/docs/reference/ui/timezone.md index 229f2a1a400..13693aa17b8 100644 --- a/documentation/docs/reference/ui/timezone.md +++ b/documentation/docs/reference/ui/timezone.md @@ -1,10 +1,18 @@ -# Set timezones +# Set time zone -By default Grafana uses the timezone from your web browser. However, you can change this setting. +By default, PMM uses the time zone from your web browser. You can change this in your profile preferences, and all dashboards will use your chosen time zone. -To set the timezone: +To set the time zone: {.power-number} 1. On the main menu, go to **Account > Profile > Preferences**. -2. Click to select an option in the **Timezone**. +2. Select a time zone from the **Timezone** dropdown. 3. Click **Save**. + +## Override time zone for a specific dashboard + +You can also change the time zone directly from a dashboard using the time range picker in the top right. This overrides your profile preference for that dashboard only. + +![Time range picker showing timezone selector](../../images/PMM_timezone_picker.png) + +This change does not update your profile preference and does not affect other dashboards. diff --git a/documentation/docs/release-notes/3.5.0.md b/documentation/docs/release-notes/3.5.0.md index d5b1167673d..3ec47449237 100644 --- a/documentation/docs/release-notes/3.5.0.md +++ b/documentation/docs/release-notes/3.5.0.md @@ -175,6 +175,7 @@ We assess this risk as low, as PMM is usually deployed in controlled environment - [PMM-14348](https://perconadev.atlassian.net/browse/PMM-14348): Added **Enable QAN for PMM Server** toggle in **PMM Configuration > Settings > Advanced Settings** to easily enable or disable Query Analytics for PMM Server's internal PostgreSQL database. Previously, this required API calls. The setting can also be controlled via the `PMM_ENABLE_INTERNAL_PG_QAN` environment variable. - [PMM-14118](https://perconadev.atlassian.net/browse/PMM-14118) PMM now automatically generates SSL certificates for ClickHouse database connections to improve security and eliminate certificate error messages in ClickHouse logs. +**Update (PMM 3.8.0):** These certificates were removed with [PMM-15005](https://perconadev.atlassian.net/browse/PMM-15005). - [PMM-10461](https://perconadev.atlassian.net/browse/PMM-10461): Improved compatibility with proxy servers. All Nginx redirects now use relative paths instead of a mix of absolute and relative redirects. This prevents issues with external proxies and aligns behavior with Grafana. diff --git a/documentation/docs/release-notes/3.8.0.md b/documentation/docs/release-notes/3.8.0.md new file mode 100644 index 00000000000..de4f4d3130d --- /dev/null +++ b/documentation/docs/release-notes/3.8.0.md @@ -0,0 +1,71 @@ +# Percona Monitoring and Management 3.8.0 + +**Release date**: TBD + +Percona Monitoring and Management (PMM) is an open source database monitoring, management, and observability solution for MySQL, PostgreSQL, MongoDB, Valkey and Redis. PMM empowers you to: + +- monitor the health and performance of your database systems +- identify patterns and trends in database behavior +- diagnose and resolve issues faster with actionable insights +- manage databases across on-premises, cloud, and hybrid environments + +## πŸ“‹ Release summary + +TODO + +## ✨ Release highlights + +### Grafana 12.4 upgrade + +PMM 3.8.0 ships with [Grafana 12.4](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v12-0/), so you will notice several day-to-day monitoring improvements right away: + +**Faster monitoring dashboards**: Tables in PMM dashboards load, sort, and filter significantly faster. This affects dashboards across PMM including **Nodes Overview**, **MySQL User Details**, **PostgreSQL Instances Overview**, MongoDB, and HA/PXC **Cluster Summary**. + +**Less alert noise**: Alert rules now support a [**Recovering** state](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v12-0/#recovering-state-for-alert-rules). This helps avoid repeated fire/resolved notifications when a metric keeps moving above and below an alert threshold, so you get fewer noisy alerts for spiky metrics like replication lag, query response time, and connection counts. + +**Custom dashboard compatibility**: All PMM-provided dashboards are unaffected by Grafana 12's Angular removal. If you have custom dashboards using legacy **Graph (old)** or **Table (old)** panels, Grafana will auto-migrate them on first load. + +**Recording rules**: Alert rules now support [**recording rules**](https://grafana.com/docs/grafana/latest/alerting/alerting-rules/create-recording-rules/), which pre-calculate frequently used or expensive queries and store the results as new metrics. This can simplify complex alert conditions and improve query performance at scale. + +## πŸ“¦ Components upgrade + +- **Grafana**: Upgraded to 12.4. + +## πŸ”’ Security updates + +- [PMM-15005](https://perconadev.atlassian.net/browse/PMM-15005): Removed a self-signed TLS certificate that was previously included in the PMM Server image to suppress ClickHouse startup log noise. Because the same certificate was shared across all PMM Server installations, CVE scanners flagged it as a security risk. Since ClickHouse in PMM doesn't use TLS, the startup log noise is now suppressed without needing a certificate at all. + +## ⚠️ Deprecations + +- [PMM-14968](https://perconadev.atlassian.net/browse/PMM-14968): UI-based upgrades are now officially deprecated and will be removed in PMM 3.9.0 (July 2026). PMM now shows a warning on all pages where UI-based upgrades were available. Switch to [Docker](../pmm-upgrade/upgrade_docker.md), [Podman](../pmm-upgrade/upgrade_podman.md), or [Helm](../pmm-upgrade/upgrade_helm.md) before then. If you use Watchtower, remove it before switching to avoid conflicts. + +## πŸ“ˆ Improvements + +- [PMM-12392](https://perconadev.atlassian.net/browse/PMM-12392): Improved how PMM collects processlist data on MySQL 5.7.39+ and 8.0.22+ by switching from Information Schema to Performance Schema. On busy MySQL instances, this reduces the chance of query blocking and deadlocks, lowering the overall monitoring impact on your MySQL server workload. + +- [PMM-14937](https://perconadev.atlassian.net/browse/PMM-14937): When adding a MySQL, PostgreSQL, MongoDB, ProxySQL, Valkey, Amazon RDS, or Azure service, you can now set a **Connection timeout** to control how long PMM waits before giving up on a connection attempt. This is useful when monitoring remote or high-latency databases where the default timeout is too short. + +- [PMM-14068](https://perconadev.atlassian.net/browse/PMM-14068): The [PostgreSQL Instance Summary](../reference/dashboards/dashboard-postgresql-instance-summary.md) dashboard is now easier to read: summary panels use a consistent color scheme to help you spot issues faster, the layout fits laptop screens without cutting off panels, and tables no longer require horizontal scrolling to see all data. + +- [PMM-14930](https://perconadev.atlassian.net/browse/PMM-14930): Building on the [native PMM navigation introduced in 3.6.0](3.6.0.md), the **Settings** page now also runs in native PMM UI. You get the same settings with **Metrics resolution**, **Advanced settings**, and **SSH key** tabs in a page that loads faster and looks consistent with the rest of the new interface. Access it at **Configuration > Settings** in the left sidebar. + + ![PMM Settings in native UI](../images/PMM_Settings_native_ui.png) + +- [PMM-14995](https://perconadev.atlassian.net/browse/PMM-14995): PMM has been updated with Percona's refreshed brand. You'll notice the updated logo across the sidebar, login screen, and help center, along with new technology icons for MySQL, PostgreSQL, MongoDB, and Valkey, and a refreshed color palette throughout the interface. + +## βœ… Fixed issues + +- [PMM-14748](https://perconadev.atlassian.net/browse/PMM-14748): Fixed dashboards resetting the time zone to the browser default when navigating between pages. All dashboards now respect the time zone set in your profile preferences. See [Set time zone](../reference/ui/timezone.md). + +- [PMM-14791](https://perconadev.atlassian.net/browse/PMM-14791): Resolved an issue in the **Disk Space** graphs on the **Disk Details** dashboard where values were hard to read, legend labels were missing, and charts were displayed incorrectly. + +- [PMM-14512](https://perconadev.atlassian.net/browse/PMM-14512): Fixed the **BP Data Dirty** panel on the **MySQL InnoDB Details** dashboard showing no data after upgrading from PMM 2. The panel now correctly displays the ratio of dirty to data pages in the InnoDB buffer pool. + +- [PMM-14851](https://perconadev.atlassian.net/browse/PMM-14851): Fixed a bug in the PMM Helm chart that could cause `ClusterRole` to fail when deploying PMM on Kubernetes. The chart now deploys without RBAC errors. +- [PMM-14934](https://perconadev.atlassian.net/browse/PMM-14934): Fixed an issue where the `GF_SECURITY_ADMIN_USER` and `GF_SECURITY_ADMIN_PASSWORD` environment variables were ignored when starting PMM Server with a named Docker volume (`-v pmm-data:/srv`). You can now use these variables to set the admin username and password at first start, regardless of how the data volume is mounted. As part of this fix, **the first start after upgrading takes about 20–30 seconds longer** than usual while PMM initializes. Subsequent starts are unaffected. PMM HA deployments are unimpacted. + +## πŸš€ Ready to upgrade to PMM 3.8.0? + +- [New installation](../quickstart/quickstart.md) +- [Upgrading from PMM 3](../pmm-upgrade/index.md) +- [Upgrading from PMM 2](../pmm-upgrade/migrating_from_pmm_2.md) diff --git a/documentation/docs/release-notes/index.md b/documentation/docs/release-notes/index.md index c3537df56ef..d111f9c5179 100644 --- a/documentation/docs/release-notes/index.md +++ b/documentation/docs/release-notes/index.md @@ -1,4 +1,5 @@ # Release notes +- [Percona Monitoring and Management 3.8.0](3.8.0.md) - [Percona Monitoring and Management 3.7.1](3.7.1.md) - [Percona Monitoring and Management 3.7.0](3.7.0.md) - [Percona Monitoring and Management 3.6.0](3.6.0.md) diff --git a/documentation/docs/use/commands/pmm-admin/add.md b/documentation/docs/use/commands/pmm-admin/add.md index 9b566c4d55f..10e05153df5 100644 --- a/documentation/docs/use/commands/pmm-admin/add.md +++ b/documentation/docs/use/commands/pmm-admin/add.md @@ -27,6 +27,7 @@ Control connection settings, TLS, query collection, metric collectors, and servi | `--socket`
(Unix socket path) | βœ“ | | | | | | | `--database`
(database name) | | βœ“ | | | | | | `--extra-dsn`
(additional DSN parameters) | βœ“ | | | | | | +| `--connection-timeout`
(connection timeout, e.g. `2s`, `5s`) | βœ“ | βœ“ | βœ“ | βœ“ | βœ“ | | | `--listen-port`
(metrics listen port) | | | | | | βœ“ | | `--scheme`
(http/https) | | | | | | βœ“ | | `--metrics-path`
(metrics endpoint path) | | | | | | βœ“ | @@ -106,6 +107,7 @@ Connect to MySQL using TCP or socket: | `--username` | MySQL username | | | `--password` | MySQL password | | | `--extra-dsn` | Additional DSN parameters | | +| `--connection-timeout` | How long PMM waits before giving up on a connection attempt (e.g. `2s`, `5s`). Useful for remote or high-latency databases. | `2s` | Find the socket path: @@ -240,6 +242,8 @@ pmm-admin add postgresql [NAME] [ADDRESS] [FLAGS] Connect using `--host`, `--port`, `--username`, and `--password`. The `--database` flag specifies which database to connect to (defaults to `postgres`). +Use `--connection-timeout` to set how long PMM waits before giving up on a connection attempt (e.g. `2s`, `5s`). The default is `2s`. Increase this for remote or high-latency databases. + ### TLS options Secure the connection between PMM and your PostgreSQL instance with TLS: @@ -322,6 +326,8 @@ pmm-admin add mongodb [NAME] [ADDRESS] [FLAGS] Connect using `--host`, `--port`, `--username`, and `--password`. +Use `--connection-timeout` to set how long PMM waits before giving up on a connection attempt (e.g. `2s`, `5s`). The default is `2s`. Increase this for remote or high-latency databases. + ### TLS options Secure the connection between PMM and your MongoDB instance with TLS: @@ -473,6 +479,8 @@ pmm-admin add valkey [NAME] [ADDRESS] [FLAGS] Connect using `--host`, `--port`, `--username`, and `--password`. Use `--tls` and `--tls-skip-verify` to secure the connection with TLS. +Use `--connection-timeout` to set how long PMM waits before giving up on a connection attempt (e.g. `2s`, `5s`). The default is `3s`. Increase this for remote or high-latency instances. + ### Examples - Add Valkey: @@ -518,6 +526,8 @@ pmm-admin add proxysql [NAME] [ADDRESS] [FLAGS] Connect using `--host`, `--port`, `--username`, and `--password` for the ProxySQL admin interface. Use `--tls` and `--tls-skip-verify` to secure the connection. +Use `--connection-timeout` to set how long PMM waits before giving up on a connection attempt (e.g. `2s`, `5s`). The default is `2s`. Increase this for remote or high-latency instances. + Use `--disable-collectors` with a comma-separated list to exclude specific collectors from monitoring. ### Examples diff --git a/documentation/docs/use/qan/QAN-stored-metrics.md b/documentation/docs/use/qan/QAN-stored-metrics.md index bd249270dfb..eb82d3c7ef4 100644 --- a/documentation/docs/use/qan/QAN-stored-metrics.md +++ b/documentation/docs/use/qan/QAN-stored-metrics.md @@ -57,7 +57,7 @@ Enable this when you need to troubleshoot PMM Server performance, check resource To enable: {.power-number} -1. Go to **PMM Configuration > Settings > Advanced Settings**. +1. Go to **Configuration > Settings > Advanced settings**. 2. Switch on the **QAN for PMM Server** option. 3. Open **Query Analytics** and filter by `pmm-server-postgresql` to view queries. diff --git a/documentation/mkdocs-pdf.yml b/documentation/mkdocs-pdf.yml index 0483c356a76..e01f87a9db1 100644 --- a/documentation/mkdocs-pdf.yml +++ b/documentation/mkdocs-pdf.yml @@ -7,9 +7,9 @@ plugins: version_selector: false # https://github.com/orzih/mkdocs-with-pdf with-pdf: - output_path: "pdf/PerconaMonitoringAndManagement-3.7.1.pdf" + output_path: "pdf/PerconaMonitoringAndManagement-3.8.0.pdf" cover_title: "Percona Monitoring and Management Documentation" - cover_subtitle: 3.7.1 (April 30, 2026) + cover_subtitle: 3.8.0 (April 30, 2026) author: "Percona Technical Documentation Team" cover_logo: docs/images/Percona_Logo_Color.png custom_template_path: resources/templates diff --git a/documentation/variables.yml b/documentation/variables.yml index df7a9285921..3898928b23a 100644 --- a/documentation/variables.yml +++ b/documentation/variables.yml @@ -1,6 +1,6 @@ # PMM Version for HTML # See also mkdocs.yml plugins.with-pdf.cover_subtitle and output_path -release: '3.7.0' -version: '3.7.0' -release_date: 2026-04-01 +release: '3.8.0' +version: '3.8.0' +release_date: 2026-05-30