Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion documentation/docs/advisors/advisors.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/advisors/develop-advisor-checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
15 changes: 8 additions & 7 deletions documentation/docs/alert/alert_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/alert/disable_alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 2 additions & 2 deletions documentation/docs/alert/silence_alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions documentation/docs/configure-pmm/advanced_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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).

Expand All @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/configure-pmm/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Binary file modified documentation/docs/images/PMM_Add_Instance_AWS_RDS.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/docs/images/PMM_Add_Instance_Azure_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/docs/images/PMM_Add_Instance_MongoDB.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/docs/images/PMM_Add_Instance_PostgreSQL.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/docs/images/PMM_Home_Dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/docs/images/PMM_Settings_Advanced_Settings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/docs/images/PMM_Settings_Metrics_Resolution.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/docs/images/PMM_Settings_SSH_Key.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/docs/images/Update_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/docs/images/alerting-sample-query.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/docs/images/azure-add-mysql-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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:

Expand Down Expand Up @@ -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)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 <i class="uil uil-toggle-off"></i> toggle in the **Technical preview features** section of the page.

Expand Down Expand Up @@ -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)


Expand All @@ -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)

Expand All @@ -140,13 +139,13 @@ You can find more details on how to create DB on Azure at:
- <https://docs.microsoft.com/en-us/azure/mysql/>

!!! 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:

Expand Down Expand Up @@ -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
- use `--tls-skip-verify` only in development/testing environments to skip hostname validation
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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**.

Expand Down Expand Up @@ -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*.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading
Loading