From fb5802c3499790f9e7c3f0099152cfec9fd95e2d Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 14 Oct 2025 16:27:35 +0000 Subject: [PATCH 1/2] Initial plan From 5f7c99aaa822e5cd042446cafdf71aef0dbefe43 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 14 Oct 2025 16:40:20 +0000 Subject: [PATCH 2/2] Add external link icons and target=_blank to all external links in documentation Co-authored-by: catalinaadam <94133018+catalinaadam@users.noreply.github.com> --- .../docs/admin/manage-users/edit_users.md | 2 +- .../roles/access-control/create_roles.md | 2 +- .../docs/admin/roles/access-control/labels.md | 4 +- documentation/docs/admin/roles/index.md | 2 +- .../docs/admin/security/ssl_encryption.md | 2 +- .../docs/advisors/advisor-details.md | 2 +- documentation/docs/advisors/advisors.md | 2 +- .../docs/advisors/develop-advisor-checks.md | 24 +++--- documentation/docs/alert/alert_rules.md | 6 +- documentation/docs/alert/silence_alerts.md | 6 +- documentation/docs/api/index.md | 4 +- documentation/docs/backup/index.md | 18 ++--- .../backup/mongodb-backup/backup_mongo.md | 2 +- .../mongodb-backup/create_PITR_mongo.md | 4 +- .../mongodb-backup/mongo_prerequisites.md | 2 +- .../mongodb-backup/mongodb_limitations.md | 4 +- .../mongodb-backup/restore_MongoDB_backups.md | 14 ++-- .../mysql-backup/mysql_prerequisites.md | 6 +- .../docs/backup/prepare_storage_location.md | 8 +- .../docs/configure-pmm/advanced_settings.md | 6 +- .../check_percona_platform.md | 4 +- .../integrate_with_percona_platform.md | 6 +- documentation/docs/get-help.md | 4 +- documentation/docs/index.md | 4 +- documentation/docs/install-pmm/HA.md | 2 +- .../connect-database/aws.md | 4 +- .../connect-database/azure.md | 2 +- .../connect-database/external.md | 8 +- .../connect-database/haproxy.md | 2 +- .../connect-database/mysql/mysql.md | 2 +- .../connect-database/postgresql.md | 2 +- .../connect-database/proxysql.md | 2 +- .../install-pmm/install-pmm-client/docker.md | 4 +- .../install-pmm-client/package_manager.md | 2 +- .../install-pmm-client/prerequisites.md | 2 +- .../deployment-options/aws/configure_aws.md | 6 +- .../deployment-options/aws/deploy_aws.md | 12 +-- .../deployment-options/aws/plan_aws.md | 6 +- .../deployment-options/docker/easy-install.md | 4 +- .../deployment-options/docker/env_var.md | 2 +- .../deployment-options/docker/index.md | 10 +-- .../helm/backup_container_helm.md | 10 +-- .../deployment-options/helm/index.md | 16 ++-- .../deployment-options/podman/index.md | 10 +-- .../virtual/download_ova.md | 2 +- .../deployment-options/virtual/vmware.md | 2 +- .../hardware_and_system.md | 4 +- .../network_and_firewall.md | 2 +- .../external_postgres_pmm_upgrade.md | 2 +- .../docs/pmm-upgrade/upgrade_client.md | 4 +- documentation/docs/quickstart/quickstart.md | 26 +++---- documentation/docs/reference/copyright.md | 2 +- .../dashboard-mysql-innodb-details.md | 2 +- .../dashboard-mysql-instance-summary.md | 4 +- ...board-mysql-query-response-time-details.md | 4 +- .../dashboard-mysql-table-details.md | 2 +- .../dashboards/dashboard-node-summary.md | 2 +- ...dashboard-prometheus-exporters-overview.md | 2 +- .../dashboards/kubernetes_cluster_summary.md | 4 +- .../kubernetes_monitor_operators.md | 2 +- documentation/docs/reference/faq.md | 18 ++--- documentation/docs/reference/glossary.md | 2 +- documentation/docs/reference/index.md | 6 +- documentation/docs/reference/nomad.md | 4 +- .../docs/reference/personal_data_handling.md | 4 +- .../reference/pmm_components_and_versions.md | 24 +++--- .../docs/reference/third-party/clickhouse.md | 4 +- .../docs/reference/third-party/postgresql.md | 18 ++--- .../docs/reference/third-party/victoria.md | 14 ++-- .../docs/reference/trademark-policy.md | 2 +- .../docs/reference/ui/ui_components.md | 4 +- documentation/docs/release-notes/3.0.0.md | 36 ++++----- documentation/docs/release-notes/3.0.0_1.md | 12 +-- documentation/docs/release-notes/3.1.0.md | 38 +++++----- documentation/docs/release-notes/3.2.0.md | 74 +++++++++---------- documentation/docs/release-notes/3.3.0.md | 28 +++---- documentation/docs/release-notes/3.3.1.md | 8 +- documentation/docs/release-notes/3.4.0.md | 40 +++++----- documentation/docs/release-notes/3.4.1.md | 6 +- documentation/docs/troubleshoot/checklist.md | 2 +- .../docs/troubleshoot/config_issues.md | 4 +- documentation/docs/troubleshoot/pmm_dump.md | 4 +- documentation/docs/use/commands/pmm-admin.md | 10 +-- .../docs/use/metrics/extend_metrics.md | 2 +- documentation/docs/use/qan/panels/details.md | 2 +- documentation/docs/use/remove-services.md | 2 +- 86 files changed, 340 insertions(+), 340 deletions(-) diff --git a/documentation/docs/admin/manage-users/edit_users.md b/documentation/docs/admin/manage-users/edit_users.md index 4fd963235bd..80eac074c65 100644 --- a/documentation/docs/admin/manage-users/edit_users.md +++ b/documentation/docs/admin/manage-users/edit_users.md @@ -45,4 +45,4 @@ The following are the privileges for the various *roles*: - **Viewer** - Viewing dashboards -For detailed information on the privileges for these roles and the different tasks that they can perform, see [Grafana organization roles](https://grafana.com/docs/grafana/latest/permissions/organization_roles/). \ No newline at end of file +For detailed information on the privileges for these roles and the different tasks that they can perform, see [Grafana organization roles :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/permissions/organization_roles/){:target="_blank"}. \ No newline at end of file diff --git a/documentation/docs/admin/roles/access-control/create_roles.md b/documentation/docs/admin/roles/access-control/create_roles.md index 928a2934cf4..c3c378bc07e 100644 --- a/documentation/docs/admin/roles/access-control/create_roles.md +++ b/documentation/docs/admin/roles/access-control/create_roles.md @@ -27,7 +27,7 @@ To create access roles in PMM: If you want to add more than one label for a role, click *+* and select the values from the drop-down. - For information on how the Prometheus selectors work, see [Prometheus selectors](https://prometheus.io/docs/prometheus/latest/querying/basics/#time-series-selectors). + For information on how the Prometheus selectors work, see [Prometheus selectors :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/basics/#time-series-selectors){:target="_blank"}. 6. Review your selections, then click **Create** to finalize the role. diff --git a/documentation/docs/admin/roles/access-control/labels.md b/documentation/docs/admin/roles/access-control/labels.md index f49b46692de..f372d23a838 100644 --- a/documentation/docs/admin/roles/access-control/labels.md +++ b/documentation/docs/admin/roles/access-control/labels.md @@ -63,6 +63,6 @@ PMM allows modifying certain standard labels after a service is created: For other standard labels that cannot be modified directly, you must remove the service and re-add it with the desired labels. -This can be done either via PMM UI or via an [API endpoint](https://percona-pmm.readme.io/reference/changeservice). +This can be done either via PMM UI or via an [API endpoint :octicons-link-external-16:](https://percona-pmm.readme.io/reference/changeservice){:target="_blank"}. -Modifying the custom labels can be done as well via PMM UI of via the same [API endpoint](https://percona-pmm.readme.io/reference/changeservice). +Modifying the custom labels can be done as well via PMM UI of via the same [API endpoint :octicons-link-external-16:](https://percona-pmm.readme.io/reference/changeservice){:target="_blank"}. diff --git a/documentation/docs/admin/roles/index.md b/documentation/docs/admin/roles/index.md index 5ee79073ca6..984bf08e1e0 100644 --- a/documentation/docs/admin/roles/index.md +++ b/documentation/docs/admin/roles/index.md @@ -8,7 +8,7 @@ For more granular data access control, see [Labels for access control](../roles/ ## Role types in PMM -PMM inherits its basic role structure from [Grafana](https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/) but with customizations specific to database monitoring. PMM has three main role types: +PMM inherits its basic role structure from [Grafana :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/){:target="_blank"} but with customizations specific to database monitoring. PMM has three main role types: - **Admin**: Has access to all resources and features within a PMM instance. This role can manage all aspects of PMM including users, teams, data sources, dashboards, and server settings. - **Editor**: Can view and edit dashboards, create custom visualizations, work with alerts, and manage specific configurations. Editors cannot modify server-wide settings or manage users. diff --git a/documentation/docs/admin/security/ssl_encryption.md b/documentation/docs/admin/security/ssl_encryption.md index 994435f0a87..71706353c3f 100644 --- a/documentation/docs/admin/security/ssl_encryption.md +++ b/documentation/docs/admin/security/ssl_encryption.md @@ -18,7 +18,7 @@ Configure both the Server and Client to implement SSL/TLS encryption in your PMM - [Copy certificates](#copy-certificates) directly into the PMM Server container 2. **Restart PMM Server** to apply the new certificates 3. **Configure client trust**: Ensure PMM Clients can verify the server certificate: - - Add the CA certificate to the system trust store ([Ubuntu guide](https://ubuntu.com/server/docs/install-a-root-ca-certificate-in-the-trust-store) | [Red Hat guide](https://www.redhat.com/sysadmin/configure-ca-trust-list)) + - Add the CA certificate to the system trust store ([Ubuntu guide :octicons-link-external-16:](https://ubuntu.com/server/docs/install-a-root-ca-certificate-in-the-trust-store){:target="_blank"} | [Red Hat guide :octicons-link-external-16:](https://www.redhat.com/sysadmin/configure-ca-trust-list){:target="_blank"}) - **Or use the `SSL_CERT_FILE` environment variable** for [custom CA certificates](#use-custom-ca-certificates-with-pmm-client) ### Certificate storage location diff --git a/documentation/docs/advisors/advisor-details.md b/documentation/docs/advisors/advisor-details.md index 50aa739ec38..2e0bb7bb967 100644 --- a/documentation/docs/advisors/advisor-details.md +++ b/documentation/docs/advisors/advisor-details.md @@ -6,7 +6,7 @@ Each Advisor includes a set of automated checks, which investigate a specific ra This page presents the complete list of database Advisors along with the corresponding subscription tier for which they are available. -You can also access this list through the [**Advisor checks for PMM**](https://portal.percona.com/advisors) section in the Percona Portal documentation, as the Advisors are hosted on the Percona Platform. PMM Server automatically downloads them from this source when the Advisors and Telemetry options are enabled in PMM under **Configuration > Settings > Advanced Settings**. Both options are enabled by default. +You can also access this list through the [**Advisor checks for PMM** :octicons-link-external-16:](https://portal.percona.com/advisors){:target="_blank"} section in the Percona Portal documentation, as the Advisors are hosted on the Percona Platform. PMM Server automatically downloads them from this source when the Advisors and Telemetry options are enabled in PMM under **Configuration > Settings > Advanced Settings**. Both options are enabled by default. ### Configuration Advisors diff --git a/documentation/docs/advisors/advisors.md b/documentation/docs/advisors/advisors.md index 5b65fe29a88..9bd0540e48a 100644 --- a/documentation/docs/advisors/advisors.md +++ b/documentation/docs/advisors/advisors.md @@ -18,7 +18,7 @@ As soon as you connect your PMM instance to Percona Platform, has access to addi If you are a Percona customer with a Percona Customer Portal account, you also get access to Standard/Premium Advisor checks, which offer more advanced database health information. -To see the complete list of available checks, see the [Advisor Checks for PMM](https://docs.percona.com/percona-platform/advisors.html) topic in the Percona Platform documentation. +To see the complete list of available checks, see the [Advisor Checks for PMM :octicons-link-external-16:](https://docs.percona.com/percona-platform/advisors.html){:target="_blank"} topic in the Percona Platform documentation. ## Enable/Disable To download the checks available for your Percona Account, the Advisors and Telemetry options have to be enabled under :material-cog: **Configuration >** :material-cog-outline: **Settings > Advanced Settings**. diff --git a/documentation/docs/advisors/develop-advisor-checks.md b/documentation/docs/advisors/develop-advisor-checks.md index 1786a38dda6..5c0dfce432c 100644 --- a/documentation/docs/advisors/develop-advisor-checks.md +++ b/documentation/docs/advisors/develop-advisor-checks.md @@ -9,7 +9,7 @@ As a developer, you can create custom checks to cover additional use cases, rele A check is a combination of: - A query for extracting data from the database. -- Python script for converting extracted data into check results. This is actually a [Starlark](https://github.com/google/starlark-go) script, which is a Python dialect that adds more imperative features than Python. The script's execution environment is sandboxed, and no I/O can be done from it. +- Python script for converting extracted data into check results. This is actually a [Starlark :octicons-link-external-16:](https://github.com/google/starlark-go){:target="_blank"} script, which is a Python dialect that adds more imperative features than Python. The script's execution environment is sandboxed, and no I/O can be done from it. All checks are self-contained in the first phase, as well as in most of the planned phases. @@ -192,13 +192,13 @@ Expand the table below for the list of checks types that you can use to define y | MYSQL_SELECT | Executes 'SELECT …' clause against MySQL database. |Yes| | POSTGRESQL_SHOW | Executes 'SHOW ALL' command against PosgreSQL database. |No| | POSTGRESQL_SELECT | Executes 'SELECT …' clause against PosgreSQL database. |Yes| - | MONGODB_GETPARAMETER | Executes db.adminCommand( { getParameter: "*" } ) against MongoDB's "admin" database. For more information, see [getParameter](https://docs.mongodb.com/manual/reference/command/getParameter/)| No| - | MONGODB_BUILDINFO | Executes db.adminCommand( { buildInfo: 1 } ) against MongoDB's "admin" database. For more information, see [buildInfo](https://docs.mongodb.com/manual/reference/command/buildInfo/) | No| - | MONGODB_GETCMDLINEOPTS | Executes db.adminCommand( { getCmdLineOpts: 1 } ) against MongoDB's "admin" database. For more information, see [getCmdLineOpts](https://docs.mongodb.com/manual/reference/command/getCmdLineOpts/) |No| - | MONGODB_REPLSETGETSTATUS | Executes db.adminCommand( { replSetGetStatus: 1 } ) against MongoDB's "admin" database. For more information, see [replSetGetStatus](https://docs.mongodb.com/manual/reference/command/replSetGetStatus/) |No| - | MONGODB_GETDIAGNOSTICDATA |Executes db.adminCommand( { getDiagnosticData: 1 } ) against MongoDB's "admin" database. For more information, see [MongoDB Performance](https://docs.mongodb.com/manual/administration/analyzing-mongodb-performance/#full-time-diagnostic-data-capture)| No| - | METRICS_INSTANT |Executes instant [MetricsQL](https://docs.victoriametrics.com/MetricsQL.html) query. Query can use placeholders in query string {% raw %} **{{.NodeName**}} and **{{.ServiceName}}** {% endraw %}. Both match target service/node names. To read more about instant queries, check out the [Prometheus docs](https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries).|Yes| - | METRICS_RANGE |Executes range [MetricsQL](https://docs.victoriametrics.com/MetricsQL.html) query. Query can use placeholders in query string {% raw %} **{{.NodeName**}} and **{{.ServiceName}}** {% endraw %}. Both match target service/node names. To read more about range queries, check out the [Prometheus docs](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries).|Yes| + | MONGODB_GETPARAMETER | Executes db.adminCommand( { getParameter: "*" } ) against MongoDB's "admin" database. For more information, see [getParameter :octicons-link-external-16:](https://docs.mongodb.com/manual/reference/command/getParameter/){:target="_blank"}| No| + | MONGODB_BUILDINFO | Executes db.adminCommand( { buildInfo: 1 } ) against MongoDB's "admin" database. For more information, see [buildInfo :octicons-link-external-16:](https://docs.mongodb.com/manual/reference/command/buildInfo/){:target="_blank"} | No| + | MONGODB_GETCMDLINEOPTS | Executes db.adminCommand( { getCmdLineOpts: 1 } ) against MongoDB's "admin" database. For more information, see [getCmdLineOpts :octicons-link-external-16:](https://docs.mongodb.com/manual/reference/command/getCmdLineOpts/){:target="_blank"} |No| + | MONGODB_REPLSETGETSTATUS | Executes db.adminCommand( { replSetGetStatus: 1 } ) against MongoDB's "admin" database. For more information, see [replSetGetStatus :octicons-link-external-16:](https://docs.mongodb.com/manual/reference/command/replSetGetStatus/){:target="_blank"} |No| + | MONGODB_GETDIAGNOSTICDATA |Executes db.adminCommand( { getDiagnosticData: 1 } ) against MongoDB's "admin" database. For more information, see [MongoDB Performance :octicons-link-external-16:](https://docs.mongodb.com/manual/administration/analyzing-mongodb-performance/#full-time-diagnostic-data-capture){:target="_blank"}| No| + | METRICS_INSTANT |Executes instant [MetricsQL :octicons-link-external-16:](https://docs.victoriametrics.com/MetricsQL.html){:target="_blank"} query. Query can use placeholders in query string {% raw %} **{{.NodeName**}} and **{{.ServiceName}}** {% endraw %}. Both match target service/node names. To read more about instant queries, check out the [Prometheus docs :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries){:target="_blank"}.|Yes| + | METRICS_RANGE |Executes range [MetricsQL :octicons-link-external-16:](https://docs.victoriametrics.com/MetricsQL.html){:target="_blank"} query. Query can use placeholders in query string {% raw %} **{{.NodeName**}} and **{{.ServiceName}}** {% endraw %}. Both match target service/node names. To read more about range queries, check out the [Prometheus docs :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries){:target="_blank"}.|Yes| | CLICKHOUSE_SELECT |Executes 'SELECT ...' statements against PMM's [Query Analytics](../use/qan/index.md) ClickHouse database. Queries can use the {% raw %} **{{.ServiceName**}} and **{{.ServiceID}}** {% endraw %} placeholders in query string. They match the target service name and service ID respectively.|Yes| ## Query parameters @@ -206,8 +206,8 @@ Expand the table below for the list of checks types that you can use to define y - **lookback** (duration, optional): specifies how far in past to look back to metrics history. If this parameter is not specified, then query executed on the latest data. Example values: `30s`, `5m`, `8h`. - `METRICS_RANGE` - **lookback** (duration, optional): specifies how far in past to look back to metrics history. If this parameter is not specified, then query executed on the latest data. Example values: `30s`, `5m`, `8h`. - - **range** (duration, required): specifies time window of the query. This parameter is equal to [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries). - - **step** (duration, required): query resolution. This parameter is equal to [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries). + - **range** (duration, required): specifies time window of the query. This parameter is equal to [Prometheus API :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries){:target="_blank"}. + - **step** (duration, required): query resolution. This parameter is equal to [Prometheus API :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries){:target="_blank"}. - `POSTGRESQL_SELECT` - **all_dbs** (boolean, optional): execute query on all available databases in PostgreSQL instance. If this parameter is not specified, then query executed on the default database (the one that was specified when service was added to PMM). @@ -219,7 +219,7 @@ Expand the table below for the list of checks types that you can use to define y To develop custom checks for PMM: {.power-number} -1. Install the latest PMM Server and PMM Client builds following the [installation instructions](https://www.percona.com/software/pmm/quickstart#). +1. Install the latest PMM Server and PMM Client builds following the [installation instructions :octicons-link-external-16:](https://www.percona.com/software/pmm/quickstart#){:target="_blank"}. 2. Run PMM Server with special environment variables: - `PMM_DEV_ADVISOR_CHECKS_FILE=/srv/custom-checks.yml` to use checks from the local files instead of downloading them from Percona Platform. @@ -276,4 +276,4 @@ There are two ways to reload your check file after making changes: - From command line (always works): SSH into PMM Server and execute: `supervisorctl restart pmm-managed`. ## Submit feedback -We welcome your feedback on the current process for developing and debugging checks. Send us your comments or post a question on the [Percona Forums](https://forums.percona.com/c/percona-monitoring-and-management-pmm/pmm-3/84). +We welcome your feedback on the current process for developing and debugging checks. Send us your comments or post a question on the [Percona Forums :octicons-link-external-16:](https://forums.percona.com/c/percona-monitoring-and-management-pmm/pmm-3/84){:target="_blank"}. diff --git a/documentation/docs/alert/alert_rules.md b/documentation/docs/alert/alert_rules.md index 8ebfdb626c1..7b5d0c9fce9 100644 --- a/documentation/docs/alert/alert_rules.md +++ b/documentation/docs/alert/alert_rules.md @@ -33,7 +33,7 @@ To check the full list of available PMM templates, see the [List of available al ### Create alert rules from alert rule templates -This section focuses on creating an alert rule based on PMM templates. For information on working with the other alert types, check the Grafana documentation on [Grafana Labs](https://grafana.com/docs/grafana/latest/alerting/). +This section focuses on creating an alert rule based on PMM templates. For information on working with the other alert types, check the Grafana documentation on [Grafana Labs :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/alerting/){:target="_blank"}. ### Provision alert resources @@ -47,7 +47,7 @@ Before creating PMM alert rules, configure the required alert resources: ### Configure alert templates Alerts templates are YAML files that provide the source framework for alert rules. -Alert templates contain general template details and an alert expression defined in [MetricsQL](https://docs.victoriametrics.com/MetricsQL.html). This query language is backward compatible with PromQL. +Alert templates contain general template details and an alert expression defined in [MetricsQL :octicons-link-external-16:](https://docs.victoriametrics.com/MetricsQL.html){:target="_blank"}. This query language is backward compatible with PromQL. ### Create custom templates @@ -127,7 +127,7 @@ Note that to paste the query above, **Explore** must be in `Code` mode, and not After provisioning the resources required for creating Percona templated alerts, you are now ready to create your alert rule based on a Percona template. -If you want to learn about creating Grafana alerts instead, check out [Grafana's documentation](https://grafana.com/docs/grafana/latest/alerting/): +If you want to learn about creating Grafana alerts instead, check out [Grafana's documentation :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/alerting/){:target="_blank"}: {.power-number} 1. Go to **Alerting > Alert Rules**, and click **New alert rule from template**. diff --git a/documentation/docs/alert/silence_alerts.md b/documentation/docs/alert/silence_alerts.md index 0fa5855b9e5..0b8aef6f366 100644 --- a/documentation/docs/alert/silence_alerts.md +++ b/documentation/docs/alert/silence_alerts.md @@ -24,7 +24,7 @@ To create a new silence: 6. Review the affected alert instances that will be silenced. 7. Click **Save silece**. -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. +For more information on working with silences, see [About alerting silences :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/alerting/manage-notifications/create-silence/){:target="_blank"} in the Grafana documentation. ## Alerting compatibility @@ -52,8 +52,8 @@ To see all the available options, check the scrip help using `ia_migration.py -h #### Script prerequisites -- Python version 3.x, which you can download from [Python Downloads centre](https://www.python.org/downloads/). -- [Requests library](https://requests.readthedocs.io/en/latest/user/install/#install), which you can install with the following command: ```pip3 install requests```. +- Python version 3.x, which you can download from [Python Downloads centre :octicons-link-external-16:](https://www.python.org/downloads/){:target="_blank"}. +- [Requests library :octicons-link-external-16:](https://requests.readthedocs.io/en/latest/user/install/#install){:target="_blank"}, which you can install with the following command: ```pip3 install requests```. !!! caution alert alert-warning "Important" The script sets all migrated alert rules to Active. Make sure to silence any alerts that should not be firing. diff --git a/documentation/docs/api/index.md b/documentation/docs/api/index.md index 92479dfac4e..9f4fc790980 100644 --- a/documentation/docs/api/index.md +++ b/documentation/docs/api/index.md @@ -2,11 +2,11 @@ PMM Server provides a comprehensive REST API that enables you to monitor databases, manage resources, collect metrics, and automate PMM operations programmatically. The API supports endpoints for managing nodes, services, agents, alerting, backups, and other PMM components. -The [complete API documentation on Readme.io](https://percona-pmm.readme.io/reference/introduction) includes detailed endpoint specifications, authentication methods, example requests, and response schemas. +The [complete API documentation on Readme.io :octicons-link-external-16:](https://percona-pmm.readme.io/reference/introduction){:target="_blank"} includes detailed endpoint specifications, authentication methods, example requests, and response schemas. ## Interactive API documentation -You can explore and test the API using the built-in [Swagger](https://swagger.io/tools/swagger-ui/) UI, accessible at the `/swagger/` endpoint of your PMM Server. The Swagger interface allows you to: +You can explore and test the API using the built-in [Swagger :octicons-link-external-16:](https://swagger.io/tools/swagger-ui/){:target="_blank"} UI, accessible at the `/swagger/` endpoint of your PMM Server. The Swagger interface allows you to: - browse available API endpoints - view detailed request and response schemas diff --git a/documentation/docs/backup/index.md b/documentation/docs/backup/index.md index d41a5d2424b..629685d9161 100644 --- a/documentation/docs/backup/index.md +++ b/documentation/docs/backup/index.md @@ -34,12 +34,12 @@ To learn how to create and restore backups, check out subtopics below: ??? info "Additional resources" Here are some external resources for learning more about databases backups: - - [Amazon Web Services S3](https://aws.amazon.com/s3/) - - [Percona Backup for MongoDB](https://www.percona.com/doc/percona-backup-mongodb/installation.html) - - [PERCONA_QPRESS](https://docs.percona.com/percona-xtrabackup/2.4/backup_scenarios/compressed_backup.html) - - [PERCONA_XBCLOUD](https://www.percona.com/doc/percona-xtrabackup/2.3/xbcloud/xbcloud.html) - - [PERCONA_XBSTREAM](https://www.percona.com/doc/percona-xtrabackup/2.3/xbstream/xbstream.html) - - [PERCONA_XTRABACKUP](https://www.percona.com/software/mysql-database/percona-xtrabackup) - - [oplog slices](https://www.percona.com/doc/percona-backup-mongodb/glossary.html#term-oplog-slice) - - [Percona Server for MongoDB](https://www.percona.com/software/mongo-database/percona-server-for-mongodb) - - [MongoDB Replication](https://docs.mongodb.com/manual/replication/) + - [Amazon Web Services S3 :octicons-link-external-16:](https://aws.amazon.com/s3/){:target="_blank"} + - [Percona Backup for MongoDB :octicons-link-external-16:](https://www.percona.com/doc/percona-backup-mongodb/installation.html){:target="_blank"} + - [PERCONA_QPRESS :octicons-link-external-16:](https://docs.percona.com/percona-xtrabackup/2.4/backup_scenarios/compressed_backup.html){:target="_blank"} + - [PERCONA_XBCLOUD :octicons-link-external-16:](https://www.percona.com/doc/percona-xtrabackup/2.3/xbcloud/xbcloud.html){:target="_blank"} + - [PERCONA_XBSTREAM :octicons-link-external-16:](https://www.percona.com/doc/percona-xtrabackup/2.3/xbstream/xbstream.html){:target="_blank"} + - [PERCONA_XTRABACKUP :octicons-link-external-16:](https://www.percona.com/software/mysql-database/percona-xtrabackup){:target="_blank"} + - [oplog slices :octicons-link-external-16:](https://www.percona.com/doc/percona-backup-mongodb/glossary.html#term-oplog-slice){:target="_blank"} + - [Percona Server for MongoDB :octicons-link-external-16:](https://www.percona.com/software/mongo-database/percona-server-for-mongodb){:target="_blank"} + - [MongoDB Replication :octicons-link-external-16:](https://docs.mongodb.com/manual/replication/){:target="_blank"} diff --git a/documentation/docs/backup/mongodb-backup/backup_mongo.md b/documentation/docs/backup/mongodb-backup/backup_mongo.md index 7b1f65f6e92..a689b8219c1 100644 --- a/documentation/docs/backup/mongodb-backup/backup_mongo.md +++ b/documentation/docs/backup/mongodb-backup/backup_mongo.md @@ -16,7 +16,7 @@ The following backup operations are supported for replica sets: ## Sharded clusters -PMM 3 supports backing up sharded clusters. However, restoring for sharded cluster configurations is only supported from the CLI, and is handled via [Percona Backup for MongoDB](https://docs.percona.com/percona-backup-mongodb/usage/restore.html). +PMM 3 supports backing up sharded clusters. However, restoring for sharded cluster configurations is only supported from the CLI, and is handled via [Percona Backup for MongoDB :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/usage/restore.html){:target="_blank"}. - Storing backups on Amazon S3-compatible object storage, and on mounted filesystem - Creating Logical snapshot backups diff --git a/documentation/docs/backup/mongodb-backup/create_PITR_mongo.md b/documentation/docs/backup/mongodb-backup/create_PITR_mongo.md index 36fb5b2a48e..492c1462a1a 100644 --- a/documentation/docs/backup/mongodb-backup/create_PITR_mongo.md +++ b/documentation/docs/backup/mongodb-backup/create_PITR_mongo.md @@ -1,6 +1,6 @@ # Create MongoDB PITR backups -Point-in-Time Recovery (PITR) restores databases up to a specific moment in time. PITR includes restoring the data from a backup snapshot and replaying all events that occurred to this data up to a specified moment from [oplog slices](https://docs.percona.com/percona-backup-mongodb/reference/glossary.html#oplog-slice). +Point-in-Time Recovery (PITR) restores databases up to a specific moment in time. PITR includes restoring the data from a backup snapshot and replaying all events that occurred to this data up to a specified moment from [oplog slices :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/reference/glossary.html#oplog-slice){:target="_blank"}. Point-in-Time Recovery helps you prevent data loss during a disaster such as crashed database, accidental data deletion or drop of tables, or unwanted update of multiple fields instead of a single one. @@ -10,7 +10,7 @@ PMM introduced the option to create PITR Backups for MongoDB in version 2.23, as Percona Backup for MongoDB is a distributed, low-impact solution for achieving consistent backups of MongoDB sharded clusters and replica sets. Restoring PITR backups is available for backups based on pbm ≤ 2.0.1. To restore PITR backups, make sure you have pbm ≥ 2.0.1 installed. - Percona Backup for MongoDB supports [Percona Server for MongoDB](https://www.percona.com/software/mongodb/percona-server-for-mongodb) and MongoDB Community ≤ 3.6, with [MongoDB Replication](https://docs.mongodb.com/manual/replication/) enabled. For more information, see the [Percona Backup for MongoDB documentation](https://docs.percona.com/percona-backup-mongodb/installation.html). + Percona Backup for MongoDB supports [Percona Server for MongoDB :octicons-link-external-16:](https://www.percona.com/software/mongodb/percona-server-for-mongodb){:target="_blank"} and MongoDB Community ≤ 3.6, with [MongoDB Replication :octicons-link-external-16:](https://docs.mongodb.com/manual/replication/){:target="_blank"} enabled. For more information, see the [Percona Backup for MongoDB documentation :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/installation.html){:target="_blank"}. ## How does it work? diff --git a/documentation/docs/backup/mongodb-backup/mongo_prerequisites.md b/documentation/docs/backup/mongodb-backup/mongo_prerequisites.md index b8d3429255b..4d396d3d3da 100644 --- a/documentation/docs/backup/mongodb-backup/mongo_prerequisites.md +++ b/documentation/docs/backup/mongodb-backup/mongo_prerequisites.md @@ -6,7 +6,7 @@ Before creating MongoDB backups, make sure to: 1. Check that **Backup Management** is enabled and the Backup option is available on the side menu. If Backup Management has been disabled on your instance, go to :material-cog: **Configuration > PMM Settings > Advanced Settings**, re-enable **Backup Management** then click **Apply changes**. 2. [Prepare and create a storage location for your backups](../prepare_storage_location.md). 3. Check that [PMM Client](../../install-pmm/install-pmm-client/index.md) is installed and running on all MongoDB nodes in the cluster. -4. Check that [Percona Backup for MongoDB](https://docs.percona.com/percona-backup-mongodb/index.html) (PBM) is installed and `pbm-agent` is running on all MongoDB nodes in the replica set. Make sure to [configure the MongoDB connection URI for pbm-agent](https://docs.percona.com/percona-backup-mongodb/install/initial-setup.html#set-the-mongodb-connection-uri-for-pbm-agent) on all nodes. +4. Check that [Percona Backup for MongoDB :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/index.html){:target="_blank"} (PBM) is installed and `pbm-agent` is running on all MongoDB nodes in the replica set. Make sure to [configure the MongoDB connection URI for pbm-agent :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/install/initial-setup.html#set-the-mongodb-connection-uri-for-pbm-agent){:target="_blank"} on all nodes. 5. Check that installed **mongod** binary is added to **PATH** variable of the user under which PMM client is running, and that **mongod** is controlled as a service by **systemctl**. PMM only works with a single **mongod** installed on a node. 6. Check that your MongoDB Services are managed as clusters in PMM. Go to **PMM Inventory > Services** page, expand the **Details** section on the **Options** column, and make sure that all the services in the table specify a cluster name. Services that do not specify a cluster name should be removed and re-added using commands like the following: diff --git a/documentation/docs/backup/mongodb-backup/mongodb_limitations.md b/documentation/docs/backup/mongodb-backup/mongodb_limitations.md index 038115c8e5d..87c1d34eeba 100644 --- a/documentation/docs/backup/mongodb-backup/mongodb_limitations.md +++ b/documentation/docs/backup/mongodb-backup/mongodb_limitations.md @@ -3,8 +3,8 @@ Creating and restoring MongoDB backups in PMM currently has the following limitations and requirements: - Physical backups and restores are supported only for **Percona Server for MongoDB**. -- Physical restores are not supported for deployments with arbiter nodes. For more information, see the [Percona Backup for MongoDB documentation](https://docs.percona.com/percona-backup-mongodb/usage/restore.html#physical-restore-known-limitations). -- Creating backups for sharded clusters is available straight from the UI. However, restoring these backup artifacts is only possible via the CLI, using Percona Backup for MongoDB. For information on restoring sharded backups, check the [PBM documentation](https://docs.percona.com/percona-backup-mongodb/usage/restore.html). +- Physical restores are not supported for deployments with arbiter nodes. For more information, see the [Percona Backup for MongoDB documentation :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/usage/restore.html#physical-restore-known-limitations){:target="_blank"}. +- Creating backups for sharded clusters is available straight from the UI. However, restoring these backup artifacts is only possible via the CLI, using Percona Backup for MongoDB. For information on restoring sharded backups, check the [PBM documentation :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/usage/restore.html){:target="_blank"}. - Retention policy is supported only for snapshot types of scheduled backups and for the S3-compatible storage type. - Before restoring, make sure to prevent clients from accessing the database. diff --git a/documentation/docs/backup/mongodb-backup/restore_MongoDB_backups.md b/documentation/docs/backup/mongodb-backup/restore_MongoDB_backups.md index 02771a026f7..b18c592ad33 100644 --- a/documentation/docs/backup/mongodb-backup/restore_MongoDB_backups.md +++ b/documentation/docs/backup/mongodb-backup/restore_MongoDB_backups.md @@ -21,10 +21,10 @@ To restore to a new cluster manually: {.power-number} 1. Install MongoDB and Percona Backup for MongoDB. Pay attention to the versions. To minimize potential incompatibility, use the same versions that were used for taking backups. - For instructions, see the [PBM install documentation](https://docs.percona.com/percona-backup-mongodb/installation.html). + For instructions, see the [PBM install documentation :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/installation.html){:target="_blank"}. 2. Configure your environment: - to restore to a new environment with the same replica set name, make sure that the replica set name in your new destination cluster use the same name as that in the cluster that was backed up.
- For more information, see [Restoring a backup into a new-environment](https://docs.percona.com/percona-backup-mongodb/usage/restore.html#restoring-a-backup-into-a-new-environment) in the PBM documentation.
+ For more information, see [Restoring a backup into a new-environment :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/usage/restore.html#restoring-a-backup-into-a-new-environment){:target="_blank"} in the PBM documentation.
- to restore **logical backups** to a new environment that has a different replica set name, configure the name mapping between the source and target environments.
For the new environment, you can either set the **PBM_REPLSET_REMAPPING** environment variable for pbm CLI, or use the `--replset-remapping` flag for PBM commands. @@ -38,7 +38,7 @@ To restore to a new cluster manually: `$ pbm restore --replset-remapping="targetRS=sourceRS"` - For more information, see [Restoring into a replica set with a different name](https://docs.percona.com/percona-backup-mongodb/usage/restore.html#restoring-into-a-cluster-replica-set-with-a-different-name) in the PBM documentation. + For more information, see [Restoring into a replica set with a different name :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/usage/restore.html#restoring-into-a-cluster-replica-set-with-a-different-name){:target="_blank"} in the PBM documentation. 3. Make sure that Percona Backup for MongoDB configuration in the new environment points to the remote storage defined for the original environment, including the authentication credentials for object stores. @@ -74,7 +74,7 @@ To restore to a new cluster manually: pbm config --file pbm_config.yaml ``` - For more information, see **Restoring a backup into a new-environment** in [the PBM documentation](https://docs.percona.com/percona-backup-mongodb/usage/restore.html#restoring-a-backup-into-a-new-environment). + For more information, see **Restoring a backup into a new-environment** in [the PBM documentation :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/usage/restore.html#restoring-a-backup-into-a-new-environment){:target="_blank"}. 4. Run `pbm list` to check if pbm is ready to perform the restore procedure. @@ -92,7 +92,7 @@ To restore to a new cluster manually: `pbm restore 2022-11-23T19:40:06Z` - For more information, see [Restore a backup](https://docs.percona.com/percona-backup-mongodb/usage/restore.html) topic in the PBM documentation. + For more information, see [Restore a backup :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/usage/restore.html){:target="_blank"} topic in the PBM documentation. - For PITR backups: @@ -110,7 +110,7 @@ To restore to a new cluster manually: `pbm restore --time="2022-11-23T19:40:26` - For more information, see the [Point-in-time Recovery topic in the PBM documentation](https://docs.percona.com/percona-backup-mongodb/features/point-in-time-recovery.html?h=point). + For more information, see the [Point-in-time Recovery topic in the PBM documentation :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/features/point-in-time-recovery.html?h=point){:target="_blank"}. 6. Check the progress of the restore operation, using one of the commands below: @@ -132,4 +132,4 @@ To restore to a new cluster manually: Sharded cluster backups are supported and PMM handles the backup process end-to-end. However, restoring such artifacts is currently possible only via the CLI, using Percona Backup for MongoDB. -For information on restoring sharded backups, check the [PBM documentation](https://docs.percona.com/percona-backup-mongodb/usage/restore.html) \ No newline at end of file +For information on restoring sharded backups, check the [PBM documentation :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/usage/restore.html){:target="_blank"} \ No newline at end of file diff --git a/documentation/docs/backup/mysql-backup/mysql_prerequisites.md b/documentation/docs/backup/mysql-backup/mysql_prerequisites.md index 57f7eb1879c..90eeac0ac06 100644 --- a/documentation/docs/backup/mysql-backup/mysql_prerequisites.md +++ b/documentation/docs/backup/mysql-backup/mysql_prerequisites.md @@ -29,11 +29,11 @@ Before creating MySQL backups, make sure to: 9. Check that the latest versions of the following packages are installed and included in the `$PATH` environment variable: - - [`xtrabackup`](https://www.percona.com/software/mysql-database/percona-xtrabackup), which includes: + - [`xtrabackup` :octicons-link-external-16:](https://www.percona.com/software/mysql-database/percona-xtrabackup){:target="_blank"}, which includes: - - [`xbcloud`](https://www.percona.com/doc/percona-xtrabackup/2.3/xbcloud/xbcloud.html) + - [`xbcloud` :octicons-link-external-16:](https://www.percona.com/doc/percona-xtrabackup/2.3/xbcloud/xbcloud.html){:target="_blank"} - - [`xbstream`](https://www.percona.com/doc/percona-xtrabackup/2.3/xbstream/xbstream.html) + - [`xbstream` :octicons-link-external-16:](https://www.percona.com/doc/percona-xtrabackup/2.3/xbstream/xbstream.html){:target="_blank"} - [`qpress`][PERCONA_QPRESS]. diff --git a/documentation/docs/backup/prepare_storage_location.md b/documentation/docs/backup/prepare_storage_location.md index 2c918378f75..9ba1b0947e0 100644 --- a/documentation/docs/backup/prepare_storage_location.md +++ b/documentation/docs/backup/prepare_storage_location.md @@ -4,21 +4,21 @@ Prepare a storage location as a backup destination for creating and storing your PMM supports the following types of storage: -- **Amazon S3-compatible**: enables you to use not only AWS S3, but also other storage solutions that support S3 API, like [min.io](https://min.io/). +- **Amazon S3-compatible**: enables you to use not only AWS S3, but also other storage solutions that support S3 API, like [min.io :octicons-link-external-16:](https://min.io/){:target="_blank"}. - **Local storage**: currently only available for MongoDB backups. ## Prepare a location for local backups If you prefer storing your MongoDB backup artifacts on a remote filesystem, make sure that you've mounted the remote folder to all the mongoDB nodes on the same path, and that PBM tool has Write permissions on the path you define. -For more information, see the [Percona Backup for MongoDB (PBM) documentation](https://docs.percona.com/percona-backup-mongodb/details/storage-configuration.html#remote-filesystem-server-storage). +For more information, see the [Percona Backup for MongoDB (PBM) documentation :octicons-link-external-16:](https://docs.percona.com/percona-backup-mongodb/details/storage-configuration.html#remote-filesystem-server-storage){:target="_blank"}. ## Prepare a location for S3-compatible storage -If you want to store backup artifacts in S3-compatible storage, you can use [Amazon S3](https://aws.amazon.com/s3/), [Min.io](https://min.io/) or any other storage solution with S3-compatible API. +If you want to store backup artifacts in S3-compatible storage, you can use [Amazon S3 :octicons-link-external-16:](https://aws.amazon.com/s3/){:target="_blank"}, [Min.io :octicons-link-external-16:](https://min.io/){:target="_blank"} or any other storage solution with S3-compatible API. Before creating a cloud storage location for our future backups, make sure you have your S3-compatible storage ready. In addition to bucket location details, you will also need to ensure proper S3 permissions. The general minimum permissions are **LIST**/**PUT**/**GET**/**DELETE**. -A sample [IAM](https://aws.amazon.com/iam/) policy is: +A sample [IAM :octicons-link-external-16:](https://aws.amazon.com/iam/){:target="_blank"} policy is: ```json { diff --git a/documentation/docs/configure-pmm/advanced_settings.md b/documentation/docs/configure-pmm/advanced_settings.md index a7d1dba83bc..47d78c63c80 100644 --- a/documentation/docs/configure-pmm/advanced_settings.md +++ b/documentation/docs/configure-pmm/advanced_settings.md @@ -29,13 +29,13 @@ We do not gather anything that can identify your system, but consider the follow The first telemetry reporting of a new PMM Server instance is delayed by 24 hours to allow enough time to disable the service for those that do not wish to share any information. -The landing page for this service, [check.percona.com](https://check.percona.com), explains what this service is. +The landing page for this service, [check.percona.com :octicons-link-external-16:](https://check.percona.com){:target="_blank"}, explains what this service is. -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. +Grafana’s [anonymous usage statistics :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/administration/configuration/#reporting-enabled){:target="_blank"} 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. -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). +For information on the various config parameters for telemetry, see the [config file :octicons-link-external-16:](https://github.com/percona/pmm/blob/main/managed/services/telemetry/config.default.yml){:target="_blank"}. ## Check for updates diff --git a/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md b/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md index da984996ec9..756009b5c31 100644 --- a/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md +++ b/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md @@ -15,7 +15,7 @@ To connect your PMM Server to Percona Platform: 4. On the **Profile Settings page**, copy the code from the **Percona Platform Access Token** field. 5. Back into PMM, paste the Access Token into the **Percona Platform Access Token** field, and click **Connect**. -To confirm that you have successfully connected the server and check the list of all servers currently connected to an organization, go to [Percona Platform](https://portal.percona.com) > **Dashboard** tab and click **View Instances** next to the **Connect your PMM** step. +To confirm that you have successfully connected the server and check the list of all servers currently connected to an organization, go to [Percona Platform :octicons-link-external-16:](https://portal.percona.com){:target="_blank"} > **Dashboard** tab and click **View Instances** next to the **Connect your PMM** step. ## Check Percona Portal entitlements @@ -38,7 +38,7 @@ If you are a PMM Admin, you can terminate any connections to Percona Platform, e If you do disconnect servers without being connected with a Percona Account, you'll have to manually remove the unavailable servers from Percona Platform. This ensures that your list of connected PMM instances stays up-to-date in Percona Platform. -To do this, go to [PMM instances](https://portal.percona.com/login), and remove any servers that you have already disconnected from PMM. +To do this, go to [PMM instances :octicons-link-external-16:](https://portal.percona.com/login){:target="_blank"}, and remove any servers that you have already disconnected from PMM. ## Sign into PMM with your Percona Account diff --git a/documentation/docs/configure-pmm/percona_platform/integrate_with_percona_platform.md b/documentation/docs/configure-pmm/percona_platform/integrate_with_percona_platform.md index 83e254333d4..33980271872 100644 --- a/documentation/docs/configure-pmm/percona_platform/integrate_with_percona_platform.md +++ b/documentation/docs/configure-pmm/percona_platform/integrate_with_percona_platform.md @@ -7,9 +7,9 @@ Connect your PMM Servers to Percona Platform to boost the monitoring capabilitie ### Connect PMM to Percona Platform -You can connect to Percona Platform with a Percona Account or via Google or GitHub authentication. If [Percona Support](https://www.percona.com/about-percona/contact) has enabled a custom identity provider for your account, you can also log in using your company's credentials. +You can connect to Percona Platform with a Percona Account or via Google or GitHub authentication. If [Percona Support :octicons-link-external-16:](https://www.percona.com/about-percona/contact){:target="_blank"} has enabled a custom identity provider for your account, you can also log in using your company's credentials. -We recommend that you connect with a Percona Account, as this gives you access to other Percona services, including Percona Platform, Percona Customer Portal, and Community Forum. If you don’t have a Percona Account, you can create one on the [Percona Platform homepage](https://portal.percona.com/login) using the **Don't have an account? Create one?** link. +We recommend that you connect with a Percona Account, as this gives you access to other Percona services, including Percona Platform, Percona Customer Portal, and Community Forum. If you don’t have a Percona Account, you can create one on the [Percona Platform homepage :octicons-link-external-16:](https://portal.percona.com/login){:target="_blank"} using the **Don't have an account? Create one?** link. #### Prerequisites @@ -20,7 +20,7 @@ To ensure that PMM can establish a connection to Percona Platform: To check whether you are a member of an existing Platform organization: {.power-number} -1. Log in to [Percona Platform](https://portal.percona.com) using your Percona Account. If you are connecting via GitHub, make sure you set your email address as **public** in your GitHub account. If your email address is private instead, Percona Platform cannot access it to authenticate you. +1. Log in to [Percona Platform :octicons-link-external-16:](https://portal.percona.com){:target="_blank"} using your Percona Account. If you are connecting via GitHub, make sure you set your email address as **public** in your GitHub account. If your email address is private instead, Percona Platform cannot access it to authenticate you. 2. On the **Getting Started** page, check that the **Create organization** step shows an option to view your organization. diff --git a/documentation/docs/get-help.md b/documentation/docs/get-help.md index 7c7aad4d910..126d0d47b99 100644 --- a/documentation/docs/get-help.md +++ b/documentation/docs/get-help.md @@ -7,9 +7,9 @@ Our documentation guides are packed with information, but they can’t cover eve Be a part of a space where you can tap into a wealth of knowledge from other database enthusiasts and experts who work with Percona’s software every day. While our service is entirely free, keep in mind that response times can vary depending on the complexity of the question. You are engaging with people who genuinely love solving database challenges. -Visit the [PMM Community Forum](https://forums.percona.com/c/percona-monitoring-and-management-pmm/30/all){:target="_blank"}. It’s an excellent place for discussions, technical insights, and support around Percona database software. If you’re new and feeling a bit unsure, our [FAQ](https://forums.percona.com/faq){:target="_blank"} and [Guide for new users](https://forums.percona.com/t/faq-guide-for-new-users/8562){:target="_blank"} can ease you in. +Visit the [PMM Community Forum :octicons-link-external-16:](https://forums.percona.com/c/percona-monitoring-and-management-pmm/30/all){:target="_blank"}. It’s an excellent place for discussions, technical insights, and support around Percona database software. If you’re new and feeling a bit unsure, our [FAQ :octicons-link-external-16:](https://forums.percona.com/faq){:target="_blank"} and [Guide for new users :octicons-link-external-16:](https://forums.percona.com/t/faq-guide-for-new-users/8562){:target="_blank"} can ease you in. -If you have thoughts, feedback, or ideas, the community team would like to hear from you at [Any ideas on how to make the forum better?](https://forums.percona.com/t/any-ideas-on-how-to-make-the-forum-better/11522){:target=”_blank”}. We’re always excited to connect and improve everyone’s experience. +If you have thoughts, feedback, or ideas, the community team would like to hear from you at [Any ideas on how to make the forum better? :octicons-link-external-16:](https://forums.percona.com/t/any-ideas-on-how-to-make-the-forum-better/11522){:target="_blank"}. We’re always excited to connect and improve everyone’s experience. ## Percona Experts diff --git a/documentation/docs/index.md b/documentation/docs/index.md index 6178b90ecc7..a22e1867b7c 100644 --- a/documentation/docs/index.md +++ b/documentation/docs/index.md @@ -12,7 +12,7 @@ Key features: - Easy setup with just two components: Server and Client ## Try PMM Demo -Want to see PMM in action before installing? Visit our [live demo](https://pmmdemo.percona.com/) to explore PMM's features and interface with sample data. +Want to see PMM in action before installing? Visit our [live demo :octicons-link-external-16:](https://pmmdemo.percona.com/){:target="_blank"} to explore PMM's features and interface with sample data.
@@ -44,7 +44,7 @@ Are you ready to begin configuring PMM but need help figuring out how to begin? Looking for reliable and easy-to-use resources to tackle your daily challenges with database monitoring and management? -[Additional resources :material-arrow-right:](https://www.percona.com/resources){ .md-button .md-button--primary } +[Additional resources :material-arrow-right: :octicons-link-external-16:](https://www.percona.com/resources){:target="_blank"}{ .md-button .md-button--primary }
diff --git a/documentation/docs/install-pmm/HA.md b/documentation/docs/install-pmm/HA.md index 7e4bf108825..0be83485b48 100644 --- a/documentation/docs/install-pmm/HA.md +++ b/documentation/docs/install-pmm/HA.md @@ -139,7 +139,7 @@ Choose the option that best fits your infrastructure and requirements: Before you begin: - - [Install and configure Docker](https://docs.docker.com/get-docker/). + - [Install and configure Docker :octicons-link-external-16:](https://docs.docker.com/get-docker/){:target="_blank"}. - Prepare your environment: - for testing > run services on a single machine. - for production > deploy services on separate instances and use clustered versions of PostgreSQL, VictoriaMetrics, and ClickHouse. Keep in mind that running all services on a single machine is not recommended for production. Use separate instances and clustered components for better reliability. 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 95d2ce9a342..a9b673ba111 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 @@ -2,7 +2,7 @@ ## Required settings -It is possible to use PMM for monitoring [Amazon RDS](https://aws.amazon.com/rds/). In this case, the PMM Client is not installed on the host where the database server is deployed. By using the PMM web interface, you connect to the Amazon RDS DB instance. You only need to provide the IAM user access key (or assign an IAM role) and PMM discovers the Amazon RDS DB instances available for monitoring. +It is possible to use PMM for monitoring [Amazon RDS :octicons-link-external-16:](https://aws.amazon.com/rds/){:target="_blank"}. In this case, the PMM Client is not installed on the host where the database server is deployed. By using the PMM web interface, you connect to the Amazon RDS DB instance. You only need to provide the IAM user access key (or assign an IAM role) and PMM discovers the Amazon RDS DB instances available for monitoring. First of all, ensure that there is the minimal latency between PMM Server and the Amazon RDS instance. @@ -127,7 +127,7 @@ To create an IAM role open the IAM console and click **Roles** on the navigation After the role is created EC2 instances running PMM will have permissions to discover RDS DB instances. !!! note alert alert-primary "" - It’s also possible to create an IAM role to delegate permissions to an IAM user or to add permissions to a user belonging to another AWS account. See the [official AWS documentation on creating IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html). + It’s also possible to create an IAM role to delegate permissions to an IAM user or to add permissions to a user belonging to another AWS account. See the [official AWS documentation on creating IAM roles :octicons-link-external-16:](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html){:target="_blank"}. ## Setting up the Amazon RDS DB Instance 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 1b53203fed2..2a171355bd4 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 @@ -14,7 +14,7 @@ The Microsoft Azure feature is turned off by default. To turn it on: ## Prerequisites -PMM can monitor [Azure](https://azure.microsoft.com) database instances similar to other remote instances. In this case, the PMM Client is not installed on the host where the database server is deployed. +PMM can monitor [Azure :octicons-link-external-16:](https://azure.microsoft.com){:target="_blank"} database instances similar to other remote instances. In this case, the PMM Client is not installed on the host where the database server is deployed. By using the PMM web interface, you connect to the Azure DB instance. Discovery is not yet implemented in PMM but it is possible to add known instances by providing the connection parameters. {.power-number} diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/external.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/external.md index 49085f11d75..653f1b13288 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/external.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/external.md @@ -64,7 +64,7 @@ Connection schema of external serverless exporter: ## Add a service not supported by PMM -PMM can collect any metrics in [Open metrics](https://openmetrics.io) or [Prometheus exposition](https://prometheus.io/docs/instrumenting/exposition_formats/) format. You must specify the host and port of these metrics using the `pmm-admin add external` or `pmm-admin add external-serverless` commands. +PMM can collect any metrics in [Open metrics :octicons-link-external-16:](https://openmetrics.io){:target="_blank"} or [Prometheus exposition :octicons-link-external-16:](https://prometheus.io/docs/instrumenting/exposition_formats/){:target="_blank"} format. You must specify the host and port of these metrics using the `pmm-admin add external` or `pmm-admin add external-serverless` commands. From this point, PMM will collect and store available metrics. @@ -72,17 +72,17 @@ To browse and visualize collected metrics as a first step, we can look at the Ad ![Advanced Data Exploration dashboard](../../../images/PMM_Advanced_Data_Exploration.jpg) -Another way is to create a [new Grafana Dashboard to PMM as needed](https://grafana.com/docs/grafana/latest/best-practices/best-practices-for-creating-dashboards/). +Another way is to create a [new Grafana Dashboard to PMM as needed :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/best-practices/best-practices-for-creating-dashboards/){:target="_blank"}. One more way is to search for an already created dashboard at for the added exporter and import it into PMM. ### Third-party exporters -You can find more exporters on the [official Prometheus page](https://prometheus.io/docs/instrumenting/exporters/). +You can find more exporters on the [official Prometheus page :octicons-link-external-16:](https://prometheus.io/docs/instrumenting/exporters/){:target="_blank"}. ### Custom exporter -You can create a custom external exporter or extend your application to expose metrics in [Prometheus exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/). This gives you complete control over what metrics are collected and how they're exposed. To learn how to build your own exporter, see [Writing Exporter in the Prometheus Docs](https://prometheus.io/docs/instrumenting/writing_exporters). +You can create a custom external exporter or extend your application to expose metrics in [Prometheus exposition format :octicons-link-external-16:](https://prometheus.io/docs/instrumenting/exposition_formats/){:target="_blank"}. This gives you complete control over what metrics are collected and how they're exposed. To learn how to build your own exporter, see [Writing Exporter in the Prometheus Docs :octicons-link-external-16:](https://prometheus.io/docs/instrumenting/writing_exporters){:target="_blank"}. ??? info "Example: Add an HTTP exporter" diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/haproxy.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/haproxy.md index a418ac33ede..331d04792cd 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/haproxy.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/haproxy.md @@ -6,7 +6,7 @@ Before adding HAProxy to PMM, ensure: {.power-number} 1. HAProxy configured with metrics endpoint. - - HAProxy must expose Prometheus metrics. See [How to configure HAProxy](https://www.haproxy.com/blog/haproxy-exposes-a-prometheus-metrics-endpoint). + - HAProxy must expose Prometheus metrics. See [How to configure HAProxy :octicons-link-external-16:](https://www.haproxy.com/blog/haproxy-exposes-a-prometheus-metrics-endpoint){:target="_blank"}. - Default metrics endpoint: `http://localhost:8404/metrics` - Verify metrics are accessible: `curl http://localhost:8404/metrics` 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 25c9f481a92..83452c62a2e 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 @@ -16,7 +16,7 @@ Get your MySQL instance connected to PMM in just a few steps: ``` **Note:** - If you are using an [Administrative Connection](https://dev.mysql.com/doc/refman/8.4/en/administrative-connection-interface.html), you will also need to grant the `SERVICE_CONNECTION_ADMIN` privilege to the `pmm` user. + If you are using an [Administrative Connection :octicons-link-external-16:](https://dev.mysql.com/doc/refman/8.4/en/administrative-connection-interface.html){:target="_blank"}, you will also need to grant the `SERVICE_CONNECTION_ADMIN` privilege to the `pmm` user. 3. Register your MySQL instance with PMM: 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 5932225b753..feaa5b4232d 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 @@ -114,7 +114,7 @@ Choose: | **Drawbacks** | • No aggregated statistics or histograms
• No Query Examples
• Limited metrics collection | • Slightly higher resource overhead
• Requires separate installation
• More complex configuration | | **Known Issues** | None | **⚠️ PMM v2.x/v3.x**: Query plan metrics cause incorrect time measurements (off by 1000x+) | -For a more detailed comparison of extensions, see the [pg_stat_monitor documentation](https://docs.percona.com/pg-stat-monitor/user_guide.html). +For a more detailed comparison of extensions, see the [pg_stat_monitor documentation :octicons-link-external-16:](https://docs.percona.com/pg-stat-monitor/user_guide.html){:target="_blank"}. ### Configure monitoring extension diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/proxysql.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/proxysql.md index e3aee3b2c3a..547a52f6a1c 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/proxysql.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/proxysql.md @@ -23,7 +23,7 @@ pmm-admin add proxysql --username=pmm --password=pmm ``` where `username` and `password` are credentials for the administration interface of the monitored ProxySQL instance. -You should configure a read-only account for monitoring using the [`admin-stats_credentials`](https://proxysql.com/documentation/global-variables/admin-variables/#admin-stats_credentials) variable in ProxySQL +You should configure a read-only account for monitoring using the [`admin-stats_credentials` :octicons-link-external-16:](https://proxysql.com/documentation/global-variables/admin-variables/#admin-stats_credentials){:target="_blank"} variable in ProxySQL Additionally, two positional arguments can be appended to the command line flags: a service name to be used by PMM, and a service address. If not specified, they are substituted automatically as `-proxysql` and `127.0.0.1:6032`. diff --git a/documentation/docs/install-pmm/install-pmm-client/docker.md b/documentation/docs/install-pmm/install-pmm-client/docker.md index a440d1492f8..bcf5ba99dc9 100644 --- a/documentation/docs/install-pmm/install-pmm-client/docker.md +++ b/documentation/docs/install-pmm/install-pmm-client/docker.md @@ -1,6 +1,6 @@ # Run PMM Client as a Docker container -The [PMM Client Docker image](https://hub.docker.com/r/percona/pmm-client/tags/) provides a convenient way to run PMM Client as a pre-configured container without installing software directly on your host system. +The [PMM Client Docker image :octicons-link-external-16:](https://hub.docker.com/r/percona/pmm-client/tags/){:target="_blank"} provides a convenient way to run PMM Client as a pre-configured container without installing software directly on your host system. Using the Docker container approach offers several advantages: @@ -14,7 +14,7 @@ Using the Docker container approach offers several advantages: Complete these essential steps before installation: {.power-number} -1. Install [Docker Engine](https://docs.docker.com/get-docker/). +1. Install [Docker Engine :octicons-link-external-16:](https://docs.docker.com/get-docker/){:target="_blank"}. 2. Check [system requirements](prerequisites.md) to ensure your environment meets the minimum criteria. diff --git a/documentation/docs/install-pmm/install-pmm-client/package_manager.md b/documentation/docs/install-pmm/install-pmm-client/package_manager.md index 7627f950593..1050340bb75 100644 --- a/documentation/docs/install-pmm/install-pmm-client/package_manager.md +++ b/documentation/docs/install-pmm/install-pmm-client/package_manager.md @@ -62,7 +62,7 @@ Choose your preferred method to configure the Percona repositories: Download packages directly without configuring repositories: {.power-number} - 1. Visit the [PMM download page](https://www.percona.com/downloads/). + 1. Visit the [PMM download page :octicons-link-external-16:](https://www.percona.com/downloads/){:target="_blank"}. 2. Select PMM 3 and choose specific version (usually the latest). 3. Under **Select Platform**, select the item matching your software platform and architecture (x86_64 or ARM64). 4. Download the package file or copy the link and use `wget` to download it. diff --git a/documentation/docs/install-pmm/install-pmm-client/prerequisites.md b/documentation/docs/install-pmm/install-pmm-client/prerequisites.md index 73f1a83f2e2..664af949348 100644 --- a/documentation/docs/install-pmm/install-pmm-client/prerequisites.md +++ b/documentation/docs/install-pmm/install-pmm-client/prerequisites.md @@ -38,7 +38,7 @@ For a complete list of ports and detailed network configuration options, see [Ne - Ensure these packages are installed before proceeding: curl, gnupg, sudo, wget. -- For Docker-based deployment, you'll also need [Docker Engine](https://docs.docker.com/get-started/get-docker/) properly installed and configured. +- For Docker-based deployment, you'll also need [Docker Engine :octicons-link-external-16:](https://docs.docker.com/get-started/get-docker/){:target="_blank"} properly installed and configured. ## Database monitoring requirements diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/configure_aws.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/configure_aws.md index 3d122169052..abac0894d66 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/configure_aws.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/configure_aws.md @@ -122,7 +122,7 @@ By default, your EC2 instance will have a private IP for internal VPC network ac !!! note Associating a new Elastic IP to an instance with an existing Elastic IP will disassociate the old one, but it will remain allocated to your account. -For detailed information on EC2 instance IP addressing, see the [AWS documentation on using instance addressing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html). +For detailed information on EC2 instance IP addressing, see the [AWS documentation on using instance addressing :octicons-link-external-16:](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html){:target="_blank"}. ## Expand storage capacity @@ -131,7 +131,7 @@ For detailed information on EC2 instance IP addressing, see the [AWS documentati When monitoring more hosts or extending data retention, you may need additional storage space: {.power-number} -1. Increase the EBS volume size in the AWS Console following the [AWS documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modify-volume.html). +1. Increase the EBS volume size in the AWS Console following the [AWS documentation :octicons-link-external-16:](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modify-volume.html){:target="_blank"}. 2. Expand the file system to use the additional space: @@ -230,7 +230,7 @@ If the root filesystem runs low on space: ### Upgrade EC2 instance class Scale your PMM Server by upgrading to a larger instance when CPU or memory usage becomes a bottleneck. -PMM fully supports resizing EC2 instances, as long as you follow the steps outlined in the [AWS EC2 resizing guide](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html). +PMM fully supports resizing EC2 instances, as long as you follow the steps outlined in the [AWS EC2 resizing guide :octicons-link-external-16:](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-resize.html){:target="_blank"}. !!! note "Data safety" diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/deploy_aws.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/deploy_aws.md index e68d69727bf..a025f1df444 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/deploy_aws.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/deploy_aws.md @@ -6,7 +6,7 @@ After [planning your instance size, storage, and network requirements](../aws/pl To launch PMM Server via AWS Marketplace: {.power-number} -1. Go to [AWS Marketplace](https://aws.amazon.com/marketplace) and search for **Percona Monitoring and Management Server** or [access the PMM Server listing](https://aws.amazon.com/marketplace/pp/prodview-uww55ejutsnom) directly. +1. Go to [AWS Marketplace :octicons-link-external-16:](https://aws.amazon.com/marketplace){:target="_blank"} and search for **Percona Monitoring and Management Server** or [access the PMM Server listing :octicons-link-external-16:](https://aws.amazon.com/marketplace/pp/prodview-uww55ejutsnom){:target="_blank"} directly. 2. Click **View purchase options** on the PMM Server listing page, review the terms and conditions, then click **Continue to Configuration**. @@ -16,7 +16,7 @@ To launch PMM Server via AWS Marketplace: 5. In the **EC2 Instance Type** field, select an appropriate instance type based on your monitoring needs and anticipated load. For information on instance sizing and storage, see [Plan PMM Server deployment from AWS](../aws/plan_aws.md). -6. In the **VPC Settings** field, choose an existing VPC or create a new one to host your PMM Server. Ensure that the selected VPC has an [Internet Gateway](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) attached to it to be reachable over the Internet +6. In the **VPC Settings** field, choose an existing VPC or create a new one to host your PMM Server. Ensure that the selected VPC has an [Internet Gateway :octicons-link-external-16:](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html){:target="_blank"} attached to it to be reachable over the Internet 7. In the **Subnet Settings** field, select an existing subnet or create a new one within your VPC. @@ -32,7 +32,7 @@ To launch PMM Server via AWS Marketplace: Monitor the deployment progress and access your instance through the EC2 console: {.power-number} -1. Click the **EC2 Console** link that appears at the top of the confirmation page after launching, or go directly to the [EC2 Console](https://console.aws.amazon.com/ec2/) +1. Click the **EC2 Console** link that appears at the top of the confirmation page after launching, or go directly to the [EC2 Console :octicons-link-external-16:](https://console.aws.amazon.com/ec2/){:target="_blank"} 2. Locate your new PMM instance in the EC2 instances table. Initially, its Status shows **Pending** while launching and the Name will be empty. @@ -71,7 +71,7 @@ Once your instance status shows "Running" and passes all status checks in the AW After initial access, configure your PMM Server's security groups and IP addressing. ### SSH access -For SSH access instructions, see [Connecting to Your Linux Instance Using SSH](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstancesLinux.html). +For SSH access instructions, see [Connecting to Your Linux Instance Using SSH :octicons-link-external-16:](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstancesLinux.html){:target="_blank"}. Replace the user name `ec2-user` with `admin`. You can also add SSH keys later through the **PMM Configuration > Settings > SSH Key** page. @@ -82,5 +82,5 @@ With your PMM Server deployed and accessible: - [Configure PMM Server](../aws/configure_aws.md) for security and authentication - [Configure PMM Clients](../../../install-pmm-client/index.md) to start monitoring your infrastructure - [Register client nodes](../../../register-client-node/index.md) with your PMM Server -- [Improve PMM EC2 instance resilience using CloudWatch Alarm actions](https://www.percona.com/blog/2021/04/29/improving-percona-monitoring-and-management-ec2-instance-resilience-using-cloudwatch-alarm-actions/) -- [Simplify use of ENV eariables in PMM AMI](https://www.percona.com/blog/simplify-use-of-env-variables-in-percona-monitoring-and-management-ami/) \ No newline at end of file +- [Improve PMM EC2 instance resilience using CloudWatch Alarm actions :octicons-link-external-16:](https://www.percona.com/blog/2021/04/29/improving-percona-monitoring-and-management-ec2-instance-resilience-using-cloudwatch-alarm-actions/){:target="_blank"} +- [Simplify use of ENV eariables in PMM AMI :octicons-link-external-16:](https://www.percona.com/blog/simplify-use-of-env-variables-in-percona-monitoring-and-management-ami/){:target="_blank"} \ No newline at end of file diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/plan_aws.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/plan_aws.md index 10aef6baacd..91e6ce71f03 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/plan_aws.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/aws/plan_aws.md @@ -31,7 +31,7 @@ PMM Server stores all monitoring data in the `/home/admin/volume` partition. Pla - retention period for collected data - frequency of metric collection -As a reference, the [PMM Demo](https://pmmdemo.percona.com/) site consumes approximately 230 MB per host per day, which totals around 6.9 GB per host over a 30-day retention period. +As a reference, the [PMM Demo :octicons-link-external-16:](https://pmmdemo.percona.com/){:target="_blank"} site consumes approximately 230 MB per host per day, which totals around 6.9 GB per host over a 30-day retention period. For 50 hosts with 30-day retention: 50 × 6.9 GB = 345 GB minimum storage. @@ -55,7 +55,7 @@ Required ports: PMM Server software is free, but plan for AWS infrastructure costs depending on your instance size and storage needs. -Use the [AWS pricing calculator](https://calculator.aws/#/) to estimate monthly costs based on your planned configuration. +Use the [AWS pricing calculator :octicons-link-external-16:](https://calculator.aws/#/){:target="_blank"} to estimate monthly costs based on your planned configuration. ## Plan backups @@ -63,7 +63,7 @@ PMM Server uses a simple backup architecture - all monitoring data is stored in When planning your deployment, consider that you'll need to create point-in-time snapshots of the EBS volume containing the `/home/admin/volume` partition. Plan for snapshot storage costs and determine your backup frequency and retention requirements. -Follow the AWS documentation for [Create Amazon EBS snapshots](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-snapshot.html) to understand the backup process you'll implement after deployment. +Follow the AWS documentation for [Create Amazon EBS snapshots :octicons-link-external-16:](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-snapshot.html){:target="_blank"} to understand the backup process you'll implement after deployment. ## Next steps diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/easy-install.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/easy-install.md index 9758be2094b..d9329f2a742 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/easy-install.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/easy-install.md @@ -5,7 +5,7 @@ The Easy-install script provides the simplest way to deploy PMM Server with Dock ## Security best practice Before running the script: -- Download the installation script from the [official Percona domain](https://www.percona.com/get/pmm). +- Download the installation script from the [official Percona domain :octicons-link-external-16:](https://www.percona.com/get/pmm){:target="_blank"}. - Review the script content to understand its actions. @@ -48,7 +48,7 @@ Download and install PMM Server using `cURL` or `wget`: If you encounter Docker installation issues with the Easy-install script (such as `ERROR: Unsupported distribution 'rocky' on Rocky Linux`): {.power-number} - 1. [Install Docker manually](https://docs.docker.com/engine/install/) + 1. [Install Docker manually :octicons-link-external-16:](https://docs.docker.com/engine/install/){:target="_blank"} 2. Run the Easy-install script above again This two-step approach resolves most installation issues, especially on Rocky Linux where automatic installation may fail. 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 17a0316055e..c4d4b41860a 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 @@ -63,7 +63,7 @@ This gives you centralized control over resource usage, logging, and storage set ##### Essential variables -These environment variables prevent the most common deployment challenges. For all available configuration options, see [Victoria metrics command-line flags](https://docs.victoriametrics.com/#list-of-command-line-flags). +These environment variables prevent the most common deployment challenges. For all available configuration options, see [Victoria metrics command-line flags :octicons-link-external-16:](https://docs.victoriametrics.com/#list-of-command-line-flags){:target="_blank"}. | Variable | Purpose | Example | Default | Notes | 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 99c2481d134..c5e369877f4 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 @@ -2,7 +2,7 @@ Deploy PMM Server as a Docker container for a fast, flexible and isolated setup. -While PMM Server runs independently, we highly recommend that you streamline [upgrades via the PMM user interface](../../../../pmm-upgrade/ui_upgrade.md) by installing [Watchtower](https://containrrr.dev/watchtower/) alongside PMM Server. +While PMM Server runs independently, we highly recommend that you streamline [upgrades via the PMM user interface](../../../../pmm-upgrade/ui_upgrade.md) by installing [Watchtower :octicons-link-external-16:](https://containrrr.dev/watchtower/){:target="_blank"} alongside PMM Server. With Watchtower installed, you can easily update PMM Server directly from the **Upgrade** page or by clicking the **Upgrade Now** button on the **Home** dashboard. @@ -19,10 +19,10 @@ Watchtower requires access to the Docker socket to monitor and update containers To ensure a secure setup when using Watchtower: - - limit Watchtower's access to Docker network or localhost to prevent unauthorized external connections. See [Container network isolation guide](https://docs.docker.com/network/drivers/bridge/#use-user-defined-bridge-networks). - - configure network to ensure only PMM Server is exposed externally. See [Docker networking best practices](https://docs.docker.com/network/bridge/#manage-a-user-defined-bridge). - - secure Docker socket access for Watchtower. See [Docker socket security](https://docs.docker.com/engine/security/security/#docker-daemon-attack-surface). - - place both Watchtower and PMM Server on the same Docker network. See [Watchtower network configuration](https://containrrr.dev/watchtower/usage-overview/#docker_host). + - limit Watchtower's access to Docker network or localhost to prevent unauthorized external connections. See [Container network isolation guide :octicons-link-external-16:](https://docs.docker.com/network/drivers/bridge/#use-user-defined-bridge-networks){:target="_blank"}. + - configure network to ensure only PMM Server is exposed externally. See [Docker networking best practices :octicons-link-external-16:](https://docs.docker.com/network/bridge/#manage-a-user-defined-bridge){:target="_blank"}. + - secure Docker socket access for Watchtower. See [Docker socket security :octicons-link-external-16:](https://docs.docker.com/engine/security/security/#docker-daemon-attack-surface){:target="_blank"}. + - place both Watchtower and PMM Server on the same Docker network. See [Watchtower network configuration :octicons-link-external-16:](https://containrrr.dev/watchtower/usage-overview/#docker_host){:target="_blank"}. ## Installation options diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/helm/backup_container_helm.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/helm/backup_container_helm.md index 2349156da4c..9aad09fad0b 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/helm/backup_container_helm.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/helm/backup_container_helm.md @@ -10,14 +10,14 @@ Create backups of your PMM Server Kubernetes deployment to protect your monitori ## Understanding Kubernetes storage for PMM Server -PMM Server Helm chart uses [PersistentVolume and PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) to allocate storage in the Kubernetes cluster. +PMM Server Helm chart uses [PersistentVolume and PersistentVolumeClaim :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/persistent-volumes/){:target="_blank"} to allocate storage in the Kubernetes cluster. -Volumes could be pre-provisioned and dynamic. PMM chart supports both and exposes it through [PMM storage configuration](https://github.com/percona/percona-helm-charts/tree/main/charts/pmm#pmm-storage-configuration). +Volumes could be pre-provisioned and dynamic. PMM chart supports both and exposes it through [PMM storage configuration :octicons-link-external-16:](https://github.com/percona/percona-helm-charts/tree/main/charts/pmm#pmm-storage-configuration){:target="_blank"}. Backups for the PMM Server currently support only storage layer backups and thus require: - - a [StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/) that supports volume snapshots - - a [VolumeSnapshotClass](https://kubernetes.io/docs/concepts/storage/volume-snapshot-classes/) configured for your environment + - a [StorageClass :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/storage-classes/){:target="_blank"} that supports volume snapshots + - a [VolumeSnapshotClass :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/volume-snapshot-classes/){:target="_blank"} configured for your environment ## Verify snapshot support @@ -135,4 +135,4 @@ For production environments, implement a backup rotation policy: - [Restore PMM Server from backup](restore_container_helm.md) - [Upgrade PMM Server on Kubernetes](../../../../pmm-upgrade/upgrade_helm.md) -- [Configure advanced storage options](https://github.com/percona/percona-helm-charts/tree/main/charts/pmm#pmm-storage-configuration) \ No newline at end of file +- [Configure advanced storage options :octicons-link-external-16:](https://github.com/percona/percona-helm-charts/tree/main/charts/pmm#pmm-storage-configuration){:target="_blank"} \ No newline at end of file diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/helm/index.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/helm/index.md index bf3fa39027b..2c2db259fc7 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/helm/index.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/helm/index.md @@ -2,12 +2,12 @@ Deploy PMM Server on Kubernetes using Helm for scalable, orchestrated monitoring in containerized environments. -[Helm](https://github.com/helm/helm) is the package manager for Kubernetes. You can find Percona Helm charts in [our GitHub repository](https://github.com/percona/percona-helm-charts). +[Helm :octicons-link-external-16:](https://github.com/helm/helm){:target="_blank"} is the package manager for Kubernetes. You can find Percona Helm charts in [our GitHub repository :octicons-link-external-16:](https://github.com/percona/percona-helm-charts){:target="_blank"}. ## Prerequisites - - [Helm v3](https://docs.helm.sh/using_helm/#installing-helm) - - Kubernetes cluster running a [supported version](https://kubernetes.io/releases/version-skew-policy/#supported-versions) and [supported Helm](https://helm.sh/docs/topics/version_skew/) versions + - [Helm v3 :octicons-link-external-16:](https://docs.helm.sh/using_helm/#installing-helm){:target="_blank"} + - Kubernetes cluster running a [supported version :octicons-link-external-16:](https://kubernetes.io/releases/version-skew-policy/#supported-versions){:target="_blank"} and [supported Helm :octicons-link-external-16:](https://helm.sh/docs/topics/version_skew/){:target="_blank"} versions - storage driver with snapshot support (for backups) - `kubectl` configured to communicate with your cluster @@ -36,7 +36,7 @@ For optimal monitoring in production environments: - using separate Kubernetes clusters for monitoring and databases. - configuring workload separation through node configurations, affinity rules, and label selectors. -2. Enable [High Availability](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/ha-topology/) to ensure continuous monitoring during node failures. +2. Enable [High Availability :octicons-link-external-16:](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/ha-topology/){:target="_blank"} to ensure continuous monitoring during node failures. 3. Openshift considerations: @@ -171,9 +171,9 @@ Create the required Kubernetes secret and deploy PMM Server using Helm: #### View available parameters -Check the list of available parameters in the [PMM Helm chart documentation](https://github.com/percona/percona-helm-charts/tree/main/charts/pmm#parameters). You can also list the default parameters by either: +Check the list of available parameters in the [PMM Helm chart documentation :octicons-link-external-16:](https://github.com/percona/percona-helm-charts/tree/main/charts/pmm#parameters){:target="_blank"}. You can also list the default parameters by either: -- check [values.yaml file](https://github.com/percona/percona-helm-charts/blob/main/charts/pmm/values.yaml) in our repository +- check [values.yaml file :octicons-link-external-16:](https://github.com/percona/percona-helm-charts/blob/main/charts/pmm/values.yaml){:target="_blank"} in our repository - run the chart definition: `helm show values percona/pmm` #### Set configuration values @@ -229,12 +229,12 @@ To enhance security, you have two options: dhparam.pem: ``` -2. Use [Ingress controller with TLS](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls). See [PMM network configuration](https://github.com/percona/percona-helm-charts/tree/main/charts/pmm#pmm-network-configuration) for details. +2. Use [Ingress controller with TLS :octicons-link-external-16:](https://kubernetes.io/docs/concepts/services-networking/ingress/#tls){:target="_blank"}. See [PMM network configuration :octicons-link-external-16:](https://github.com/percona/percona-helm-charts/tree/main/charts/pmm#pmm-network-configuration){:target="_blank"} for details. ## Next steps - [Back up PMM Server Helm deployment](backup_container_helm.md) -- [Configure advanced Kubernetes settings](https://github.com/percona/percona-helm-charts/tree/main/charts/pmm#advanced-configuration) +- [Configure advanced Kubernetes settings :octicons-link-external-16:](https://github.com/percona/percona-helm-charts/tree/main/charts/pmm#advanced-configuration){:target="_blank"} diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/podman/index.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/podman/index.md index 09013171586..37f6c331942 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/podman/index.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/podman/index.md @@ -1,10 +1,10 @@ # Install PMM Server with Podman -Run PMM Server with Podman based on our [Docker image](https://hub.docker.com/r/percona/pmm-server) when you need enhanced security, rootless container execution, or are working in environments where Docker daemon is not preferred. Podman provides improved security isolation while maintaining compatibility with Docker commands and workflows. +Run PMM Server with Podman based on our [Docker image :octicons-link-external-16:](https://hub.docker.com/r/percona/pmm-server){:target="_blank"} when you need enhanced security, rootless container execution, or are working in environments where Docker daemon is not preferred. Podman provides improved security isolation while maintaining compatibility with Docker commands and workflows. ## About Podman -Podman is an open-source, daemonless container engine for developing, managing, and running Open Container Initiative (OCI) containers and container images on Linux systems. It is widely supported across Linux distributions and hosted on [GitHub](https://github.com/containers/podman). +Podman is an open-source, daemonless container engine for developing, managing, and running Open Container Initiative (OCI) containers and container images on Linux systems. It is widely supported across Linux distributions and hosted on [GitHub :octicons-link-external-16:](https://github.com/containers/podman){:target="_blank"}. One of Podman's advantages is that it allows non-privileged users to run containers, enhancing security by avoiding elevated permissions. Podman is compatible with Docker; by using an alias (`alias docker=podman`), you can run Docker commands seamlessly with Podman. All instructions in the Docker section apply to Podman as well. @@ -24,8 +24,8 @@ Choose Podman deployment when: Before installing PMM Server with Podman, ensure you have: {.power-number} -1. Install [Podman](https://podman.io/getting-started/installation). -2. Configure [rootless](https://github.com/containers/podman/blob/main/docs/tutorials/rootless_tutorial.md) Podman. +1. Install [Podman :octicons-link-external-16:](https://podman.io/getting-started/installation){:target="_blank"}. +2. Configure [rootless :octicons-link-external-16:](https://github.com/containers/podman/blob/main/docs/tutorials/rootless_tutorial.md){:target="_blank"} Podman. 3. Create the Podman volume for PMM: ```sh podman volume create pmm-data @@ -215,7 +215,7 @@ For information on manually upgrading, see [Upgrade PMM Server using Podman](../ ## Related topics - [Docker installation alternative](../docker/index.md) -- [Available image tags](https://hub.docker.com/r/percona/pmm-server/tags) +- [Available image tags :octicons-link-external-16:](https://hub.docker.com/r/percona/pmm-server/tags){:target="_blank"} - [Upgrade PMM Server using Podman](../../../../pmm-upgrade/upgrade_podman.md) - [Back up PMM Server Podman container](backup_container_podman.md) - [Restore PMM Server Podman container](restore_container_podman.md) diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/download_ova.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/download_ova.md index 4f1f58b40a6..dda92b6cd26 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/download_ova.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/download_ova.md @@ -17,7 +17,7 @@ The PMM Server OVA works with: To download an OVA file from the UI: {.power-number} - 1. Visit the [Percona Downloads page](https://www.percona.com/downloads) from a web browser. + 1. Visit the [Percona Downloads page :octicons-link-external-16:](https://www.percona.com/downloads){:target="_blank"} from a web browser. 2. Make sure PMM 3 is selected, then choose a PMM version and select **SERVER - VIRTUAL APPLIANCE OVF**. 3. Click the **DOWNLOAD** link for `pmm-server-{{release}}.ova` and note where your browser saves it. 4. Right-click the link for `pmm-server-{{release}}.sha256sum` and save it in the same place as the `.ova` file. diff --git a/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/vmware.md b/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/vmware.md index b8e8dfd6208..02f225d261e 100644 --- a/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/vmware.md +++ b/documentation/docs/install-pmm/install-pmm-server/deployment-options/virtual/vmware.md @@ -4,7 +4,7 @@ VMware support is deprecated as of PMM 3.4.0 and will be removed in PMM 3.6.0 (expected January 2026). [Migrate](../../../../pmm-upgrade/migrating_from_vmware.md) to VirtualBox, Docker, Podman or Kubernetes before this date. - **Need help?** Contact [Percona Support](https://www.percona.com/services/support) for migration assistance. + **Need help?** Contact [Percona Support :octicons-link-external-16:](https://www.percona.com/services/support){:target="_blank"} for migration assistance. Import the PMM Server OVA file into VMware products including ESXi, vSphere, Workstation, and Fusion to create a virtual machine for your monitoring environment. diff --git a/documentation/docs/install-pmm/plan-pmm-installation/hardware_and_system.md b/documentation/docs/install-pmm/plan-pmm-installation/hardware_and_system.md index dfc3f973970..a7042f2a07b 100644 --- a/documentation/docs/install-pmm/plan-pmm-installation/hardware_and_system.md +++ b/documentation/docs/install-pmm/plan-pmm-installation/hardware_and_system.md @@ -49,7 +49,7 @@ To reduce storage usage, consider [disable table statistics](../install-pmm-clie ### PMM Server -- **CPU**: must support the [`SSE4.2`](https://wikipedia.org/wiki/SSE4#SSE4.2), which is required for Query Analytics (QAN). +- **CPU**: must support the [`SSE4.2` :octicons-link-external-16:](https://wikipedia.org/wiki/SSE4#SSE4.2){:target="_blank"}, which is required for Query Analytics (QAN). - **ARM64**: ensure your system uses a supported ARM64 architecture (such as ARMv8 or later). PMM Server is not currently available as a native ARM64 build. For ARM-based systems, use Docker or Podman to run x86_64 images via emulation. To explicitly force Docker to use the x86_64 image on an ARM system, use: `docker run --platform linux/amd64 ... `. ### PMM Client @@ -61,7 +61,7 @@ To reduce storage usage, consider [disable table statistics](../install-pmm-clie - **Architecture support**: Compatible with both x86_64 and ARM64 architectures - **Operating systems**: Compatible with modern 64-bit Linux distributions including Debian, Ubuntu, Oracle Linux, and "Red Hat" derivatives -For specific version support details, see [Percona software support life cycle](https://www.percona.com/services/policies/percona-software-support-lifecycle#pt). +For specific version support details, see [Percona software support life cycle :octicons-link-external-16:](https://www.percona.com/services/policies/percona-software-support-lifecycle#pt){:target="_blank"}. ### ARM-specific considerations diff --git a/documentation/docs/install-pmm/plan-pmm-installation/network_and_firewall.md b/documentation/docs/install-pmm/plan-pmm-installation/network_and_firewall.md index 6721d5b7c27..d5b1328352d 100644 --- a/documentation/docs/install-pmm/plan-pmm-installation/network_and_firewall.md +++ b/documentation/docs/install-pmm/plan-pmm-installation/network_and_firewall.md @@ -54,6 +54,6 @@ Learn more about available settings for `pmm-agent` in [Percona PMM-Agent docume For computers in a locked-down corporate environment without direct access to the Internet: - - make sure to [enable access to Percona Platform services](https://docs.percona.com/percona-platform/network.html) + - make sure to [enable access to Percona Platform services :octicons-link-external-16:](https://docs.percona.com/percona-platform/network.html){:target="_blank"} - configure appropriate proxy settings if PMM Server needs to access external services through a proxy - consider using [offline installation methods](../install-pmm-server/deployment-options/docker/isolated_hosts.md) for environments without internet access diff --git a/documentation/docs/pmm-upgrade/external_postgres_pmm_upgrade.md b/documentation/docs/pmm-upgrade/external_postgres_pmm_upgrade.md index 66dd8a449cc..825c44faa1a 100644 --- a/documentation/docs/pmm-upgrade/external_postgres_pmm_upgrade.md +++ b/documentation/docs/pmm-upgrade/external_postgres_pmm_upgrade.md @@ -1,6 +1,6 @@ # Migrate external PostgreSQL configuration for PMM 3.2.0+ upgrades -If you're using an external PostgreSQL database with PMM, you will need to update your configuration before upgrading to PMM 3.2.0. This is due to a [regression issue in Grafana](https://github.com/grafana/grafana/issues/102337), where the single `GF_DATABASE_URL` environment variable is no longer sufficient for configuring the database. +If you're using an external PostgreSQL database with PMM, you will need to update your configuration before upgrading to PMM 3.2.0. This is due to a [regression issue in Grafana :octicons-link-external-16:](https://github.com/grafana/grafana/issues/102337){:target="_blank"}, where the single `GF_DATABASE_URL` environment variable is no longer sufficient for configuring the database. To upgrade to PMM 3.2.0 successfully, convert your configuration to use individual environment variables instead of `GF_DATABASE_URL`: diff --git a/documentation/docs/pmm-upgrade/upgrade_client.md b/documentation/docs/pmm-upgrade/upgrade_client.md index fd20cfeef43..40463de54e3 100644 --- a/documentation/docs/pmm-upgrade/upgrade_client.md +++ b/documentation/docs/pmm-upgrade/upgrade_client.md @@ -8,7 +8,7 @@ There are two primary methods to update PMM Clients, depending on your initial i ### 1. Package Manager method -The package manager method is generally more convenient and efficient. Percona provides the [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) package, which helps you install Percona software, including PMM Client. PMM Client is available from the `pmm-client` repository. +The package manager method is generally more convenient and efficient. Percona provides the [percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/installing.html){:target="_blank"} package, which helps you install Percona software, including PMM Client. PMM Client is available from the `pmm-client` repository. To deploy a new version of the Client via package manager, simply replace the currently installed package with the latest version of the PMM Client or with a specific version. @@ -57,7 +57,7 @@ To deploy a specific version of the PMM Client via package manager, check the av If you initially installed the PMM Client from a tarball, you can update it by replacing the currently installed package with the latest version: {.power-number} - 1. [Download](https://www.percona.com/downloads) `tar.gz` with `pmm-client`. + 1. [Download :octicons-link-external-16:](https://www.percona.com/downloads){:target="_blank"} `tar.gz` with `pmm-client`. 2. Extract the tarball. 3. Run `./install_tarball` script with the `-u` flag. diff --git a/documentation/docs/quickstart/quickstart.md b/documentation/docs/quickstart/quickstart.md index 8c952608aad..1451406348a 100644 --- a/documentation/docs/quickstart/quickstart.md +++ b/documentation/docs/quickstart/quickstart.md @@ -73,7 +73,7 @@ Once PMM is set up, choose the database or the application that you want it to m Install the following with `root` permission: { .power-number} - 1. Install the [Percona Release Tool](https://docs.percona.com/percona-software-repositories/installing.html). If this is already, make sure to update it to the latest version: + 1. Install the [Percona Release Tool :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/installing.html){:target="_blank"}. If this is already, make sure to update it to the latest version: ```sh wget https://repo.percona.com/apt/percona-release_latest.generic_all.deb @@ -97,7 +97,7 @@ Once PMM is set up, choose the database or the application that you want it to m Install the following with `root` permission: { .power-number} - 4. Install [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) tool. If this is already installed, [update percona-release](https://docs.percona.com/percona-software-repositories/updating.html) to the latest version. + 4. Install [percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/installing.html){:target="_blank"} tool. If this is already installed, [update percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/updating.html){:target="_blank"} to the latest version. ```sh yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm @@ -152,7 +152,7 @@ Once PMM is set up, choose the database or the application that you want it to m 3. Set up the `pg_stat_monitor` database extension and configure your database server accordingly. - If you need to use the `pg_stat_statements` extension instead, see [Adding a PostgreSQL database](../install-pmm/install-pmm-client/connect-database/postgresql.md) and the [`pg_stat_monitor` online documentation](https://docs.percona.com/pg-stat-monitor/configuration.html) for details about available parameters. + If you need to use the `pg_stat_statements` extension instead, see [Adding a PostgreSQL database](../install-pmm/install-pmm-client/connect-database/postgresql.md) and the [`pg_stat_monitor` online documentation :octicons-link-external-16:](https://docs.percona.com/pg-stat-monitor/configuration.html){:target="_blank"} for details about available parameters. 4. Set or change the value for `shared_preload_library` in your `postgresql.conf` file: @@ -179,7 +179,7 @@ Once PMM is set up, choose the database or the application that you want it to m Install the following with `root` permission: { .power-number} - 1. Install [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) tool. If this is already installed, [update percona-release](https://docs.percona.com/percona-software-repositories/updating.html) to the latest version: + 1. Install [percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/installing.html){:target="_blank"} tool. If this is already installed, [update percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/updating.html){:target="_blank"} to the latest version: ```sh wget https://repo.percona.com/apt/percona-release_latest.generic_all.deb @@ -203,7 +203,7 @@ Once PMM is set up, choose the database or the application that you want it to m Install the following with `root` permission: { .power-number} - 1. Install [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) tool. If this is already installed, [update percona-release](https://docs.percona.com/percona-software-repositories/updating.html) to the latest version: + 1. Install [percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/installing.html){:target="_blank"} tool. If this is already installed, [update percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/updating.html){:target="_blank"} to the latest version: ```sh yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm @@ -302,7 +302,7 @@ Once PMM is set up, choose the database or the application that you want it to m Install the following with `root` permission: - 1. Install [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) tool. If this is already installed, [update percona-release](https://docs.percona.com/percona-software-repositories/updating.html) to the latest version: + 1. Install [percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/installing.html){:target="_blank"} tool. If this is already installed, [update percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/updating.html){:target="_blank"} to the latest version: ```sh wget https://repo.percona.com/apt/percona-release_latest.generic_all.deb @@ -325,7 +325,7 @@ Once PMM is set up, choose the database or the application that you want it to m Install the following with `root` permission: - 1. Install [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) tool. If this is already installed, [update percona-release](https://docs.percona.com/percona-software-repositories/updating.html) to the latest version: + 1. Install [percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/installing.html){:target="_blank"} tool. If this is already installed, [update percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/updating.html){:target="_blank"} to the latest version: ```sh yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm @@ -360,7 +360,7 @@ Once PMM is set up, choose the database or the application that you want it to m To connect a ProxySQL service: { .power-number} - 1. Configure a read-only account for monitoring using the [`admin-stats_credentials`](https://proxysql.com/documentation/global-variables/admin-variables/#admin-stats_credentials) variable in ProxySQL. + 1. Configure a read-only account for monitoring using the [`admin-stats_credentials` :octicons-link-external-16:](https://proxysql.com/documentation/global-variables/admin-variables/#admin-stats_credentials){:target="_blank"} variable in ProxySQL. 2. To optimize server-side resources, install PMM Client via Package Manager on the database node: { .power-number} @@ -369,7 +369,7 @@ Once PMM is set up, choose the database or the application that you want it to m Install the following with `root` permission: { .power-number} - 1. Install [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) tool. If this is already installed, [update percona-release](https://docs.percona.com/percona-software-repositories/updating.html) to the latest version: + 1. Install [percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/installing.html){:target="_blank"} tool. If this is already installed, [update percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/updating.html){:target="_blank"} to the latest version: ```sh wget https://repo.percona.com/apt/percona-release_latest.generic_all.deb @@ -392,7 +392,7 @@ Once PMM is set up, choose the database or the application that you want it to m Install the following with `root` permission: { .power-number} - 1. Install [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) tool. If this is already installed, [update percona-release](https://docs.percona.com/percona-software-repositories/updating.html) to the latest version: + 1. Install [percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/installing.html){:target="_blank"} tool. If this is already installed, [update percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/updating.html){:target="_blank"} to the latest version: ```sh yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm @@ -427,7 +427,7 @@ Once PMM is set up, choose the database or the application that you want it to m To connect an HAProxy service: { .power-number} - 1. [Set up an HAproxy instance](https://www.haproxy.com/blog/haproxy-exposes-a-prometheus-metrics-endpoint). + 1. [Set up an HAproxy instance :octicons-link-external-16:](https://www.haproxy.com/blog/haproxy-exposes-a-prometheus-metrics-endpoint){:target="_blank"}. 2. Add the instance to PMM (default address is ), and use the `haproxy` alias to enable HAProxy metrics monitoring. 3. To optimize server-side resources, install PMM Client via Package Manager on the database node: @@ -435,7 +435,7 @@ Once PMM is set up, choose the database or the application that you want it to m Install the following with `root` permission: { .power-number} - 1. Install [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) tool. If this is already installed, [update percona-release](https://docs.percona.com/percona-software-repositories/updating.html) to the latest version: + 1. Install [percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/installing.html){:target="_blank"} tool. If this is already installed, [update percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/updating.html){:target="_blank"} to the latest version: ```sh wget https://repo.percona.com/apt/percona-release_latest.generic_all.deb @@ -458,7 +458,7 @@ Once PMM is set up, choose the database or the application that you want it to m Install the following with `root` permission: { .power-number} - 1. Install [percona-release](https://docs.percona.com/percona-software-repositories/installing.html) tool. If this is already installed, [update percona-release](https://docs.percona.com/percona-software-repositories/updating.html) to the latest version: + 1. Install [percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/installing.html){:target="_blank"} tool. If this is already installed, [update percona-release :octicons-link-external-16:](https://docs.percona.com/percona-software-repositories/updating.html){:target="_blank"} to the latest version: ```sh yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm diff --git a/documentation/docs/reference/copyright.md b/documentation/docs/reference/copyright.md index 7f1926afb3e..12657e50820 100644 --- a/documentation/docs/reference/copyright.md +++ b/documentation/docs/reference/copyright.md @@ -2,4 +2,4 @@ ## Documentation licensing -Percona Monitoring and Management documentation is (C)2009-2023 Percona LLC and/or its affiliates and is distributed under the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/). \ No newline at end of file +Percona Monitoring and Management documentation is (C)2009-2023 Percona LLC and/or its affiliates and is distributed under the [Creative Commons Attribution 4.0 International License :octicons-link-external-16:](https://creativecommons.org/licenses/by/4.0/){:target="_blank"}. \ No newline at end of file diff --git a/documentation/docs/reference/dashboards/dashboard-mysql-innodb-details.md b/documentation/docs/reference/dashboards/dashboard-mysql-innodb-details.md index 32307414963..1ebd4cff183 100644 --- a/documentation/docs/reference/dashboards/dashboard-mysql-innodb-details.md +++ b/documentation/docs/reference/dashboards/dashboard-mysql-innodb-details.md @@ -924,7 +924,7 @@ This is in fact the layer between the Storage Engine and MySQL. **Top Command Counters** -The `Com_{{xxx}}` statement counter variables indicate the number of times each `xxx` statement has been executed. There is one status variable for each type of statement. For example, `Com_delete` and `Com_update` count [`DELETE`](https://dev.mysql.com/doc/refman/5.7/en/delete.html) and [`UPDATE`](https://dev.mysql.com/doc/refman/5.7/en/update.html) statements, respectively. `Com_delete_multi` and `Com_update_multi` are similar but apply to [`DELETE`](https://dev.mysql.com/doc/refman/5.7/en/delete.html) and [`UPDATE`](https://dev.mysql.com/doc/refman/5.7/en/update.html) statements that use multiple-table syntax. +The `Com_{{xxx}}` statement counter variables indicate the number of times each `xxx` statement has been executed. There is one status variable for each type of statement. For example, `Com_delete` and `Com_update` count [`DELETE` :octicons-link-external-16:](https://dev.mysql.com/doc/refman/5.7/en/delete.html){:target="_blank"} and [`UPDATE` :octicons-link-external-16:](https://dev.mysql.com/doc/refman/5.7/en/update.html){:target="_blank"} statements, respectively. `Com_delete_multi` and `Com_update_multi` are similar but apply to [`DELETE` :octicons-link-external-16:](https://dev.mysql.com/doc/refman/5.7/en/delete.html){:target="_blank"} and [`UPDATE` :octicons-link-external-16:](https://dev.mysql.com/doc/refman/5.7/en/update.html){:target="_blank"} statements that use multiple-table syntax. ### MySQL Network Traffic diff --git a/documentation/docs/reference/dashboards/dashboard-mysql-instance-summary.md b/documentation/docs/reference/dashboards/dashboard-mysql-instance-summary.md index 861c70794ee..b7d14cf5b18 100644 --- a/documentation/docs/reference/dashboards/dashboard-mysql-instance-summary.md +++ b/documentation/docs/reference/dashboards/dashboard-mysql-instance-summary.md @@ -119,13 +119,13 @@ Here we can see how much network traffic is generated by MySQL per hour. You can ### Top Command Counters -The `Com_xxx` statement counter variables indicate the number of times each `xxx` statement has been executed. There is one status variable for each type of statement. For example, `Com_delete` and `Com_update` count [DELETE](https://dev.mysql.com/doc/refman/5.7/en/delete.html) and [UPDATE](https://dev.mysql.com/doc/refman/5.7/en/update.html) statements, respectively. `Com_delete_multi` and `Com_update_multi` are similar but apply to [DELETE](https://dev.mysql.com/doc/refman/5.7/en/delete.html) and [UPDATE](https://dev.mysql.com/doc/refman/5.7/en/update.html) statements that use multiple-table syntax. +The `Com_xxx` statement counter variables indicate the number of times each `xxx` statement has been executed. There is one status variable for each type of statement. For example, `Com_delete` and `Com_update` count [DELETE :octicons-link-external-16:](https://dev.mysql.com/doc/refman/5.7/en/delete.html){:target="_blank"} and [UPDATE :octicons-link-external-16:](https://dev.mysql.com/doc/refman/5.7/en/update.html){:target="_blank"} statements, respectively. `Com_delete_multi` and `Com_update_multi` are similar but apply to [DELETE :octicons-link-external-16:](https://dev.mysql.com/doc/refman/5.7/en/delete.html){:target="_blank"} and [UPDATE :octicons-link-external-16:](https://dev.mysql.com/doc/refman/5.7/en/update.html){:target="_blank"} statements that use multiple-table syntax. ## Top Command Counters Hourly ### Top Command Counters Hourly -The `Com_xxx` statement counter variables indicate the number of times each `xxx` statement has been executed. There is one status variable for each type of statement. For example, `Com_delete` and `Com_update` count [DELETE](https://dev.mysql.com/doc/refman/5.7/en/delete.html) and [UPDATE](https://dev.mysql.com/doc/refman/5.7/en/update.html) statements, respectively. `Com_delete_multi` and `Com_update_multi` are similar but apply to [DELETE](https://dev.mysql.com/doc/refman/5.7/en/delete.html) and [UPDATE](https://dev.mysql.com/doc/refman/5.7/en/update.html) statements that use multiple-table syntax. +The `Com_xxx` statement counter variables indicate the number of times each `xxx` statement has been executed. There is one status variable for each type of statement. For example, `Com_delete` and `Com_update` count [DELETE :octicons-link-external-16:](https://dev.mysql.com/doc/refman/5.7/en/delete.html){:target="_blank"} and [UPDATE :octicons-link-external-16:](https://dev.mysql.com/doc/refman/5.7/en/update.html){:target="_blank"} statements, respectively. `Com_delete_multi` and `Com_update_multi` are similar but apply to [DELETE :octicons-link-external-16:](https://dev.mysql.com/doc/refman/5.7/en/delete.html){:target="_blank"} and [UPDATE :octicons-link-external-16:](https://dev.mysql.com/doc/refman/5.7/en/update.html){:target="_blank"} statements that use multiple-table syntax. ## MySQL Handlers diff --git a/documentation/docs/reference/dashboards/dashboard-mysql-query-response-time-details.md b/documentation/docs/reference/dashboards/dashboard-mysql-query-response-time-details.md index e444db7d4c7..63ed9e6f31f 100644 --- a/documentation/docs/reference/dashboards/dashboard-mysql-query-response-time-details.md +++ b/documentation/docs/reference/dashboards/dashboard-mysql-query-response-time-details.md @@ -4,7 +4,7 @@ ## Average Query Response Time -The Average Query Response Time graph shows information collected using the Response Time Distribution plugin sourced from [table `INFORMATION_SCHEMA.QUERY_RESPONSE_TIME`](https://www.percona.com/doc/percona-server/5.7/diagnostics/response_time_distribution.html#QUERY_RESPONSE_TIME). It computes this value across all queries by taking the sum of seconds divided by the count of queries. +The Average Query Response Time graph shows information collected using the Response Time Distribution plugin sourced from [table `INFORMATION_SCHEMA.QUERY_RESPONSE_TIME` :octicons-link-external-16:](https://www.percona.com/doc/percona-server/5.7/diagnostics/response_time_distribution.html#QUERY_RESPONSE_TIME){:target="_blank"}. It computes this value across all queries by taking the sum of seconds divided by the count of queries. ## Query Response Time Distribution @@ -18,7 +18,7 @@ Query response time counts (operations) are grouped into three buckets: ## Average Query Response Time -Available only in [Percona Server for MySQL](https://www.percona.com/doc/percona-server/5.7/diagnostics/response_time_distribution.html#logging-the-queries-in-separate-read-and-write-tables), provides visibility of the split of [READ](https://www.percona.com/doc/percona-server/5.7/diagnostics/response_time_distribution.html#QUERY_RESPONSE_TIME_READ) vs [WRITE](https://www.percona.com/doc/percona-server/5.7/diagnostics/response_time_distribution.html#QUERY_RESPONSE_TIME_WRITE) query response time. +Available only in [Percona Server for MySQL :octicons-link-external-16:](https://www.percona.com/doc/percona-server/5.7/diagnostics/response_time_distribution.html#logging-the-queries-in-separate-read-and-write-tables){:target="_blank"}, provides visibility of the split of [READ :octicons-link-external-16:](https://www.percona.com/doc/percona-server/5.7/diagnostics/response_time_distribution.html#QUERY_RESPONSE_TIME_READ){:target="_blank"} vs [WRITE :octicons-link-external-16:](https://www.percona.com/doc/percona-server/5.7/diagnostics/response_time_distribution.html#QUERY_RESPONSE_TIME_WRITE){:target="_blank"} query response time. ## Read Query Response Time Distribution diff --git a/documentation/docs/reference/dashboards/dashboard-mysql-table-details.md b/documentation/docs/reference/dashboards/dashboard-mysql-table-details.md index 3e6d09e4754..094b856da55 100644 --- a/documentation/docs/reference/dashboards/dashboard-mysql-table-details.md +++ b/documentation/docs/reference/dashboards/dashboard-mysql-table-details.md @@ -20,7 +20,7 @@ Most Fragmented Tables by Freeable Size ## Table Activity -The next two graphs are available only for [Percona Server](https://www.percona.com/doc/percona-server/5.6/diagnostics/user_stats.html) and [MariaDB](https://mariadb.com/docs/server/ha-and-performance/optimization-and-tuning/query-optimizations/statistics-for-optimizing-queries/user-statistics) and require `userstat` variable turned on. +The next two graphs are available only for [Percona Server :octicons-link-external-16:](https://www.percona.com/doc/percona-server/5.6/diagnostics/user_stats.html){:target="_blank"} and [MariaDB :octicons-link-external-16:](https://mariadb.com/docs/server/ha-and-performance/optimization-and-tuning/query-optimizations/statistics-for-optimizing-queries/user-statistics){:target="_blank"} and require `userstat` variable turned on. ## Rows read diff --git a/documentation/docs/reference/dashboards/dashboard-node-summary.md b/documentation/docs/reference/dashboards/dashboard-node-summary.md index 1513e7ec11b..b70438245a9 100644 --- a/documentation/docs/reference/dashboards/dashboard-node-summary.md +++ b/documentation/docs/reference/dashboards/dashboard-node-summary.md @@ -4,7 +4,7 @@ ## System Summary -The output from ``pt-summary``, one of the [Percona Toolkit utilities](https://www.percona.com/doc/percona-toolkit/LATEST/pt-summary.html). +The output from ``pt-summary``, one of the [Percona Toolkit utilities :octicons-link-external-16:](https://www.percona.com/doc/percona-toolkit/LATEST/pt-summary.html){:target="_blank"}. ## CPU Usage diff --git a/documentation/docs/reference/dashboards/dashboard-prometheus-exporters-overview.md b/documentation/docs/reference/dashboards/dashboard-prometheus-exporters-overview.md index 6fa713078a6..dc3097a9e02 100644 --- a/documentation/docs/reference/dashboards/dashboard-prometheus-exporters-overview.md +++ b/documentation/docs/reference/dashboards/dashboard-prometheus-exporters-overview.md @@ -64,4 +64,4 @@ Virtual CPUs You can click the value of the **CPU Used**, **Memory Used**, or **Exporters Running** columns to open the [Prometheus Exporter Status](dashboard-prometheus-exporter-status.md) dashboard for further analysis. !!! seealso alert alert-info "See also" - [Percona blog: Understand Your Prometheus Exporters with Percona Monitoring and Management (PMM)](https://www.percona.com/blog/2018/02/20/understand-prometheus-exporters-percona-monitoring-management-pmm/) + [Percona blog: Understand Your Prometheus Exporters with Percona Monitoring and Management (PMM) :octicons-link-external-16:](https://www.percona.com/blog/2018/02/20/understand-prometheus-exporters-percona-monitoring-management-pmm/){:target="_blank"} diff --git a/documentation/docs/reference/dashboards/kubernetes_cluster_summary.md b/documentation/docs/reference/dashboards/kubernetes_cluster_summary.md index 916cca77c0b..83717fee520 100644 --- a/documentation/docs/reference/dashboards/kubernetes_cluster_summary.md +++ b/documentation/docs/reference/dashboards/kubernetes_cluster_summary.md @@ -10,8 +10,8 @@ - Resources - Node Status -- [Pod](https://kubernetes.io/docs/concepts/workloads/pods/) Status -- [PVC](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) status +- [Pod :octicons-link-external-16:](https://kubernetes.io/docs/concepts/workloads/pods/){:target="_blank"} Status +- [PVC :octicons-link-external-16:](https://kubernetes.io/docs/concepts/storage/persistent-volumes/){:target="_blank"} status - CPU Overview - Kubernetes Resource Count - Memory Overview and more diff --git a/documentation/docs/reference/dashboards/kubernetes_monitor_operators.md b/documentation/docs/reference/dashboards/kubernetes_monitor_operators.md index 27a9643b7ff..fecfc21191c 100644 --- a/documentation/docs/reference/dashboards/kubernetes_monitor_operators.md +++ b/documentation/docs/reference/dashboards/kubernetes_monitor_operators.md @@ -7,7 +7,7 @@ Monitoring the state of the database is crucial to timely identify and react to However, the database state also depends on the state of the Kubernetes cluster itself. Hence it’s important to have metrics that can depict the state of the Kubernetes cluster. -For information on setting up monitoring for the Kubernetes cluster health, see [documentation](https://docs.percona.com/percona-operator-for-mysql/pxc/monitor-kubernetes.html). +For information on setting up monitoring for the Kubernetes cluster health, see [documentation :octicons-link-external-16:](https://docs.percona.com/percona-operator-for-mysql/pxc/monitor-kubernetes.html){:target="_blank"}. This setup has been tested with the PMM Server as the centralized data storage and the Victoria Metrics Kubernetes monitoring stack as the metrics collector. These steps may also apply if you use another Prometheus-compatible storage. diff --git a/documentation/docs/reference/faq.md b/documentation/docs/reference/faq.md index 3e95ae9df76..003490745e6 100644 --- a/documentation/docs/reference/faq.md +++ b/documentation/docs/reference/faq.md @@ -2,8 +2,8 @@ ## How can I contact the developers? -- [Community forum](https://www.percona.com/forums/questions-discussions/percona-monitoring-and-management). -- [PMM project in JIRA](https://jira.percona.com/projects/PMM). +- [Community forum :octicons-link-external-16:](https://www.percona.com/forums/questions-discussions/percona-monitoring-and-management){:target="_blank"}. +- [PMM project in JIRA :octicons-link-external-16:](https://jira.percona.com/projects/PMM){:target="_blank"}. ## What are the minimum system requirements? @@ -34,7 +34,7 @@ PMM 3 introduces significant architectural changes that require gradual transiti If you encounter errors such as `ERROR: Unsupported distribution` when running the, follow these steps: {.power-number} -1. [Install Docker manually](https://docs.docker.com/engine/install/). +1. [Install Docker manually :octicons-link-external-16:](https://docs.docker.com/engine/install/){:target="_blank"}. 2. Run the [PMM Easy-install script](../install-pmm/install-pmm-server/deployment-options/docker/easy-install.md) again. ## Retention @@ -83,7 +83,7 @@ When you remove a monitoring service, previously collected data remains availabl ## Can I add an AWS RDS MySQL or Aurora MySQL instance from a non-default AWS partition? -By default, the RDS discovery works with the default `aws` partition. But you can switch to special regions, like the [GovCloud](https://aws.amazon.com/govcloud-us/) one, with the alternative [AWS partitions](https://docs.aws.amazon.com/sdk-for-go/api/aws/endpoints/#pkg-constants) (e.g. `aws-us-gov`) adding them to the *Settings* via the PMM Server [API](../api/index.md). +By default, the RDS discovery works with the default `aws` partition. But you can switch to special regions, like the [GovCloud :octicons-link-external-16:](https://aws.amazon.com/govcloud-us/){:target="_blank"} one, with the alternative [AWS partitions :octicons-link-external-16:](https://docs.aws.amazon.com/sdk-for-go/api/aws/endpoints/#pkg-constants){:target="_blank"} (e.g. `aws-us-gov`) adding them to the *Settings* via the PMM Server [API](../api/index.md). ![!image](../images/aws-partitions-in-api.png) @@ -112,11 +112,11 @@ For this, you must configure alerting rules that define conditions under which a Percona templated alerts enable you to create alerts based on built-in or custom templates to simplify the alert setup process. Grafana managed alerts allows attaching rules to your dashboard panel and enables you to create more sophisticated alerting rules. In addition, it can be easier to manage installations with a large number of hosts. This additional flexibility comes at the expense of simplicity. !!! seealso alert alert-info "See also" - [Grafana Alerting](https://grafana.com/docs/grafana/latest/alerting/) + [Grafana Alerting :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/alerting/){:target="_blank"} ## How do I use a custom Prometheus configuration file? -Normally, PMM Server fully manages the [Prometheus configuration file](https://prometheus.io/docs/prometheus/latest/configuration/configuration/). +Normally, PMM Server fully manages the [Prometheus configuration file :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/configuration/configuration/){:target="_blank"}. However, some users may want to change the generated configuration to add additional scrape jobs, configure remote storage, etc. @@ -126,7 +126,7 @@ The `prometheus.yml` file can be regenerated by restarting the PMM Server contai !!! seealso alert alert-info "See also" - [API](../api/index.md) - - [Percona blog: Extending PMM’s Prometheus Configuration](https://www.percona.com/blog/2020/03/23/extending-pmm-prometheus-configuration/) + - [Percona blog: Extending PMM’s Prometheus Configuration :octicons-link-external-16:](https://www.percona.com/blog/2020/03/23/extending-pmm-prometheus-configuration/){:target="_blank"} ## How to troubleshoot an upgrade? @@ -194,11 +194,11 @@ change-admin-password ## How does PMM handle personal and confidential data? -Read our [Privacy Policy](https://www.percona.com/privacy-policy) to learn how PMM manages personal and confidential data. More technical details can be found in [Data handling in PMM](personal_data_handling.md). +Read our [Privacy Policy :octicons-link-external-16:](https://www.percona.com/privacy-policy){:target="_blank"} to learn how PMM manages personal and confidential data. More technical details can be found in [Data handling in PMM](personal_data_handling.md). ## Why am I getting a "User already exists" error when logging back into PMM? -Following [CVE fix 2023-3128](https://grafana.com/blog/2023/06/22/grafana-security-release-for-cve-2023-3128/) in the 2.38 release, PMM increases security by only allowing authentications based on the unique user ID provided by the identity provider. +Following [CVE fix 2023-3128 :octicons-link-external-16:](https://grafana.com/blog/2023/06/22/grafana-security-release-for-cve-2023-3128/){:target="_blank"} in the 2.38 release, PMM increases security by only allowing authentications based on the unique user ID provided by the identity provider. If you are trying to log into PMM via a third-party authentication provider which doesn't support a unique ID field, PMM will show this error on second and subsequent authentications. diff --git a/documentation/docs/reference/glossary.md b/documentation/docs/reference/glossary.md index e30802f3797..cddcac6afd3 100644 --- a/documentation/docs/reference/glossary.md +++ b/documentation/docs/reference/glossary.md @@ -47,7 +47,7 @@ Automated checks that you can run against connected databases to identify any po ## Technical Preview -Releases intended for public preview and feedback, but with no support or service level agreement (SLA). Should not be used on production or business-critical systems. May contain breaking changes to UI, API, CLI. ([Read more](https://www.percona.com/services/policies/percona-release-lifecycle-overview).) +Releases intended for public preview and feedback, but with no support or service level agreement (SLA). Should not be used on production or business-critical systems. May contain breaking changes to UI, API, CLI. ([Read more :octicons-link-external-16:](https://www.percona.com/services/policies/percona-release-lifecycle-overview){:target="_blank"}.) ## VG diff --git a/documentation/docs/reference/index.md b/documentation/docs/reference/index.md index eb0704063c9..45bc962af13 100644 --- a/documentation/docs/reference/index.md +++ b/documentation/docs/reference/index.md @@ -51,10 +51,10 @@ PMM Server includes the following tools: - Metrics Monitor provides a historical view of metrics that are critical to a MySQL or MongoDB server instance. It includes the following: - - [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics), a scalable time-series database. - - [ClickHouse](https://clickhouse.com) is a third-party column-oriented database that facilitates the Query Analytics functionality. + - [VictoriaMetrics :octicons-link-external-16:](https://github.com/VictoriaMetrics/VictoriaMetrics){:target="_blank"}, a scalable time-series database. + - [ClickHouse :octicons-link-external-16:](https://clickhouse.com){:target="_blank"} is a third-party column-oriented database that facilitates the Query Analytics functionality. - [Grafana](http://docs.grafana.org) is a third-party dashboard and graph builder for visualizing data aggregated (by VictoriaMetrics or Prometheus) in an intuitive web interface. - - [Percona Dashboards](https://github.com/percona/grafana-dashboards) is a set of dashboards for Grafana developed by Percona. + - [Percona Dashboards :octicons-link-external-16:](https://github.com/percona/grafana-dashboards){:target="_blank"} is a set of dashboards for Grafana developed by Percona. ### PMM Client diff --git a/documentation/docs/reference/nomad.md b/documentation/docs/reference/nomad.md index cc60997f9c6..0a292ee6d23 100644 --- a/documentation/docs/reference/nomad.md +++ b/documentation/docs/reference/nomad.md @@ -2,7 +2,7 @@ Percona Monitoring and Management (PMM) includes HashiCorp Nomad to enable future extensibility and enhanced service capabilities. -[Nomad](https://www.nomadproject.io/) is a workload orchestrator designed to deploy and manage containers and non-containerized applications. In PMM, Nomad provides the underlying infrastructure to: +[Nomad :octicons-link-external-16:](https://www.nomadproject.io/){:target="_blank"} is a workload orchestrator designed to deploy and manage containers and non-containerized applications. In PMM, Nomad provides the underlying infrastructure to: - improve resource allocation across monitoring components - enable future PMM extensibility @@ -98,4 +98,4 @@ Nomad is included in PMM to support future extensibility features. Nomad will re ## Related links -- [Nomad documentation](https://developer.hashicorp.com/nomad/docs) +- [Nomad documentation :octicons-link-external-16:](https://developer.hashicorp.com/nomad/docs){:target="_blank"} diff --git a/documentation/docs/reference/personal_data_handling.md b/documentation/docs/reference/personal_data_handling.md index 2862862a1b4..2c6525e8d3f 100644 --- a/documentation/docs/reference/personal_data_handling.md +++ b/documentation/docs/reference/personal_data_handling.md @@ -22,7 +22,7 @@ The following questions are being answered related to personal and confidential 3. What is the purpose and nature of data processing? - As per our [Privacy Policy](https://www.percona.com/privacy-policy), the data collection purposes are to provide the services and product enhancements. + As per our [Privacy Policy :octicons-link-external-16:](https://www.percona.com/privacy-policy){:target="_blank"}, the data collection purposes are to provide the services and product enhancements. Although, PMM does not collect nor transfer personal data explicitly, in case query analytics is enabled and query examples collection is not disabled, we gather SQL query examples with real data and personal data may appear there if it is stored in DB. All QAN data always remains within the PMM Server, and is never transmitted anywhere else. @@ -55,5 +55,5 @@ The following questions are being answered related to personal and confidential - PMM Server to remote database (optionally, depending on user configuration) - End-user to PMM Server web interface/api (self-signed by default) - For more information about Percona security posture, please refer to our [Trust Center here](https://trust.percona.com/). + For more information about Percona security posture, please refer to our [Trust Center here :octicons-link-external-16:](https://trust.percona.com/){:target="_blank"}. diff --git a/documentation/docs/reference/pmm_components_and_versions.md b/documentation/docs/reference/pmm_components_and_versions.md index 73e19cf7262..b33bf64d040 100644 --- a/documentation/docs/reference/pmm_components_and_versions.md +++ b/documentation/docs/reference/pmm_components_and_versions.md @@ -4,18 +4,18 @@ The following table lists all the PMM client/server components and their version | PMM client/server component | Version | Documentation |Location on GitHub| |-----------------------------|----------|---------------|------------------| -| Grafana | 11.6.3* | [Grafana documentation](https://grafana.com/docs/grafana/latest/)|[Github Grafana](https://github.com/percona-platform/grafana)| -| VictoriaMetrics| 1.114.0 | [VictoriaMetrics documentation](https://docs.victoriametrics.com/)|[Github VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics) | -| Nginx | 1.20.1 | [Nginx documentation](http://nginx.org/en/docs/)|[Github Nginx](https://github.com/nginx/nginx) | -| Percona Distribution for PostgreSQL | 14.5 | [Percona Distribution for PostgreSQL 14 documentation](https://www.percona.com/doc/postgresql/LATEST/index.html)| | -| Clickhouse| 23.8.2.7 |[ClickHouse documentation](https://clickhouse.com/docs/en/)|[Github ClickHouse](https://github.com/ClickHouse/ClickHouse)| -| PerconaToolkit | 3.5.2 | [Percona Toolkit documentation](https://www.percona.com/doc/percona-toolkit/3.0/index.html)|[Github Percona Toolkit](https://github.com/percona/percona-toolkit)| -| MongoDB exporter | 0.45.0 | |[Github MongoDB Exporter](https://github.com/percona/mongodb_exporter)| -| MySQL exporter| v0.17.2* | [MySQL Server Exporter Documentation](https://grafana.com/oss/prometheus/exporters/mysql-exporter/)|[Github MySQL Server Exporter](https://github.com/percona/mysqld_exporter) | -| PostgreSQL exporter| v0.14.0* | |[Github PostgreSQL Server Exporter](https://github.com/percona/postgres_exporter) | -| RDS exporter | 0.7.2 | |[Github RDS Exporter](https://github.com/percona/rds_exporter)| -| Node exporter | v1.8.2* | [Node Exporter Documentation](https://prometheus.io/docs/guides/node-exporter/)|[Github Node Exporter](https://github.com/percona/node_exporter) | -| Azure exporter| 2.30.0* | | [Github Azure Metrics Exporter](https://github.com/percona/azure_metrics_exporter) | +| Grafana | 11.6.3* | [Grafana documentation :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/){:target="_blank"}|[Github Grafana :octicons-link-external-16:](https://github.com/percona-platform/grafana){:target="_blank"}| +| VictoriaMetrics| 1.114.0 | [VictoriaMetrics documentation :octicons-link-external-16:](https://docs.victoriametrics.com/){:target="_blank"}|[Github VictoriaMetrics :octicons-link-external-16:](https://github.com/VictoriaMetrics/VictoriaMetrics){:target="_blank"} | +| Nginx | 1.20.1 | [Nginx documentation](http://nginx.org/en/docs/)|[Github Nginx :octicons-link-external-16:](https://github.com/nginx/nginx){:target="_blank"} | +| Percona Distribution for PostgreSQL | 14.5 | [Percona Distribution for PostgreSQL 14 documentation :octicons-link-external-16:](https://www.percona.com/doc/postgresql/LATEST/index.html){:target="_blank"}| | +| Clickhouse| 23.8.2.7 |[ClickHouse documentation :octicons-link-external-16:](https://clickhouse.com/docs/en/){:target="_blank"}|[Github ClickHouse :octicons-link-external-16:](https://github.com/ClickHouse/ClickHouse){:target="_blank"}| +| PerconaToolkit | 3.5.2 | [Percona Toolkit documentation :octicons-link-external-16:](https://www.percona.com/doc/percona-toolkit/3.0/index.html){:target="_blank"}|[Github Percona Toolkit :octicons-link-external-16:](https://github.com/percona/percona-toolkit){:target="_blank"}| +| MongoDB exporter | 0.45.0 | |[Github MongoDB Exporter :octicons-link-external-16:](https://github.com/percona/mongodb_exporter){:target="_blank"}| +| MySQL exporter| v0.17.2* | [MySQL Server Exporter Documentation :octicons-link-external-16:](https://grafana.com/oss/prometheus/exporters/mysql-exporter/){:target="_blank"}|[Github MySQL Server Exporter :octicons-link-external-16:](https://github.com/percona/mysqld_exporter){:target="_blank"} | +| PostgreSQL exporter| v0.14.0* | |[Github PostgreSQL Server Exporter :octicons-link-external-16:](https://github.com/percona/postgres_exporter){:target="_blank"} | +| RDS exporter | 0.7.2 | |[Github RDS Exporter :octicons-link-external-16:](https://github.com/percona/rds_exporter){:target="_blank"}| +| Node exporter | v1.8.2* | [Node Exporter Documentation :octicons-link-external-16:](https://prometheus.io/docs/guides/node-exporter/){:target="_blank"}|[Github Node Exporter :octicons-link-external-16:](https://github.com/percona/node_exporter){:target="_blank"} | +| Azure exporter| 2.30.0* | | [Github Azure Metrics Exporter :octicons-link-external-16:](https://github.com/percona/azure_metrics_exporter){:target="_blank"} | \* - Original upstream version along with some changes authored by Percona diff --git a/documentation/docs/reference/third-party/clickhouse.md b/documentation/docs/reference/third-party/clickhouse.md index 0f49f49116f..f9a50e8fd54 100644 --- a/documentation/docs/reference/third-party/clickhouse.md +++ b/documentation/docs/reference/third-party/clickhouse.md @@ -71,8 +71,8 @@ When configuring PMM to use an external ClickHouse instance, make sure to enforc echo -n "$PASSWORD" | sha256sum | tr -d '-' ``` -For more details, see the [ClickHouse user and roles settings](https://clickhouse.com/docs/operations/settings/settings-users). +For more details, see the [ClickHouse user and roles settings :octicons-link-external-16:](https://clickhouse.com/docs/operations/settings/settings-users){:target="_blank"}. ## Troubleshooting -To troubleshoot issues, see the ClickHouse [troubleshooting documentation](https://clickhouse.com/docs/guides/troubleshooting). +To troubleshoot issues, see the ClickHouse [troubleshooting documentation :octicons-link-external-16:](https://clickhouse.com/docs/guides/troubleshooting){:target="_blank"}. diff --git a/documentation/docs/reference/third-party/postgresql.md b/documentation/docs/reference/third-party/postgresql.md index 6b4d657c2a8..a0cc31bdbb8 100644 --- a/documentation/docs/reference/third-party/postgresql.md +++ b/documentation/docs/reference/third-party/postgresql.md @@ -29,17 +29,17 @@ To use PostgreSQL as an external database instance, use the following environmen | Environment variable | Flag | Description | | ---------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| PMM_POSTGRES_ADDR | [postgres-addr](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-HOST) | Hostname and port for external PostgreSQL database. | -| PMM_POSTGRES_DBNAME | [postgres-name](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-DBNAME) | Database name for external or internal PostgreSQL database. | -| PMM_POSTGRES_USERNAME | [postgres-username](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-USER) | PostgreSQL user name to connect as. | -| PMM_POSTGRES_DBPASSWORD | [postgres-password](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-PASSWORD) | Password to be used for database authentication. | -| PMM_POSTGRES_SSL_MODE | [postgres-ssl-mode](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-SSLMODE) | This option determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the database. Currently supported: `disable`, `require`, `verify-ca`, `verify-full`. | -| PMM_POSTGRES_SSL_CA_PATH | [postgres-ssl-ca-path](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-SSLROOTCERT) | This parameter specifies the name of a file containing SSL certificate authority (CA) certificate(s). | -| PMM_POSTGRES_SSL_KEY_PATH | [postgres-ssl-key-path](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-SSLKEY) | This parameter specifies the location for the secret key used for the client certificate. | -| PMM_POSTGRES_SSL_CERT_PATH | [postgres-ssl-cert-path](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-SSLCERT) | This parameter specifies the file name of the client SSL certificate. | +| PMM_POSTGRES_ADDR | [postgres-addr :octicons-link-external-16:](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-HOST){:target="_blank"} | Hostname and port for external PostgreSQL database. | +| PMM_POSTGRES_DBNAME | [postgres-name :octicons-link-external-16:](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-DBNAME){:target="_blank"} | Database name for external or internal PostgreSQL database. | +| PMM_POSTGRES_USERNAME | [postgres-username :octicons-link-external-16:](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-USER){:target="_blank"} | PostgreSQL user name to connect as. | +| PMM_POSTGRES_DBPASSWORD | [postgres-password :octicons-link-external-16:](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-PASSWORD){:target="_blank"} | Password to be used for database authentication. | +| PMM_POSTGRES_SSL_MODE | [postgres-ssl-mode :octicons-link-external-16:](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-SSLMODE){:target="_blank"} | This option determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the database. Currently supported: `disable`, `require`, `verify-ca`, `verify-full`. | +| PMM_POSTGRES_SSL_CA_PATH | [postgres-ssl-ca-path :octicons-link-external-16:](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-SSLROOTCERT){:target="_blank"} | This parameter specifies the name of a file containing SSL certificate authority (CA) certificate(s). | +| PMM_POSTGRES_SSL_KEY_PATH | [postgres-ssl-key-path :octicons-link-external-16:](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-SSLKEY){:target="_blank"} | This parameter specifies the location for the secret key used for the client certificate. | +| PMM_POSTGRES_SSL_CERT_PATH | [postgres-ssl-cert-path :octicons-link-external-16:](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-SSLCERT){:target="_blank"} | This parameter specifies the file name of the client SSL certificate. | | PMM_DISABLE_BUILTIN_POSTGRES | | Environment variable to disable built-in PMM Server database. Note that Grafana depends on built-in PostgreSQL. And if the value of this variable is "true", then it is necessary to pass all the parameters associated with Grafana to use external PostgreSQL. | -By default, communication between the PMM Server and the database is not encrypted. To secure a connection, follow [PostgreSQL SSL instructions](https://www.postgresql.org/docs/14/ssl-tcp.html) and provide `POSTGRES_SSL_*` variables. +By default, communication between the PMM Server and the database is not encrypted. To secure a connection, follow [PostgreSQL SSL instructions :octicons-link-external-16:](https://www.postgresql.org/docs/14/ssl-tcp.html){:target="_blank"} and provide `POSTGRES_SSL_*` variables. ## Grafana database configuration When using an external PostgreSQL database with PMM, configure both PMM's components and Grafana to use the external database. diff --git a/documentation/docs/reference/third-party/victoria.md b/documentation/docs/reference/third-party/victoria.md index e962cafd540..5b1d5cb433d 100644 --- a/documentation/docs/reference/third-party/victoria.md +++ b/documentation/docs/reference/third-party/victoria.md @@ -1,6 +1,6 @@ # VictoriaMetrics -[VictoriaMetrics](https://victoriametrics.github.io/) is a third-party monitoring solution and time-series database. +[VictoriaMetrics :octicons-link-external-16:](https://victoriametrics.github.io/){:target="_blank"} is a third-party monitoring solution and time-series database. ## Push/Pull modes @@ -31,7 +31,7 @@ As a result of the move to VictoriaMetrics some direct Prometheus paths are no l ## Environment variables -PMM predefines certain flags that allow users to set all other [VictoriaMetrics parameters](https://docs.victoriametrics.com/#list-of-command-line-flags) as environment variables: +PMM predefines certain flags that allow users to set all other [VictoriaMetrics parameters :octicons-link-external-16:](https://docs.victoriametrics.com/#list-of-command-line-flags){:target="_blank"} as environment variables: The environment variable must be prepended with `VM_`. @@ -43,7 +43,7 @@ To set downsampling, use the `downsampling.period` parameter as follows: -e VM_downsampling_period=20d:10m,120d:2h ``` -This instructs VictoriaMetrics to [deduplicate](https://docs.victoriametrics.com/#deduplication) samples older than 20 days with 10 minute intervals and samples older than 120 days with two hour intervals. +This instructs VictoriaMetrics to [deduplicate :octicons-link-external-16:](https://docs.victoriametrics.com/#deduplication){:target="_blank"} samples older than 20 days with 10 minute intervals and samples older than 120 days with two hour intervals. ## Using VictoriaMetrics external database instance @@ -78,11 +78,11 @@ When external VictoriaMetrics is configured, internal VictoriaMetrics stops. In ## Troubleshooting -To troubleshoot issues, see the VictoriaMetrics [troubleshooting documentation](https://victoriametrics.github.io/#troubleshooting). +To troubleshoot issues, see the VictoriaMetrics [troubleshooting documentation :octicons-link-external-16:](https://victoriametrics.github.io/#troubleshooting){:target="_blank"}. You can also contact the VictoriaMetrics team via: -- [Google Groups](https://groups.google.com/forum/#!forum/victorametrics-users) +- [Google Groups :octicons-link-external-16:](https://groups.google.com/forum/#!forum/victorametrics-users){:target="_blank"} - [Slack](http://slack.victoriametrics.com/) -- [Reddit](https://www.reddit.com/r/VictoriaMetrics/) -- [Telegram](https://t.me/VictoriaMetrics_en) \ No newline at end of file +- [Reddit :octicons-link-external-16:](https://www.reddit.com/r/VictoriaMetrics/){:target="_blank"} +- [Telegram :octicons-link-external-16:](https://t.me/VictoriaMetrics_en){:target="_blank"} \ No newline at end of file diff --git a/documentation/docs/reference/trademark-policy.md b/documentation/docs/reference/trademark-policy.md index 431e3dcd9bd..9da6c601892 100644 --- a/documentation/docs/reference/trademark-policy.md +++ b/documentation/docs/reference/trademark-policy.md @@ -1,6 +1,6 @@ # Trademark policy -This [Trademark Policy](https://www.percona.com/trademark-policy) is to ensure that users of Percona-branded products or +This [Trademark Policy :octicons-link-external-16:](https://www.percona.com/trademark-policy){:target="_blank"} is to ensure that users of Percona-branded products or services know that what they receive has really been developed, approved, tested and maintained by Percona. Trademarks help to prevent confusion in the marketplace, by distinguishing one company’s or person’s products and services diff --git a/documentation/docs/reference/ui/ui_components.md b/documentation/docs/reference/ui/ui_components.md index 95e5da3cd27..dfd560dab1e 100644 --- a/documentation/docs/reference/ui/ui_components.md +++ b/documentation/docs/reference/ui/ui_components.md @@ -26,8 +26,8 @@ You'll find these options in the left-side menu: | :simple-mysql: | MySQL | View specialized dashboards for MySQL database performance monitoring. | | :simple-postgresql: | PostgreSQL | Access PostgreSQL-specific monitoring dashboards and metrics. | | | Query Analytics (QAN) | Analyze database queries over time, identify slow queries, optimize performance, and troubleshoot issues. | -| | Explore | Run ad-hoc queries with [PromQL](https://prometheus.io/docs/prometheus/latest/querying/basics/) to investigate specific metrics without creating dashboards. | -| | Drilldown | Run detailed analysis with specialized views for database metrics. This enables you to dive deeper into specific metrics by clicking through related data points and exploring underlying patterns. Learn more about drilling down into metrics in the [Grafana documentation](https://grafana.com/docs/grafana/latest/explore/simplified-exploration/metrics/drill-down-metrics/). | +| | Explore | Run ad-hoc queries with [PromQL :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/basics/){:target="_blank"} to investigate specific metrics without creating dashboards. | +| | Drilldown | Run detailed analysis with specialized views for database metrics. This enables you to dive deeper into specific metrics by clicking through related data points and exploring underlying patterns. Learn more about drilling down into metrics in the [Grafana documentation :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/explore/simplified-exploration/metrics/drill-down-metrics/){:target="_blank"}. | | | Backup | Configure and manage your [database backups](../../backup/index.md) and storage locations. | | | Advisors | Run health assessment checks on your databases and view recommendations for improving performance. | | | Alerting | Create and manage [alerts](../../alert/index.md) that notify you when metrics exceed thresholds. | diff --git a/documentation/docs/release-notes/3.0.0.md b/documentation/docs/release-notes/3.0.0.md index a0cc6b99be2..67b92f2b745 100644 --- a/documentation/docs/release-notes/3.0.0.md +++ b/documentation/docs/release-notes/3.0.0.md @@ -67,7 +67,7 @@ As part of the rootless deployment support, PMM 3 changes the internal ports use - "80:8080" # Map external 80 to internal 8080 ``` -For examples of configuring PMM 3 with Docker Compose, including port mappings, see [Docker deployment documentation](../install-pmm/install-pmm-server/deployment-options/docker/run_with_vol.md) and this [Percona Forum thread](https://forums.percona.com/t/install-pmm-3-using-docker-compose-and-connect-mysql-postgres-mongodb/36457). +For examples of configuring PMM 3 with Docker Compose, including port mappings, see [Docker deployment documentation](../install-pmm/install-pmm-server/deployment-options/docker/run_with_vol.md) and this [Percona Forum thread :octicons-link-external-16:](https://forums.percona.com/t/install-pmm-3-using-docker-compose-and-connect-mysql-postgres-mongodb/36457){:target="_blank"}. ### UI-based upgrades for Podman installations @@ -129,7 +129,7 @@ PMM 3 introduces a significant upgrade system overhaul, replacing the earlier me The new upgrade method moves away from RPM updates to exclusive container updates, eliminating RPM-related complications. This streamlined approach provides consistent upgrade experiences across all deployment types—Docker, Podman, and OVF/AMI. -At the same time, we're maintaining the UI upgrade option by integrating [Watchtower](https://containrrr.dev/watchtower/), an external upgrading tool. When you click the **Upgrade Now** button on the Home Dashboard, Watchtower seamlessly replaces the PMM Server container and links the new one to the existing volume, preserving all data and settings intact. +At the same time, we're maintaining the UI upgrade option by integrating [Watchtower :octicons-link-external-16:](https://containrrr.dev/watchtower/){:target="_blank"}, an external upgrading tool. When you click the **Upgrade Now** button on the Home Dashboard, Watchtower seamlessly replaces the PMM Server container and links the new one to the existing volume, preserving all data and settings intact. For easy adoption, Watchtower comes pre-configured in our [Easy-Install script](../quickstart/quickstart.md), enabling one-step PMM setup. @@ -174,13 +174,13 @@ PMM 3 now officially supports ARM architecture, upgrading from its experimental Installation follows the standard PMM Client process, with no special requirements for ARM systems. -Try out this feature and share your experience on the [PMM forum](https://forums.percona.com/c/percona-monitoring-and-management-pmm/percona-monitoring-and-management-pmm-v2/31)! +Try out this feature and share your experience on the [PMM forum :octicons-link-external-16:](https://forums.percona.com/c/percona-monitoring-and-management-pmm/percona-monitoring-and-management-pmm-v2/31){:target="_blank"}! ### Improved UX with Grafana's latest release PMM now integrates Grafana 11.1.8, which delivers the following important enhancements alongside all the advancements introduced since the previous Grafana 9.2.20 integration in PMM 2. -For the full list of Grafana changes included with this update, see [Grafana's 11.1.8 changelog](https://community.grafana.com/t/changelog-updates-in-grafana-11-1-8/134843) and [Grafana release highlights](https://grafana.com/docs/grafana/latest/whatsnew/). +For the full list of Grafana changes included with this update, see [Grafana's 11.1.8 changelog :octicons-link-external-16:](https://community.grafana.com/t/changelog-updates-in-grafana-11-1-8/134843){:target="_blank"} and [Grafana release highlights :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/whatsnew/){:target="_blank"}. #### Improved navigation @@ -232,7 +232,7 @@ You can access this dashboard at **MongoDB > High availability > Router summary* ### [Tech Preview] Support for PSMDB and Community MongoDB 8.0 -The latest version of MongoDB, along with [Percona Server for MongoDB 8.0](https://www.percona.com/software/mongodb/percona-server-for-mongodb), brings [numerous improvements and significant performance enhancements](https://www.mongodb.com/docs/manual/release-notes/8.0/). +The latest version of MongoDB, along with [Percona Server for MongoDB 8.0 :octicons-link-external-16:](https://www.percona.com/software/mongodb/percona-server-for-mongodb){:target="_blank"}, brings [numerous improvements and significant performance enhancements :octicons-link-external-16:](https://www.mongodb.com/docs/manual/release-notes/8.0/){:target="_blank"}. In this version of PMM, we are also adding support for MongoDB 8, allowing MongoDB users to monitor their new version and observe its performance impact. This includes updates to `mongodb_exporter` to accommodate PSMDB 8.0's revised metrics structure and renamed metrics (e.g., `wiredTiger.concurrentTransactions` is now `queues.execution`). @@ -266,7 +266,7 @@ By moving to EL9, we ensure that PMM is built on most recent library versions an ### Finalized DBaaS migration to Percona Everest -In previous PMM releases, the Database as a Service (DBaaS) functionality has been gradually transferred to [Percona Everest](https://www.percona.com/resources/percona-everest), an open source cloud-native database platform that solves the challenge of public cloud DBaaS vendor lock-in. +In previous PMM releases, the Database as a Service (DBaaS) functionality has been gradually transferred to [Percona Everest :octicons-link-external-16:](https://www.percona.com/resources/percona-everest){:target="_blank"}, an open source cloud-native database platform that solves the challenge of public cloud DBaaS vendor lock-in. With Percona Everest, you gain the ability to provision and oversee highly performant database clusters on the infrastructure you manage, whether it's your preferred cloud environment or on-premises. This empowerment extends to regaining control over critical aspects such as data access, database configuration, and the costs associated with cloud-based database operations. @@ -274,7 +274,7 @@ While PMM 2.x versions continue to support existing DBaaS functionality, PMM 3 m If you are an existing PMM user who relies on DBaaS functionality, we encourage you to explore Percona Everest and leverage its advanced features for database deployment. Percona Everest also integrates with PMM to provide monitoring capabilities for your database infrastructure. -To learn more about integrating Percona Everest with PMM and adding monitoring endpoints, see [Add monitoring endpoints in the Everest documentation](https://docs.percona.com/everest/use/monitor_endpoints.html). +To learn more about integrating Percona Everest with PMM and adding monitoring endpoints, see [Add monitoring endpoints in the Everest documentation :octicons-link-external-16:](https://docs.percona.com/everest/use/monitor_endpoints.html){:target="_blank"}. ### Finalized Integrated Alerting deprecation and API removal @@ -283,7 +283,7 @@ This release completes the deprecation of Integrated Alerting started in PMM 2.3 - Removed all Integrated Alerting API endpoints, including `/v1/Settings/TestEmailAlertingSettings` - Removed Integrated Alerting-related fields from the PMM Settings API (`email_alerting_settings` and `slack_alerting_settings`) -If you still have alert rules that haven't been migrated to Percona Alerting, use the [Integrated Alerting Migration Script](https://github.com/percona/pmm/blob/main/ia_migration.py) to migrate them. [Percona Alerting](../alert/index.md) provides enhanced capabilities through Grafana's alerting infrastructure and pre-configured Alert Rule Templates. +If you still have alert rules that haven't been migrated to Percona Alerting, use the [Integrated Alerting Migration Script :octicons-link-external-16:](https://github.com/percona/pmm/blob/main/ia_migration.py){:target="_blank"} to migrate them. [Percona Alerting](../alert/index.md) provides enhanced capabilities through Grafana's alerting infrastructure and pre-configured Alert Rule Templates. ### Breaking API changes @@ -295,7 +295,7 @@ This release introduces major breaking API changes: - Service, node, and agent management has been streamlined through consolidated endpoints where the resource type is specified as a top-level property in the request payload. - Low-level Inventory API sections have been removed from documentation in favor of the Management API for inventory-related tasks. -For detailed information about all these API changes and new endpoints, see the [PMM API documentation](https://percona-pmm.readme.io/v3/reference/release-notes-3-0-0). +For detailed information about all these API changes and new endpoints, see the [PMM API documentation :octicons-link-external-16:](https://percona-pmm.readme.io/v3/reference/release-notes-3-0-0){:target="_blank"}. ### New upgrade environment variables @@ -313,7 +313,7 @@ Grafana will discontinue support for Angular starting with version 12, expected We have already migrated many plugins to newer technologies and are actively working on the remaining components to ensure continued functionality. We recommend that you review all plugins in your dashboards and begin planning transitions to newer panel types where necessary. -For the full list of affected plugins and guidance on migration, see [Grafana's official documentation](https://grafana.com/docs/grafana/latest/developers/angular_deprecation/angular-plugins/) on Angular deprecation and plugin migration. +For the full list of affected plugins and guidance on migration, see [Grafana's official documentation :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/developers/angular_deprecation/angular-plugins/){:target="_blank"} on Angular deprecation and plugin migration. We will provide regular updates on our migration progress in future releases to help you prepare for this change and modernize your dashboards. @@ -329,10 +329,10 @@ We've upgraded following PMM components to their latest stable versions to enhan ## Improvements -- [PMM-13399](https://perconadev.atlassian.net/browse/PMM-13399) - PMM Client packages (DEB, RPM, and tarball) now include the Nomad binary, laying the foundation for expanded functionality in future PMM releases. +- [PMM-13399 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13399){:target="_blank"} - PMM Client packages (DEB, RPM, and tarball) now include the Nomad binary, laying the foundation for expanded functionality in future PMM releases. While the Nomad binary is now included and properly configured within the PMM Client ecosystem, Nomad agent configuration and execution capabilities will be implemented in future releases, which will unlock more capabilities for PMM. -- [PMM-13315](https://perconadev.atlassian.net/browse/PMM-13315) - To prevent node registration failures, PMM now automatically shortens service account names longer than 200 characters. For this, PMM creates a truncated name in the format `{prefix}_{hash}`, where: +- [PMM-13315 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13315){:target="_blank"} - To prevent node registration failures, PMM now automatically shortens service account names longer than 200 characters. For this, PMM creates a truncated name in the format `{prefix}_{hash}`, where: - **prefix** is a portion of the original name, providing context - **hash** is a unique identifier to avoid naming conflicts @@ -345,18 +345,18 @@ While the Nomad binary is now included and properly configured within the PMM Cl - `Copyvery_long_mysql_database_server_in_prod_4a7b3f9d`. -- [PMM-12940](https://perconadev.atlassian.net/browse/PMM-12940) - We've added automated update support for AMI/OVF deployments. The new **Updates** page also enables AMI and OVF deployments to update PMM Server directly from the UI, following the integration of the Watchtower container. +- [PMM-12940 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-12940){:target="_blank"} - We've added automated update support for AMI/OVF deployments. The new **Updates** page also enables AMI and OVF deployments to update PMM Server directly from the UI, following the integration of the Watchtower container. -- [PMM-11216](https://perconadev.atlassian.net/browse/PMM-11216) - Added ability to upgrade PMM Server between different version tags, enabling more flexible version management for Docker-based deployments. +- [PMM-11216 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-11216){:target="_blank"} - Added ability to upgrade PMM Server between different version tags, enabling more flexible version management for Docker-based deployments. ## Fixed issues -- [PMM-13122](https://perconadev.atlassian.net/browse/PMM-13122) - Fixed navigation between pages to properly maintain selected service names and timeframes when switching between different dashboards and metrics views. +- [PMM-13122 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13122){:target="_blank"} - Fixed navigation between pages to properly maintain selected service names and timeframes when switching between different dashboards and metrics views. -- [PMM-12013](https://perconadev.atlassian.net/browse/PMM-12013) - Fixed reliability and memory usage issues with RDS monitoring in large deployments by running separate RDS exporters per AWS access key. This improves metric collection stability and reduces memory consumption when monitoring multiple RDS instances. +- [PMM-12013 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-12013){:target="_blank"} - Fixed reliability and memory usage issues with RDS monitoring in large deployments by running separate RDS exporters per AWS access key. This improves metric collection stability and reduces memory consumption when monitoring multiple RDS instances. -- [PMM-13360](https://perconadev.atlassian.net/browse/PMM-13360) - Fixed an issue in the MongoDB ReplSet Summary dashboard where nodes in `down` state would sometimes disappear from the **States** panel and their version information would be removed from the MongoDB Versions panel. Nodes in `down` state now remain visible with their last known version information preserved. +- [PMM-13360 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13360){:target="_blank"} - Fixed an issue in the MongoDB ReplSet Summary dashboard where nodes in `down` state would sometimes disappear from the **States** panel and their version information would be removed from the MongoDB Versions panel. Nodes in `down` state now remain visible with their last known version information preserved. -- [PMM-13584](https://perconadev.atlassian.net/browse/PMM-13584) - Fixed an issue in the MongoDB ReplSet Summary dashboard where the bottom graphs displayed "no data" due to incorrect metric query syntax. +- [PMM-13584 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13584){:target="_blank"} - Fixed an issue in the MongoDB ReplSet Summary dashboard where the bottom graphs displayed "no data" due to incorrect metric query syntax. !!! seealso alert alert-info "Ready to install or migrate to PMM 3?" diff --git a/documentation/docs/release-notes/3.0.0_1.md b/documentation/docs/release-notes/3.0.0_1.md index be627a0d389..0b7485f6199 100644 --- a/documentation/docs/release-notes/3.0.0_1.md +++ b/documentation/docs/release-notes/3.0.0_1.md @@ -9,7 +9,7 @@ It provides tools to observe database health, analyze performance trends, troubl ## SEVERITY: CRITICAL - IMMEDIATE ACTION REQUIRED -A critical vulnerability has been identified in PMM Open Virtual Appliance (OVA) installations that enables unauthorized `root` access and potential exposure of system credentials. This vulnerability is tracked as [CVE-2025-26701](https://cve.mitre.org/cgi-bin/cvename.cgi?name=2025-26701). +A critical vulnerability has been identified in PMM Open Virtual Appliance (OVA) installations that enables unauthorized `root` access and potential exposure of system credentials. This vulnerability is tracked as [CVE-2025-26701 :octicons-link-external-16:](https://cve.mitre.org/cgi-bin/cvename.cgi?name=2025-26701){:target="_blank"}. ### Immediate actions required Your system may be exposed to unauthorized root access and credential theft. Take the following steps immediately to secure your infrastructure: @@ -52,7 +52,7 @@ This vulnerability affects ONLY OVA installations. The following deployment meth To secure your system, follow these steps to upgrade: { .power-number } - 1. Download and deploy the new OVA file from [Percona website](https://www.percona.com/downloads). + 1. Download and deploy the new OVA file from [Percona website :octicons-link-external-16:](https://www.percona.com/downloads){:target="_blank"}. 2. Log in to your system: ```sh @@ -159,9 +159,9 @@ This vulnerability affects ONLY OVA installations. The following deployment meth ### Support & additional resources If you require further clarification or assistance, we are available to assist you 24/7: - - [Technical support portal for customers](https://my.percona.com) - - [Technical support for community](https://forums.percona.com/c/percona-monitoring-and-management-pmm) - - [Security advisory announcement](https://www.percona.com/blog/security-advisory-cve-affecting-percona-monitoring-and-management-pmm/) + - [Technical support portal for customers :octicons-link-external-16:](https://my.percona.com){:target="_blank"} + - [Technical support for community :octicons-link-external-16:](https://forums.percona.com/c/percona-monitoring-and-management-pmm){:target="_blank"} + - [Security advisory announcement :octicons-link-external-16:](https://www.percona.com/blog/security-advisory-cve-affecting-percona-monitoring-and-management-pmm/){:target="_blank"} ### Upgrading from PMM 2.x? -If you are running PMM 2.38 or later, make sure to upgrade to PMM 2.44.0-1. For upgrade instructions, see the [PMM 2.44.0-1 Release Notes](https://docs.percona.com/percona-monitoring-and-management/2/release-notes/2.44.0.1.html) for specific upgrade instructions. \ No newline at end of file +If you are running PMM 2.38 or later, make sure to upgrade to PMM 2.44.0-1. For upgrade instructions, see the [PMM 2.44.0-1 Release Notes :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/2/release-notes/2.44.0.1.html){:target="_blank"} for specific upgrade instructions. \ No newline at end of file diff --git a/documentation/docs/release-notes/3.1.0.md b/documentation/docs/release-notes/3.1.0.md index 14733934e43..57d34c59672 100644 --- a/documentation/docs/release-notes/3.1.0.md +++ b/documentation/docs/release-notes/3.1.0.md @@ -133,37 +133,37 @@ For more details, see [PMM roles and permissions](../admin/roles/index.md). ## Improvements -- [PMM-12161](https://perconadev.atlassian.net/browse/PMM-12161) - MongoDB components are now properly organized in the **Cluster Summary** dashboard, replacing the confusing layout where all appeared under **Config Servers**. +- [PMM-12161 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-12161){:target="_blank"} - MongoDB components are now properly organized in the **Cluster Summary** dashboard, replacing the confusing layout where all appeared under **Config Servers**. -- [PMM-13545](https://perconadev.atlassian.net/browse/PMM-13545) - Enhanced MongoDB dashboard visualizations with improved node state detection, optimized **Top Hottest Collections** panels, better number formatting, and fixed visualization issues in the **Disk I/O** and **Network traffic** panels. +- [PMM-13545 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13545){:target="_blank"} - Enhanced MongoDB dashboard visualizations with improved node state detection, optimized **Top Hottest Collections** panels, better number formatting, and fixed visualization issues in the **Disk I/O** and **Network traffic** panels. -- [PMM-12468](https://perconadev.atlassian.net/browse/PMM-12468), [PMM-9288](https://perconadev.atlassian.net/browse/PMM-9288) - Enhanced MongoDB QAN with additional metrics, new filter categories, and the ability to identify inefficient full collection scans (COLLSCAN). +- [PMM-12468 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-12468){:target="_blank"}, [PMM-9288 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-9288){:target="_blank"} - Enhanced MongoDB QAN with additional metrics, new filter categories, and the ability to identify inefficient full collection scans (COLLSCAN). -- [PMM-12242](https://perconadev.atlassian.net/browse/PMM-12242) - Expanded alert visibility allowing Viewers to see fired alerts and Editors to manage alerts from the **Fired Alerts** page. +- [PMM-12242 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-12242){:target="_blank"} - Expanded alert visibility allowing Viewers to see fired alerts and Editors to manage alerts from the **Fired Alerts** page. -- [PMM-12356](https://perconadev.atlassian.net/browse/PMM-12356) - Enabled Editor role users to view Advisors insights while maintaining Admin-only control over running and modifying them. +- [PMM-12356 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-12356){:target="_blank"} - Enabled Editor role users to view Advisors insights while maintaining Admin-only control over running and modifying them. -- [PMM-13575](https://perconadev.atlassian.net/browse/PMM-13575) - The `mongodb_pbm_agent_status` metric in MongoDB exporter now includes a `self` label to differentiate between a PMM Client reporting its own status versus reporting status of other Clients in the cluster. +- [PMM-13575 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13575){:target="_blank"} - The `mongodb_pbm_agent_status` metric in MongoDB exporter now includes a `self` label to differentiate between a PMM Client reporting its own status versus reporting status of other Clients in the cluster. The `self` label is set to `1` when the agent is reporting about itself, and to `0` when reporting about other Clients. This helps identify more precisely which specific Client is experiencing problems without false positives on functioning nodes. -- [PMM-13718](https://perconadev.atlassian.net/browse/PMM-13718) - Improved user access control to PMM logs. The PMM logs link in the Help menu is now hidden for users without administrative privileges instead of displaying an _Access denied_ error when accessed. +- [PMM-13718 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13718){:target="_blank"} - Improved user access control to PMM logs. The PMM logs link in the Help menu is now hidden for users without administrative privileges instead of displaying an _Access denied_ error when accessed. -- [PMM-13676](https://perconadev.atlassian.net/browse/PMM-13676) - Redesigned all PMM email templates with PMM branding, replacing Grafana logos and styling. Alert emails now also include options for professional support services when needed. +- [PMM-13676 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13676){:target="_blank"} - Redesigned all PMM email templates with PMM branding, replacing Grafana logos and styling. Alert emails now also include options for professional support services when needed. -- [PMM-13374](https://perconadev.atlassian.net/browse/PMM-13374) - Improved MongoDB query fingerprint presentation in QAN to display a more detailed query structure, similar to OpsManager format. This makes query patterns easier to recognizable and improves troubleshooting for users migrating from other MongoDB monitoring tools. +- [PMM-13374 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13374){:target="_blank"} - Improved MongoDB query fingerprint presentation in QAN to display a more detailed query structure, similar to OpsManager format. This makes query patterns easier to recognizable and improves troubleshooting for users migrating from other MongoDB monitoring tools. -- [PMM-13372](https://perconadev.atlassian.net/browse/PMM-13372) - Improved MongoDB **Query Examples** presentation in QAN by removing enumeration labels. +- [PMM-13372 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13372){:target="_blank"} - Improved MongoDB **Query Examples** presentation in QAN by removing enumeration labels. ## Fixed issues -- [PMM-13770](https://perconadev.atlassian.net/browse/PMM-13770) - Corrected metric calculations to accurately capture service counts after updates to job name formatting in PMM3. The **Monitored DB services** panel on the **Home** dashboard now displays the correct number of monitored instances. -- [PMM-13769](https://perconadev.atlassian.net/browse/PMM-13769) - Resolved an issue where non-Admin users encountered an _Access denied_ error when trying to download PMM logs. The PMM logs link is now properly hidden for users without administrative privileges. -- [PMM-13715](https://perconadev.atlassian.net/browse/PMM-13715) - Fixed an issue where non-Admin users would encounter access error messages after a PMM upgrade. PMM now correctly verifies user roles before initiating configuration tasks, preventing unnecessary error messages for regular users. -- [PMM-13706](https://perconadev.atlassian.net/browse/PMM-13706) - Fixed an issue where the **Grafana status** panel on the **PMM Health** dashboard incorrectly displayed a **Down** state even when the service was running normally. -- [PMM-13698](https://perconadev.atlassian.net/browse/PMM-13698) - Fixed an issue where expanded service details under **Inventory > Services** would collapse automatically due to page reloads. Service details now remain expanded for uninterrupted review. -- [PMM-13750](https://perconadev.atlassian.net/browse/PMM-13750) - Reduced excessive error logging in PostgreSQL monitoring by skipping table extraction from truncated queries, significantly lowering log volume in busy environments. -- [PMM-13546](https://perconadev.atlassian.net/browse/PMM-13546) - Added Grafana fix for incorrect **Data source** link on the **Alerting** section. -- [PMM-13333](https://perconadev.atlassian.net/browse/PMM-13333) - Removed unnecessary **PMM Server Logs** section from the **VictoriaMetrics** dashboard as it only contained a non-functional diagnostics link. -- [PMM-12881](https://perconadev.atlassian.net/browse/PMM-12881) - PMM would display both an error notification and a misleading success notification when changing PMM settings to an invalid value. This issue has been resolved, and PMM now only shows the appropriate error message when a setting change fails. +- [PMM-13770 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13770){:target="_blank"} - Corrected metric calculations to accurately capture service counts after updates to job name formatting in PMM3. The **Monitored DB services** panel on the **Home** dashboard now displays the correct number of monitored instances. +- [PMM-13769 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13769){:target="_blank"} - Resolved an issue where non-Admin users encountered an _Access denied_ error when trying to download PMM logs. The PMM logs link is now properly hidden for users without administrative privileges. +- [PMM-13715 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13715){:target="_blank"} - Fixed an issue where non-Admin users would encounter access error messages after a PMM upgrade. PMM now correctly verifies user roles before initiating configuration tasks, preventing unnecessary error messages for regular users. +- [PMM-13706 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13706){:target="_blank"} - Fixed an issue where the **Grafana status** panel on the **PMM Health** dashboard incorrectly displayed a **Down** state even when the service was running normally. +- [PMM-13698 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13698){:target="_blank"} - Fixed an issue where expanded service details under **Inventory > Services** would collapse automatically due to page reloads. Service details now remain expanded for uninterrupted review. +- [PMM-13750 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13750){:target="_blank"} - Reduced excessive error logging in PostgreSQL monitoring by skipping table extraction from truncated queries, significantly lowering log volume in busy environments. +- [PMM-13546 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13546){:target="_blank"} - Added Grafana fix for incorrect **Data source** link on the **Alerting** section. +- [PMM-13333 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13333){:target="_blank"} - Removed unnecessary **PMM Server Logs** section from the **VictoriaMetrics** dashboard as it only contained a non-functional diagnostics link. +- [PMM-12881 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-12881){:target="_blank"} - PMM would display both an error notification and a misleading success notification when changing PMM settings to an invalid value. This issue has been resolved, and PMM now only shows the appropriate error message when a setting change fails. diff --git a/documentation/docs/release-notes/3.2.0.md b/documentation/docs/release-notes/3.2.0.md index 27285d5ccdc..97c0648e980 100644 --- a/documentation/docs/release-notes/3.2.0.md +++ b/documentation/docs/release-notes/3.2.0.md @@ -31,22 +31,22 @@ This means that PMM can now provide complete replication monitoring across all s ### Grafana 11.6 update and upgrade path for external PostgreSQL users -PMM now ships with [Grafana 11.6](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-6/), which delivers enhanced visualization capabilities, a more efficient alerting workflow, and a wide range of improvements: +PMM now ships with [Grafana 11.6 :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-6/){:target="_blank"}, which delivers enhanced visualization capabilities, a more efficient alerting workflow, and a wide range of improvements: -- [Alert state history](https://grafana.com/docs/grafana/latest/alerting/monitor-status/view-alert-state-history/) for reviewing historical changes in alert statuses over time. Full functionality requires [Grafana Loki](https://grafana.com/oss/loki/) for log aggregation and [specific Grafana configuration](https://grafana.com/docs/grafana/latest/alerting/monitor-status/view-alert-state-history/) to enable centralized tracking and storage. -- Improved panel features and [actions visualization](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-3/#actions-for-visualizations) for better dashboard interactivity -- [Simplified alert creation](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-3/#simplified-query-section-for-alert-rule-creation) with improved UI workflows -- [Recording rules](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-3/#recording-rules-for-grafana-managed-alerts) for creating pre-computed metrics to optimize dashboard performance +- [Alert state history :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/alerting/monitor-status/view-alert-state-history/){:target="_blank"} for reviewing historical changes in alert statuses over time. Full functionality requires [Grafana Loki :octicons-link-external-16:](https://grafana.com/oss/loki/){:target="_blank"} for log aggregation and [specific Grafana configuration :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/alerting/monitor-status/view-alert-state-history/){:target="_blank"} to enable centralized tracking and storage. +- Improved panel features and [actions visualization :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-3/#actions-for-visualizations){:target="_blank"} for better dashboard interactivity +- [Simplified alert creation :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-3/#simplified-query-section-for-alert-rule-creation){:target="_blank"} with improved UI workflows +- [Recording rules :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-3/#recording-rules-for-grafana-managed-alerts){:target="_blank"} for creating pre-computed metrics to optimize dashboard performance Dashboard improvements: -- [Navigation bookmarks](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-2/#navigation-bookmarks) for quick access to frequently used dashboards -- [State timeline supports pagination](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-2/#state-timeline-supports-pagination) for better performance with large datasets -- [Centralized alert history page](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-2/#centralized-alert-history-page) for managing all alert rules -- Improved [Grafana Scenes](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-3/#scenes-powered-dashboards-are-generally-available) support for modern dashboard architecture +- [Navigation bookmarks :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-2/#navigation-bookmarks){:target="_blank"} for quick access to frequently used dashboards +- [State timeline supports pagination :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-2/#state-timeline-supports-pagination){:target="_blank"} for better performance with large datasets +- [Centralized alert history page :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-2/#centralized-alert-history-page){:target="_blank"} for managing all alert rules +- Improved [Grafana Scenes :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/whatsnew/whats-new-in-v11-3/#scenes-powered-dashboards-are-generally-available){:target="_blank"} support for modern dashboard architecture !!! warning "Upgrading to PMM 3.2.0 with an external PostgreSQL database" - If you're using an external PostgreSQL database, make sure to update your PMM Server configuration before upgrading to PMM 3.2.0. This is because Grafana 11.6 has a [regression issue](https://github.com/grafana/grafana/issues/102337) where the `GF_DATABASE_URL` environment variable is no longer sufficient for database configuration. See [Migrate External PostgreSQL Configuration for PMM 3.2.0+](../pmm-upgrade/external_postgres_pmm_upgrade.md) for step-by-step instructions. + If you're using an external PostgreSQL database, make sure to update your PMM Server configuration before upgrading to PMM 3.2.0. This is because Grafana 11.6 has a [regression issue :octicons-link-external-16:](https://github.com/grafana/grafana/issues/102337){:target="_blank"} where the `GF_DATABASE_URL` environment variable is no longer sufficient for database configuration. See [Migrate External PostgreSQL Configuration for PMM 3.2.0+](../pmm-upgrade/external_postgres_pmm_upgrade.md) for step-by-step instructions. ### Secure external ClickHouse connections PMM now supports connecting to external ClickHouse servers using authenticated credentials. @@ -82,7 +82,7 @@ We've optimized QAN filter loading performance to reduce the number of processed ### Nomad integration for future extensibility -We've integrated [HashiCorp Nomad](https://developer.hashicorp.com/nomad) into PMM to lay the groundwork for future feature development. This workload orchestrator will initially manage monitoring agents to improve service delivery for Percona customers. +We've integrated [HashiCorp Nomad :octicons-link-external-16:](https://developer.hashicorp.com/nomad){:target="_blank"} into PMM to lay the groundwork for future feature development. This workload orchestrator will initially manage monitoring agents to improve service delivery for Percona customers. If you are an advanced user, you can access the Nomad API (internal port `4646`) through the standard PMM HTTPS port by appending `/nomad` to your PMM Server URL. The full API path is `https:///nomad/v1/`. You must have Administrator rights to access this endpoint. @@ -91,67 +91,67 @@ Nomad is disabled by default. Even though it increases the overall Docker image ## Improvements -- [PMM-13453](https://perconadev.atlassian.net/browse/PMM-13453) - Improved how PMM checks for updates. Automatic checks now use cached information to reduce system load, while clicking **Check for updates** on the **Updates** page performs a thorough check for the latest versions. +- [PMM-13453 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13453){:target="_blank"} - Improved how PMM checks for updates. Automatic checks now use cached information to reduce system load, while clicking **Check for updates** on the **Updates** page performs a thorough check for the latest versions. This ensures you get the most accurate information when explicitly checking for updates, while improving overall system performance. -- [PMM-13644](https://perconadev.atlassian.net/browse/PMM-13644) - Added a default 30-day retention policy for ClickHouse system log tables (`trace_log`, `metric_log`, `query_log`). This default policy keeps recent logs readily available for troubleshooting but prevents potential ClickHouse performance issues that excessive log data could cause. +- [PMM-13644 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13644){:target="_blank"} - Added a default 30-day retention policy for ClickHouse system log tables (`trace_log`, `metric_log`, `query_log`). This default policy keeps recent logs readily available for troubleshooting but prevents potential ClickHouse performance issues that excessive log data could cause. You can customize the retention by updating the Time-To-Live (TTL) expression (`event_date + INTERVAL X DAY DELETE`) in the ClickHouse configuration. -- [PMM-13869](https://perconadev.atlassian.net/browse/PMM-13869) - PMM now outputs Nginx access logs in LOGFMT format, ensuring consistency across all PMM components. This also improves compatibility with log analysis tools like Loki and VictoriaLogs, which means you can analyze logs directly without reformatting or manual parsing. +- [PMM-13869 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13869){:target="_blank"} - PMM now outputs Nginx access logs in LOGFMT format, ensuring consistency across all PMM components. This also improves compatibility with log analysis tools like Loki and VictoriaLogs, which means you can analyze logs directly without reformatting or manual parsing. -- [PMM-13171](https://perconadev.atlassian.net/browse/PMM-13171) - Added support for connecting to external ClickHouse databases with custom user credentials using the `PMM_CLICKHOUSE_USER` and `PMM_CLICKHOUSE_PASSWORD` environment variables. +- [PMM-13171 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13171){:target="_blank"} - Added support for connecting to external ClickHouse databases with custom user credentials using the `PMM_CLICKHOUSE_USER` and `PMM_CLICKHOUSE_PASSWORD` environment variables. -- [PMM-13752](https://perconadev.atlassian.net/browse/PMM-13752) - Introduced a new **PBM Details** dashboard for MongoDB backups for backup operations monitoring directly within PMM. +- [PMM-13752 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13752){:target="_blank"} - Introduced a new **PBM Details** dashboard for MongoDB backups for backup operations monitoring directly within PMM. -- [PMM-13785](https://perconadev.atlassian.net/browse/PMM-13785) - You can now install PMM Client on Amazon Linux 2023 environments using official RPM packages, so you don't need to use tarball-based workarounds. +- [PMM-13785 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13785){:target="_blank"} - You can now install PMM Client on Amazon Linux 2023 environments using official RPM packages, so you don't need to use tarball-based workarounds. -- [PMM-13406](https://perconadev.atlassian.net/browse/PMM-13406) - Integrated HashiCorp Nomad into PMM to enable future extensibility. +- [PMM-13406 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13406){:target="_blank"} - Integrated HashiCorp Nomad into PMM to enable future extensibility. -- [PMM-13939](https://perconadev.atlassian.net/browse/PMM-13939) - Improved the performance of a frequently used query in QAN by optimizing the number of rows fetched from the database. This change reduces the time it takes to display QAN filters, resulting in a smoother user experience. +- [PMM-13939 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13939){:target="_blank"} - Improved the performance of a frequently used query in QAN by optimizing the number of rows fetched from the database. This change reduces the time it takes to display QAN filters, resulting in a smoother user experience. -- [PMM-13824](https://perconadev.atlassian.net/browse/PMM-13824) - Updated **MongoDB Replicaset summary dashboard** and **MongoDB Sharded cluster summary** dashboard with a new panel to show the current Feature Compatibility Version. We've also added panels to show **Nodes**, **Databases count** and **Last election time**. +- [PMM-13824 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13824){:target="_blank"} - Updated **MongoDB Replicaset summary dashboard** and **MongoDB Sharded cluster summary** dashboard with a new panel to show the current Feature Compatibility Version. We've also added panels to show **Nodes**, **Databases count** and **Last election time**. -- [PMM-13832](https://perconadev.atlassian.net/browse/PMM-13832) - We've revised the [PMM installation documentation](https://docs.percona.com/percona-monitoring-and-management/3/install-pmm/index.html) to enhance technical accuracy, clarity, and usability. As we continue to refine the topics in this chapter, we welcome your feedback to help us make the documentation even better. +- [PMM-13832 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13832){:target="_blank"} - We've revised the [PMM installation documentation :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/3/install-pmm/index.html){:target="_blank"} to enhance technical accuracy, clarity, and usability. As we continue to refine the topics in this chapter, we welcome your feedback to help us make the documentation even better. ## Components upgrade -- [PMM-13463](https://perconadev.atlassian.net/browse/PMM-13463) - PMM now ships with Grafana 11.6, bringing a suite of enhancements to visualization, alerting, and dashboard interactivity. +- [PMM-13463 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13463){:target="_blank"} - PMM now ships with Grafana 11.6, bringing a suite of enhancements to visualization, alerting, and dashboard interactivity. -- [PMM-13210](https://perconadev.atlassian.net/browse/PMM-13210) - Upgraded VictoriaMetrics to version 1.114.0. This version includes key upstream improvements and fixes, ensuring more reliable metric collection, storage, and faster data access in PMM. +- [PMM-13210 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13210){:target="_blank"} - Upgraded VictoriaMetrics to version 1.114.0. This version includes key upstream improvements and fixes, ensuring more reliable metric collection, storage, and faster data access in PMM. -- [PMM-12153](https://perconadev.atlassian.net/browse/PMM-12153) - We've upgraded `mysqld_exporter` to the latest stable version (v0.17.2), bringing you the newest features and critical fixes for enhanced MySQL metric collection and also ensuring compatibility with the latest upstream advancements. +- [PMM-12153 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-12153){:target="_blank"} - We've upgraded `mysqld_exporter` to the latest stable version (v0.17.2), bringing you the newest features and critical fixes for enhanced MySQL metric collection and also ensuring compatibility with the latest upstream advancements. ## Fixed issues -- [PMM-13139](https://perconadev.atlassian.net/browse/PMM-13139) - Fixed an issue in the [ProxySQL Instance Summary dashboard](../reference/dashboards/dashboard-proxysql-instance-summary.md) where panels were not correctly filtered by the selected ProxySQL instance. Panels like **Executed queries**, **Queries execution time**, and **Queries Latency** now accurately display data specific to the chosen ProxySQL instance. We've also added a **Hostgroup** filter for a more granular analysis. +- [PMM-13139 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13139){:target="_blank"} - Fixed an issue in the [ProxySQL Instance Summary dashboard](../reference/dashboards/dashboard-proxysql-instance-summary.md) where panels were not correctly filtered by the selected ProxySQL instance. Panels like **Executed queries**, **Queries execution time**, and **Queries Latency** now accurately display data specific to the chosen ProxySQL instance. We've also added a **Hostgroup** filter for a more granular analysis. -- [PMM-13766](https://perconadev.atlassian.net/browse/PMM-13766) - Fixed a security issue where TLS certificates and private keys were not being deleted from PMM Client's temporary directories after removing the service. PMM now properly cleans up security-sensitive file when you remove services. +- [PMM-13766 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13766){:target="_blank"} - Fixed a security issue where TLS certificates and private keys were not being deleted from PMM Client's temporary directories after removing the service. PMM now properly cleans up security-sensitive file when you remove services. -- [PMM-13958](https://perconadev.atlassian.net/browse/PMM-13958) - Fixed an issue where PMM Server would ignore the `PMM_POSTGRES_*` environment variables and start the internal PostgreSQL instance even when `PMM_DISABLE_BUILTIN_POSTGRES=1` was set. PMM now correctly detects external PostgreSQL settings, and no longer waits for the internal database to start when external settings are available. +- [PMM-13958 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13958){:target="_blank"} - Fixed an issue where PMM Server would ignore the `PMM_POSTGRES_*` environment variables and start the internal PostgreSQL instance even when `PMM_DISABLE_BUILTIN_POSTGRES=1` was set. PMM now correctly detects external PostgreSQL settings, and no longer waits for the internal database to start when external settings are available. -- [PMM-13780](https://perconadev.atlassian.net/browse/PMM-13780) - Fixed an issue in the SQL query that prevented group replication metrics from being collected. The **MySQL Group Replication Summary** dashboard now properly displays transaction and conflict metrics for MySQL 8.0 and 8.4 environments. +- [PMM-13780 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13780){:target="_blank"} - Fixed an issue in the SQL query that prevented group replication metrics from being collected. The **MySQL Group Replication Summary** dashboard now properly displays transaction and conflict metrics for MySQL 8.0 and 8.4 environments. -- [PMM-13635](https://perconadev.atlassian.net/browse/PMM-13635) - Fixed calculation issues in the **MongoDB Collections Overview** dashboard that previously resulted in empty or incorrect data displays. The dashboard now properly handles filter selections and displays accurate metrics. +- [PMM-13635 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13635){:target="_blank"} - Fixed calculation issues in the **MongoDB Collections Overview** dashboard that previously resulted in empty or incorrect data displays. The dashboard now properly handles filter selections and displays accurate metrics. These fixes also improve the **Top 5 Databases by Size** panel, which now accurately reflects database sizes when filtering by specific MongoDB nodes or replica sets. -- [PMM-13694](https://perconadev.atlassian.net/browse/PMM-13694) - Fixed an issue where PostgreSQL QPS calculations were incorrect in QAN when using non-default `pg_stat_statements.max` values greater than `5000`. +- [PMM-13694 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13694){:target="_blank"} - Fixed an issue where PostgreSQL QPS calculations were incorrect in QAN when using non-default `pg_stat_statements.max` values greater than `5000`. -- [PMM-13956](https://perconadev.atlassian.net/browse/PMM-13956) - The ProxySQL exporter would incorrectly transition to a `Done` status instead of `Running` after being added for monitoring. This prevented the exporter from collecting metrics from ProxySQL instances, which meant that PMM could not track ProxySQL performance accurately. This issue is now fixed. +- [PMM-13956 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13956){:target="_blank"} - The ProxySQL exporter would incorrectly transition to a `Done` status instead of `Running` after being added for monitoring. This prevented the exporter from collecting metrics from ProxySQL instances, which meant that PMM could not track ProxySQL performance accurately. This issue is now fixed. -- [PMM-13909](https://perconadev.atlassian.net/browse/PMM-13909) - Fixed an issue where the **Services** list under **PMM Inventory** would automatically reset to page 1 while browsing other pages. You can now navigate through multiple pages of services without unexpected page resets. +- [PMM-13909 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13909){:target="_blank"} - Fixed an issue where the **Services** list under **PMM Inventory** would automatically reset to page 1 while browsing other pages. You can now navigate through multiple pages of services without unexpected page resets. -- [PMM-13897](https://perconadev.atlassian.net/browse/PMM-13897) - Fixed an issue in QAN where selecting MongoDB **Plan Summary** filters containing bracketed expressions (such as `EXPRESS_IXSCAN { id: 1 }`) would trigger internal server errors. PMM can now handle special characters in filter values, regardless of their syntax complexity. +- [PMM-13897 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13897){:target="_blank"} - Fixed an issue in QAN where selecting MongoDB **Plan Summary** filters containing bracketed expressions (such as `EXPRESS_IXSCAN { id: 1 }`) would trigger internal server errors. PMM can now handle special characters in filter values, regardless of their syntax complexity. -- [PMM-13807](https://perconadev.atlassian.net/browse/PMM-13807) - `pmm-agent` would crash when processing MySQL slow-log entries containing queries with a column named **Value**. This is now fixed and PMM can now properly monitor all SQL queries, regardless of column naming. +- [PMM-13807 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13807){:target="_blank"} - `pmm-agent` would crash when processing MySQL slow-log entries containing queries with a column named **Value**. This is now fixed and PMM can now properly monitor all SQL queries, regardless of column naming. -- [PMM-13757](https://perconadev.atlassian.net/browse/PMM-13757) - Fixed an issue where MySQL query fingerprints sometimes incorrectly showed the execution time limit number (from `/*+ MAX_EXECUTION_TIME() */`) instead of a `?`. These numbers are now always replaced with `?` for consistent query analysis. +- [PMM-13757 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13757){:target="_blank"} - Fixed an issue where MySQL query fingerprints sometimes incorrectly showed the execution time limit number (from `/*+ MAX_EXECUTION_TIME() */`) instead of a `?`. These numbers are now always replaced with `?` for consistent query analysis. -- [PMM-13966](https://perconadev.atlassian.net/browse/PMM-13966) - Checking the **Explain** plan in QAN for queries that themselves contained the `EXPLAIN` keyword would result in an error: *invalid GetActionRequest.ActionId: value length must be at least 1 runes*. PMM now detects this scenario and clearly informs you that running EXPLAIN on such queries isn't supported. +- [PMM-13966 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13966){:target="_blank"} - Checking the **Explain** plan in QAN for queries that themselves contained the `EXPLAIN` keyword would result in an error: *invalid GetActionRequest.ActionId: value length must be at least 1 runes*. PMM now detects this scenario and clearly informs you that running EXPLAIN on such queries isn't supported. -- [PMM-13968](https://perconadev.atlassian.net/browse/PMM-13968) - Fixed a bug in QAN with MySQL Performance Schema where the same query run on different databases was only counted in one. Now, QAN correctly tracks these queries separately for each database. +- [PMM-13968 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13968){:target="_blank"} - Fixed a bug in QAN with MySQL Performance Schema where the same query run on different databases was only counted in one. Now, QAN correctly tracks these queries separately for each database. diff --git a/documentation/docs/release-notes/3.3.0.md b/documentation/docs/release-notes/3.3.0.md index 94e4fa6f742..3cf0e7336d4 100644 --- a/documentation/docs/release-notes/3.3.0.md +++ b/documentation/docs/release-notes/3.3.0.md @@ -67,7 +67,7 @@ To enable mongolog, add `--query-source=mongolog` when registering MongoDB servi ### PMM 3.3.0 available on AWS Marketplace -PMM 3.3.0 is now available for deployment through the [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-uww55ejutsnom?sr=0-1&ref_=beagle&applicationId=AWSMPContessa), making it easier to deploy Percona Monitoring and Management in your AWS environment. With AWS Marketplace you get: +PMM 3.3.0 is now available for deployment through the [AWS Marketplace :octicons-link-external-16:](https://aws.amazon.com/marketplace/pp/prodview-uww55ejutsnom?sr=0-1&ref_=beagle&applicationId=AWSMPContessa){:target="_blank"}, making it easier to deploy Percona Monitoring and Management in your AWS environment. With AWS Marketplace you get: - preconfigured AMI with optimized settings - simple hourly pricing plus standard EC2 costs @@ -88,22 +88,22 @@ Existing installations on Ubuntu 20.04 will continue to work but we will not rel ## Improvements -- [PMM-13970](https://perconadev.atlassian.net/browse/PMM-13970) - Added `--tls-skip-verify` flag for `pmm-admin add external`, `pmm-admin add external-serverless`, and `pmm-admin add haproxy` commands. This flag skips TLS certificate validation, enabling you to monitor services with self-signed certificates or IP-based endpoints that lack proper certificate SANs, including PostgreSQL Operator deployments with HAProxy. -- [PMM-14000](https://perconadev.atlassian.net/browse/PMM-14000), [PMM-13861](https://perconadev.atlassian.net/browse/PMM-13861), [PMM-13862](https://perconadev.atlassian.net/browse/PMM-13862), [PMM-13863](https://perconadev.atlassian.net/browse/PMM-13863), [PMM-13864](https://perconadev.atlassian.net/browse/PMM-13864), [PMM-13865](https://perconadev.atlassian.net/browse/PMM-13865), [PMM-13866](https://perconadev.atlassian.net/browse/PMM-13866), [PMM-13867](https://perconadev.atlassian.net/browse/PMM-13867), [PMM-13868](https://perconadev.atlassian.net/browse/PMM-13868) - Enhanced PostgreSQL monitoring with five new dashboards, improved existing dashboards, custom query support for specialized metrics, and a redesigned menu structure for better navigation. -- [PMM-12548](https://perconadev.atlassian.net/browse/PMM-12548) - Added `mongolog` query source for MongoDB that reads slow query logs from disk, eliminating connection pool exhaustion in environments with 100+ databases. -- [PMM-13596](https://perconadev.atlassian.net/browse/PMM-13596) - Improved access control for PMM Dump and PMM Logs by hiding these menu options for users without appropriate permissions. Non-admin users no longer see inaccessible links in the Help menu, preventing confusing 401 error messages. -- [PMM-14059](https://perconadev.atlassian.net/browse/PMM-14059) - Improved the **Mongos Routers** graph in the **MongoDB Sharded Cluster Summary** dashboard to display individual router nodes with their status in hexagon format, providing consistency with **Config Servers** and shard displays instead of showing only a generic **OK** status. -- [PMM-13786](https://perconadev.atlassian.net/browse/PMM-13786) - Upgraded PMM OVF specification to OVF 2.0 format for enhanced security (SHA256 hashing), better virtual hardware support, and improved cloud compatibility. -- [PMM-13821](https://perconadev.atlassian.net/browse/PMM-13821) - Upgraded Go runtime to version 1.24.x for enhanced performance. This update includes the latest CVE fixes and improvements to maintain PMM's security. +- [PMM-13970 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13970){:target="_blank"} - Added `--tls-skip-verify` flag for `pmm-admin add external`, `pmm-admin add external-serverless`, and `pmm-admin add haproxy` commands. This flag skips TLS certificate validation, enabling you to monitor services with self-signed certificates or IP-based endpoints that lack proper certificate SANs, including PostgreSQL Operator deployments with HAProxy. +- [PMM-14000 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14000){:target="_blank"}, [PMM-13861 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13861){:target="_blank"}, [PMM-13862 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13862){:target="_blank"}, [PMM-13863 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13863){:target="_blank"}, [PMM-13864 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13864){:target="_blank"}, [PMM-13865 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13865){:target="_blank"}, [PMM-13866 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13866){:target="_blank"}, [PMM-13867 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13867){:target="_blank"}, [PMM-13868 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13868){:target="_blank"} - Enhanced PostgreSQL monitoring with five new dashboards, improved existing dashboards, custom query support for specialized metrics, and a redesigned menu structure for better navigation. +- [PMM-12548 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-12548){:target="_blank"} - Added `mongolog` query source for MongoDB that reads slow query logs from disk, eliminating connection pool exhaustion in environments with 100+ databases. +- [PMM-13596 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13596){:target="_blank"} - Improved access control for PMM Dump and PMM Logs by hiding these menu options for users without appropriate permissions. Non-admin users no longer see inaccessible links in the Help menu, preventing confusing 401 error messages. +- [PMM-14059 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14059){:target="_blank"} - Improved the **Mongos Routers** graph in the **MongoDB Sharded Cluster Summary** dashboard to display individual router nodes with their status in hexagon format, providing consistency with **Config Servers** and shard displays instead of showing only a generic **OK** status. +- [PMM-13786 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13786){:target="_blank"} - Upgraded PMM OVF specification to OVF 2.0 format for enhanced security (SHA256 hashing), better virtual hardware support, and improved cloud compatibility. +- [PMM-13821 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13821){:target="_blank"} - Upgraded Go runtime to version 1.24.x for enhanced performance. This update includes the latest CVE fixes and improvements to maintain PMM's security. ## Fixed issues -- [PMM-14070](https://perconadev.atlassian.net/browse/PMM-14070) - The **Top 5 Databases By Size** chart was not displaying data due to an incorrect query configuration. The chart now correctly shows database size information. -- [PMM-14066](https://perconadev.atlassian.net/browse/PMM-14066) - Fixed an issue where MySQL services were not collecting metrics when database passwords contained special characters (such as `#`), which caused connection failures and prevented MySQL metrics from appearing in dashboards. -- [PMM-14047](https://perconadev.atlassian.net/browse/PMM-14047) - Fixed an issue in the **MongoDB Sharded Cluster Summary** dashboard where you could not select MongoDB clusters when other database types (such as Percona Server clusters) were also monitored by the same PMM instance. You can now select MongoDB sharded clusters regardless of what other database clusters are monitored by PMM. -- [PMM-13794](https://perconadev.atlassian.net/browse/PMM-13794) - Fixed an issue in HA deployments where the `/v1/server/leaderHealthCheck` endpoint would cause server crashes with *"invalid memory address"* errors. The health check endpoint now works correctly, preventing HAProxy health check failures. -- [PMM-13963](https://perconadev.atlassian.net/browse/PMM-13963) - Clicking the **Explain** tab in the Query Analytics dashboard made the PMM unresponsive for Percona Server instances. This issue is now fixed. -- [PMM-13881](https://perconadev.atlassian.net/browse/PMM-13881) - The mongodb_exporter would displayed the wrong version number when queried with `--version`. This issue is now fixed. +- [PMM-14070 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14070){:target="_blank"} - The **Top 5 Databases By Size** chart was not displaying data due to an incorrect query configuration. The chart now correctly shows database size information. +- [PMM-14066 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14066){:target="_blank"} - Fixed an issue where MySQL services were not collecting metrics when database passwords contained special characters (such as `#`), which caused connection failures and prevented MySQL metrics from appearing in dashboards. +- [PMM-14047 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14047){:target="_blank"} - Fixed an issue in the **MongoDB Sharded Cluster Summary** dashboard where you could not select MongoDB clusters when other database types (such as Percona Server clusters) were also monitored by the same PMM instance. You can now select MongoDB sharded clusters regardless of what other database clusters are monitored by PMM. +- [PMM-13794 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13794){:target="_blank"} - Fixed an issue in HA deployments where the `/v1/server/leaderHealthCheck` endpoint would cause server crashes with *"invalid memory address"* errors. The health check endpoint now works correctly, preventing HAProxy health check failures. +- [PMM-13963 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13963){:target="_blank"} - Clicking the **Explain** tab in the Query Analytics dashboard made the PMM unresponsive for Percona Server instances. This issue is now fixed. +- [PMM-13881 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13881){:target="_blank"} - The mongodb_exporter would displayed the wrong version number when queried with `--version`. This issue is now fixed. ## Known issues diff --git a/documentation/docs/release-notes/3.3.1.md b/documentation/docs/release-notes/3.3.1.md index 023fc4116fd..78b62d884f0 100644 --- a/documentation/docs/release-notes/3.3.1.md +++ b/documentation/docs/release-notes/3.3.1.md @@ -28,8 +28,8 @@ This vulnerability affects all PMM 2.x and 3.x up to 3.3.0 deployments where PMM {.power-number} 1. Schedule a maintenance window to minimize disruption. - 2. [Download the latest PMM release](https://www.percona.com/downloads). - 3. [Upgrade PMM Server](https://docs.percona.com/percona-monitoring-and-management/3/pmm-upgrade/index.html), then [upgrade PMM Client](https://docs.percona.com/percona-monitoring-and-management/3/pmm-upgrade/upgrade_client.html). + 2. [Download the latest PMM release :octicons-link-external-16:](https://www.percona.com/downloads){:target="_blank"}. + 3. [Upgrade PMM Server :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/3/pmm-upgrade/index.html){:target="_blank"}, then [upgrade PMM Client :octicons-link-external-16:](https://docs.percona.com/percona-monitoring-and-management/3/pmm-upgrade/upgrade_client.html){:target="_blank"}. 4. Change all credentials for the services that PMM monitors, including database user accounts and any other credentials (e.g., API keys, SSH keys) PMM uses to connect to your infrastructure. 5. Thoroughly check access logs for any potential unauthorized access attempts or suspicious activity. @@ -73,7 +73,7 @@ This vulnerability affects all PMM 2.x and 3.x up to 3.3.0 deployments where PMM ### Support & additional resources We are available to assist you 24/7 if you need further clarification or assistance: -- [Technical support portal for customers](https://percona.service-now.com/percona?id=percona_login) -- [Technical support for community](https://forums.percona.com/c/percona-monitoring-and-management-pmm) +- [Technical support portal for customers :octicons-link-external-16:](https://percona.service-now.com/percona?id=percona_login){:target="_blank"} +- [Technical support for community :octicons-link-external-16:](https://forums.percona.com/c/percona-monitoring-and-management-pmm){:target="_blank"} We will continue to provide updates as new information becomes available. diff --git a/documentation/docs/release-notes/3.4.0.md b/documentation/docs/release-notes/3.4.0.md index 6d65e073979..9697400e610 100644 --- a/documentation/docs/release-notes/3.4.0.md +++ b/documentation/docs/release-notes/3.4.0.md @@ -50,7 +50,7 @@ When adding RDS instances via **Inventory > Add Service**, the instance ID that Behind the scenes, we've added an `instance_id` column to the database and enhanced the `/v1/management/services` API endpoint to accept and return this information. Everything is backward compatible so existing RDS instances continue working normally. -For technical details about API enhancements, see the [API Release Notes](https://percona-pmm.readme.io/v3/reference/release-notes-3-4-0). +For technical details about API enhancements, see the [API Release Notes :octicons-link-external-16:](https://percona-pmm.readme.io/v3/reference/release-notes-3-4-0){:target="_blank"}. ![!New Instance ID field](../images/instance_ID.png) @@ -89,49 +89,49 @@ For detailed steps, see [Migrating PMM from VMware to alternative platforms](../ ## Components upgrade -- [PMM-14015](https://perconadev.atlassian.net/browse/PMM-14015): PMM now ships with Grafana 11.6.3 for enhanced security and improved performance. +- [PMM-14015 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14015){:target="_blank"}: PMM now ships with Grafana 11.6.3 for enhanced security and improved performance. ## Improvements -- [PMM-14194](https://perconadev.atlassian.net/browse/PMM-14194): Custom filter groups in Query Analytics (QAN) now correctly distinguish between intentional comments and quoted strings containing comment-like characters. Previously, queries with values like `street = '123 Main St # app=something'` would incorrectly generate unwanted custom filters. +- [PMM-14194 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14194){:target="_blank"}: Custom filter groups in Query Analytics (QAN) now correctly distinguish between intentional comments and quoted strings containing comment-like characters. Previously, queries with values like `street = '123 Main St # app=something'` would incorrectly generate unwanted custom filters. Now, only genuine SQL comments such as `-- app='web', team='backend'` create filter options in the **PMM Query Analytics** dashboard sidebar. This means that you get cleaner query categorization when [comment parsing](../use/qan/panels/filters.md#custom-filter-groups) is enabled. -- [PMM-14048](https://perconadev.atlassian.net/browse/PMM-14048): Reorganized MongoDB dashboards for better usability. The **MongoDB PBM Details** and **PBM Backup Details** dashboards are now available directly from the main navigation for easier access, while the **MongoDB InMemory Details** and **MongoDB WiredTiger Details** dashboards are now relocated to **Other Dashboards**. +- [PMM-14048 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14048){:target="_blank"}: Reorganized MongoDB dashboards for better usability. The **MongoDB PBM Details** and **PBM Backup Details** dashboards are now available directly from the main navigation for easier access, while the **MongoDB InMemory Details** and **MongoDB WiredTiger Details** dashboards are now relocated to **Other Dashboards**. -- [PMM-13990](https://perconadev.atlassian.net/browse/PMM-13990): Improved MongoDB exporter performance by caching regular expression operations. Previously, the exporter repeatedly compiled the same regular expressions during metric collection, causing unnecessary CPU overhead. Now, these regex patterns are cached and reused, reducing the MongoDB exporter's CPU usage without affecting monitoring data quality. +- [PMM-13990 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13990){:target="_blank"}: Improved MongoDB exporter performance by caching regular expression operations. Previously, the exporter repeatedly compiled the same regular expressions during metric collection, causing unnecessary CPU overhead. Now, these regex patterns are cached and reused, reducing the MongoDB exporter's CPU usage without affecting monitoring data quality. -- [PMM-11826](https://perconadev.atlassian.net/browse/PMM-11826): You can now configure `vmagent` settings on PMM Clients by setting `VMAGENT_` environment variables on the PMM Server. These variables automatically apply to all connected clients, allowing you to tune disk usage limits and other parameters centrally. +- [PMM-11826 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-11826){:target="_blank"}: You can now configure `vmagent` settings on PMM Clients by setting `VMAGENT_` environment variables on the PMM Server. These variables automatically apply to all connected clients, allowing you to tune disk usage limits and other parameters centrally. -- [PMM-14208](https://perconadev.atlassian.net/browse/PMM-14208): Added support for PMM Client on Red Hat Enterprise Linux 10 (RHEL 10) for both AMD64 and ARM64 architectures. +- [PMM-14208 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14208){:target="_blank"}: Added support for PMM Client on Red Hat Enterprise Linux 10 (RHEL 10) for both AMD64 and ARM64 architectures. ## Fixed issues -- [PMM-14141](https://perconadev.atlassian.net/browse/PMM-14141): Fixed a critical issue where the MongoDB exporter would sometimes ignore connection timeouts. This prevented **MongoDB Down** alerts from triggering when MongoDB was unavailable. We've also improved the MongoDB down alert rule to work more reliably in timeout scenarios. +- [PMM-14141 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14141){:target="_blank"}: Fixed a critical issue where the MongoDB exporter would sometimes ignore connection timeouts. This prevented **MongoDB Down** alerts from triggering when MongoDB was unavailable. We've also improved the MongoDB down alert rule to work more reliably in timeout scenarios. -- [PMM-13885](https://perconadev.atlassian.net/browse/PMM-13885): You can now reliably enable and disable advisors on the **Advisors > Advisor Insights** page, as the toggle issue has been fixed. +- [PMM-13885 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13885){:target="_blank"}: You can now reliably enable and disable advisors on the **Advisors > Advisor Insights** page, as the toggle issue has been fixed. -- [PMM-14178](https://perconadev.atlassian.net/browse/PMM-14178): Fixed inconsistent service status reporting for stopped MongoDB instances. Previously, stopped MongoDB services showed as **Unspecified** while MySQL and PostgreSQL correctly showed as **Down**. Now all database services consistently display **Down** when stopped. +- [PMM-14178 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14178){:target="_blank"}: Fixed inconsistent service status reporting for stopped MongoDB instances. Previously, stopped MongoDB services showed as **Unspecified** while MySQL and PostgreSQL correctly showed as **Down**. Now all database services consistently display **Down** when stopped. -- [PMM-14166 ](https://perconadev.atlassian.net/browse/PMM-14166): Fixed Grafana Image Renderer functionality for generating dashboard panel images and corrected the **View all snapshots** link. +- [PMM-14166 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14166){:target="_blank"}: Fixed Grafana Image Renderer functionality for generating dashboard panel images and corrected the **View all snapshots** link. -- [PMM-14137](https://perconadev.atlassian.net/browse/PMM-14137): Fixed an issue where the **MongoDB WiredTiger Details** dashboard would show empty data after page refresh. Dashboard variables now maintain their values correctly during refresh cycles. +- [PMM-14137 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14137){:target="_blank"}: Fixed an issue where the **MongoDB WiredTiger Details** dashboard would show empty data after page refresh. Dashboard variables now maintain their values correctly during refresh cycles. -- [PMM-14087](https://perconadev.atlassian.net/browse/PMM-14087): Fixed a PostgreSQL deadlock issue that sometimes occurred during PMM Server startup, which blocked adding remote instances. +- [PMM-14087 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14087){:target="_blank"}: Fixed a PostgreSQL deadlock issue that sometimes occurred during PMM Server startup, which blocked adding remote instances. -- [PMM-14085](https://perconadev.atlassian.net/browse/PMM-14085): Fixed an issue where exported PMM data dumps from **PMM Home > Help > PMM Dump** were missing OS/host metrics and Query Analytics (QAN) data. Exports now include all metric types, providing complete data for troubleshooting and analysis. +- [PMM-14085 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14085){:target="_blank"}: Fixed an issue where exported PMM data dumps from **PMM Home > Help > PMM Dump** were missing OS/host metrics and Query Analytics (QAN) data. Exports now include all metric types, providing complete data for troubleshooting and analysis. -- [PMM-14075](https://perconadev.atlassian.net/browse/PMM-14075): Fixed an issue where the **Oplog Recovery Window** chart appeared twice on the **MongoDB Oplog Details** dashboard. +- [PMM-14075 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14075){:target="_blank"}: Fixed an issue where the **Oplog Recovery Window** chart appeared twice on the **MongoDB Oplog Details** dashboard. -- [PMM-14065](https://perconadev.atlassian.net/browse/PMM-14065): Fixed an issue where the **Failed Advisors** panel on the **Home** dashboard would not update when using **Refresh** button on the dashboard. The panel now correctly displays updated advisor results when the dashboard is refreshed, without requiring a full page reload. +- [PMM-14065 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-14065){:target="_blank"}: Fixed an issue where the **Failed Advisors** panel on the **Home** dashboard would not update when using **Refresh** button on the dashboard. The panel now correctly displays updated advisor results when the dashboard is refreshed, without requiring a full page reload. -- [PMM-13997](https://perconadev.atlassian.net/browse/PMM-13997): Fixed an issue where upgrades failed for deployments using Helm chart version 1.4.0. Upgrades from this version now complete successfully. +- [PMM-13997 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13997){:target="_blank"}: Fixed an issue where upgrades failed for deployments using Helm chart version 1.4.0. Upgrades from this version now complete successfully. -- [PMM-13994](https://perconadev.atlassian.net/browse/PMM-13994): Fixed an issue where PMM agent would show **Disconnected** status after network problems, even when connectivity was restored. The agent now reconnects properly without having to restart it manually. +- [PMM-13994 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13994){:target="_blank"}: Fixed an issue where PMM agent would show **Disconnected** status after network problems, even when connectivity was restored. The agent now reconnects properly without having to restart it manually. -- [PMM-13654](https://perconadev.atlassian.net/browse/PMM-13654): The `pmm-dump version` command would display empty version and build information. This issue is now fixed. +- [PMM-13654 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13654){:target="_blank"}: The `pmm-dump version` command would display empty version and build information. This issue is now fixed. -- [PMM-13828](https://perconadev.atlassian.net/browse/PMM-13828): Fixed an issue where the **MongoDB Sharded Cluster Summary** dashboard would incorrectly display replica set information when monitoring non-sharded MongoDB clusters. The dashboard now shows empty panels for replica set environments to prevent confusion between cluster types. +- [PMM-13828 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PMM-13828){:target="_blank"}: Fixed an issue where the **MongoDB Sharded Cluster Summary** dashboard would incorrectly display replica set information when monitoring non-sharded MongoDB clusters. The dashboard now shows empty panels for replica set environments to prevent confusion between cluster types. ## 🚀 Ready to upgrade to PMM 3.4.0? diff --git a/documentation/docs/release-notes/3.4.1.md b/documentation/docs/release-notes/3.4.1.md index b589419f2c5..dad6cad38d0 100644 --- a/documentation/docs/release-notes/3.4.1.md +++ b/documentation/docs/release-notes/3.4.1.md @@ -33,12 +33,12 @@ Security scanning tools may flag the following CVEs. After a thorough review, we #### OpenSSL cipher processing (CVE-2023-5363) PMM is not affected by this vulnerability. -The `openssl-libs` package included in PMM's Oracle Linux 9 base operating system already contains the necessary security fix for this OpenSSL cipher processing issue. You can verify this in [Oracle's official security advisory ELSA-2024-0627](https://linux.oracle.com/errata/ELSA-2024-0627.html). +The `openssl-libs` package included in PMM's Oracle Linux 9 base operating system already contains the necessary security fix for this OpenSSL cipher processing issue. You can verify this in [Oracle's official security advisory ELSA-2024-0627 :octicons-link-external-16:](https://linux.oracle.com/errata/ELSA-2024-0627.html){:target="_blank"}. #### Remote code execution in Python Setuptools (CVE-2024-6345) PMM is not affected by this vulnerability. -The PMM image's base OS, Oracle Linux 9, ships with `python3-setuptools` version 53.0.0-13.el9_6.1, which already includes the fix that addresses this vulnerability. You can confirm this though [Oracle's security advisory ELSA-2024-5534](https://linux.oracle.com/errata/ELSA-2024-5534.html). +The PMM image's base OS, Oracle Linux 9, ships with `python3-setuptools` version 53.0.0-13.el9_6.1, which already includes the fix that addresses this vulnerability. You can confirm this though [Oracle's security advisory ELSA-2024-5534 :octicons-link-external-16:](https://linux.oracle.com/errata/ELSA-2024-5534.html){:target="_blank"}. #### ClickHouse vulnerabilities related to outdated Go runtime (CVE-2024-24790) PMM is not affected by this vulnerability. @@ -66,4 +66,4 @@ We assess this risk as low, as PMM is usually deployed in controlled environment ## ❓ Questions or issues? -Visit our [community forum](https://forums.percona.com/c/percona-monitoring-and-management-pmm/pmm-3/84) or [open an issue](https://github.com/percona/pmm/issues) on GitHub. \ No newline at end of file +Visit our [community forum :octicons-link-external-16:](https://forums.percona.com/c/percona-monitoring-and-management-pmm/pmm-3/84){:target="_blank"} or [open an issue :octicons-link-external-16:](https://github.com/percona/pmm/issues){:target="_blank"} on GitHub. \ No newline at end of file diff --git a/documentation/docs/troubleshoot/checklist.md b/documentation/docs/troubleshoot/checklist.md index d92ae8d134c..cf30d1cf1f5 100644 --- a/documentation/docs/troubleshoot/checklist.md +++ b/documentation/docs/troubleshoot/checklist.md @@ -12,7 +12,7 @@ The following questions might help you identify the origin of the problem while - Does the problem occur when you perform a particular task? 6. Are you using the recommended [authentication](../api/authentication.md#authenticate) method? 7. Does your system’s firewall allow TCP traffic on the [ports](../install-pmm/plan-pmm-installation/network_and_firewall.md#essential-ports) used by PMM? -8. Have you allocated enough [disk space](https://www.percona.com/blog/2017/05/04/how-much-disk-space-should-i-allocate-for-percona-monitoring-and-management/) for installing PMM? If not, check the disk allocation space. +8. Have you allocated enough [disk space :octicons-link-external-16:](https://www.percona.com/blog/2017/05/04/how-much-disk-space-should-i-allocate-for-percona-monitoring-and-management/){:target="_blank"} for installing PMM? If not, check the disk allocation space. 9. Are you using a Technical Preview feature? Technical Preview features are not production-ready and should only be used in testing environments. For more information, see the relevant Release Notes. 10. For installing the PMM client, are you using a package other than a binary package without root permissions? 11. Is your [PMM Server](../install-pmm/install-pmm-server/index.md) installed and running with a known IP address accessible from the client node? diff --git a/documentation/docs/troubleshoot/config_issues.md b/documentation/docs/troubleshoot/config_issues.md index 4d6c30954ef..90684960d5d 100644 --- a/documentation/docs/troubleshoot/config_issues.md +++ b/documentation/docs/troubleshoot/config_issues.md @@ -12,7 +12,7 @@ PMM can also generate diagnostics data that can be examined and/or shared with o Logs obtained in this way include PMM Client logs and logs received from the PMM Server, and stored separately in the `client` and `server` folders. The `server` folder also contains its `client` subfolder with the self-monitoring client information collected on the PMM Server. -For additional debugging information, use the `--pprof` flag to include [pprof](https://github.com/google/pprof) debug profiles: `pmm-admin summary --pprof`. +For additional debugging information, use the `--pprof` flag to include [pprof :octicons-link-external-16:](https://github.com/google/pprof){:target="_blank"} debug profiles: `pmm-admin summary --pprof`. You can get PMM Server logs with either of these methods: @@ -37,7 +37,7 @@ When adding a service, the host might not be detected if the password contains s In such cases, you should convert any password, replacing special characters with their escape sequence equivalents. -One way to do this is to use the [`encodeURIComponent`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent) JavaScript function in your browser's web console (commonly found under a *Development Tools* menu). Run the function with your password as the parameter. For example: +One way to do this is to use the [`encodeURIComponent` :octicons-link-external-16:](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent){:target="_blank"} JavaScript function in your browser's web console (commonly found under a *Development Tools* menu). Run the function with your password as the parameter. For example: ```js > encodeURIComponent("s3cR#tpa$$worD") diff --git a/documentation/docs/troubleshoot/pmm_dump.md b/documentation/docs/troubleshoot/pmm_dump.md index 5855270c3ac..e7f69abe648 100644 --- a/documentation/docs/troubleshoot/pmm_dump.md +++ b/documentation/docs/troubleshoot/pmm_dump.md @@ -4,7 +4,7 @@ PMM data dumps are compressed tarball files containing a comprehensive export of You can download these dataset files locally, or share them with Percona Support via an SFTP server. This enables you to share PMM data securely, which is especially useful when you need to troubleshoot PMM issues without providing access to your PMM instance. -PMM3 enables you to generate datasets straight from PMM UI. PMM 2.41 or older use the [standalone PMM Dump utility](https://docs.percona.com/pmm-dump-documentation/installation.html) instead. +PMM3 enables you to generate datasets straight from PMM UI. PMM 2.41 or older use the [standalone PMM Dump utility :octicons-link-external-16:](https://docs.percona.com/pmm-dump-documentation/installation.html){:target="_blank"} instead. ## Access requirements @@ -49,7 +49,7 @@ If you are a Percona Customer, you can securely share PMM data dumps with Percon 1. From the top-right corner of the PMM home page, go to **Help > PMM Dump**. 2. Select the PMM dump entry which you want to send to Support. 3. In the **Options** column, expand the table row to check the PMM Service associated with the dataset, click the ellipsis (three vertical dots) and select **Send to Support**. -4. Fill in the [details of the SFTP server](https://percona.service-now.com/percona?id=kb_article_view&sysparm_article=KB0010247&sys_kb_id=bebd04da87e329504035b8c9cebb35a7&spa=1), then click **Send**. +4. Fill in the [details of the SFTP server :octicons-link-external-16:](https://percona.service-now.com/percona?id=kb_article_view&sysparm_article=KB0010247&sys_kb_id=bebd04da87e329504035b8c9cebb35a7&spa=1){:target="_blank"}, then click **Send**. 5. Update your Support ticket to let Percona know that you've uploaded the dataset on the SFTP server. ## Troubleshoot access issues diff --git a/documentation/docs/use/commands/pmm-admin.md b/documentation/docs/use/commands/pmm-admin.md index 381ec3743b7..4bd097d079d 100644 --- a/documentation/docs/use/commands/pmm-admin.md +++ b/documentation/docs/use/commands/pmm-admin.md @@ -830,8 +830,8 @@ pmm-admin add mysql --disable-collectors='heartbeat,global_status,info_schema.in For other collectors that you can disable with the `--disable-collectors` option, please visit the official repositories for each exporter: -- [`node_exporter`](https://github.com/percona/node_exporter) -- [`mysqld_exporter`](https://github.com/percona/mysqld_exporter) -- [`mongodb_exporter`](https://github.com/percona/mongodb_exporter) -- [`postgres_exporter`](https://github.com/percona/postgres_exporter) -- [`proxysql_exporter`](https://github.com/percona/proxysql_exporter) +- [`node_exporter` :octicons-link-external-16:](https://github.com/percona/node_exporter){:target="_blank"} +- [`mysqld_exporter` :octicons-link-external-16:](https://github.com/percona/mysqld_exporter){:target="_blank"} +- [`mongodb_exporter` :octicons-link-external-16:](https://github.com/percona/mongodb_exporter){:target="_blank"} +- [`postgres_exporter` :octicons-link-external-16:](https://github.com/percona/postgres_exporter){:target="_blank"} +- [`proxysql_exporter` :octicons-link-external-16:](https://github.com/percona/proxysql_exporter){:target="_blank"} diff --git a/documentation/docs/use/metrics/extend_metrics.md b/documentation/docs/use/metrics/extend_metrics.md index f0d8cb148ec..d58af106556 100644 --- a/documentation/docs/use/metrics/extend_metrics.md +++ b/documentation/docs/use/metrics/extend_metrics.md @@ -15,7 +15,7 @@ The collector is enabled by default. The following folders are used for differen ![!image](../../images/node-exporter.textfile-collector.1.png) -The exporter parses all files in these directories that match the filename wildcard expression `*.prom` using a simple text-based [exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format). +The exporter parses all files in these directories that match the filename wildcard expression `*.prom` using a simple text-based [exposition format :octicons-link-external-16:](https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format){:target="_blank"}. Metrics are stored on the PMM Server-side with additional labels related to this Node. ## Examples of shell commands for custom metrics diff --git a/documentation/docs/use/qan/panels/details.md b/documentation/docs/use/qan/panels/details.md index 32ea4fb07de..c68d2b7eeaf 100644 --- a/documentation/docs/use/qan/panels/details.md +++ b/documentation/docs/use/qan/panels/details.md @@ -33,7 +33,7 @@ For PostgreSQL queries (when using `pg_stat_monitor`) the top query will also be ![!image](../../../images/PMM_Query_Analytics_Tabs_Details_TopQuery.png) -Other useful metrics (when using **pg_stat_monitor**) to monitor PostgreSQL Server performance are [Histograms](https://docs.percona.com/pg-stat-monitor/user_guide.html#histogram). +Other useful metrics (when using **pg_stat_monitor**) to monitor PostgreSQL Server performance are [Histograms :octicons-link-external-16:](https://docs.percona.com/pg-stat-monitor/user_guide.html#histogram){:target="_blank"}. **Histograms** provide more explicit information about number of queries for fingerprint (`queryid`). Ranges are from 0 seconds up to 100 seconds. Here is picture of **histogram** in graph: diff --git a/documentation/docs/use/remove-services.md b/documentation/docs/use/remove-services.md index cc431f3184b..47c34d28d9f 100644 --- a/documentation/docs/use/remove-services.md +++ b/documentation/docs/use/remove-services.md @@ -23,5 +23,5 @@ pmm-admin list ``` ## Related topics -- [Percona release](https://www.percona.com/doc/percona-repo-config/percona-release.html) +- [Percona release :octicons-link-external-16:](https://www.percona.com/doc/percona-repo-config/percona-release.html){:target="_blank"} - [PMM Client architecture](../reference/index.md#pmm-client) \ No newline at end of file