From fce45b9a1fd722cdde5c6d43daf2a81bd28a453e Mon Sep 17 00:00:00 2001 From: Nurlan Moldomurov Date: Fri, 31 Jan 2025 22:42:29 +0300 Subject: [PATCH 01/14] PMM-7 fix links in install page --- documentation/docs/install-pmm/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/docs/install-pmm/index.md b/documentation/docs/install-pmm/index.md index 03e56a7e0b..b38ce51c71 100644 --- a/documentation/docs/install-pmm/index.md +++ b/documentation/docs/install-pmm/index.md @@ -31,15 +31,15 @@ The installation choices are: === "With Docker" - - [Docker installation](client/index.md#docker) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64). + - [Docker installation](install-pmm-client/docker.md) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64). === "With package manager" - - [Linux package](client/index.md#package-manager). Use `apt`, `apt-get`, `dnf`, `yum`. The package manager automatically selects the correct version for your architecture. + - [Linux package](install-pmm-client/package_manager.md). Use `apt`, `apt-get`, `dnf`, `yum`. The package manager automatically selects the correct version for your architecture. === "With binary package" - - [Binary package](client/index.md#binary-package): Download the appropriate `.tar.gz` file for your architecture (x86_64 or ARM64). + - [Binary package](install-pmm-client/binary_package.md): Download the appropriate `.tar.gz` file for your architecture (x86_64 or ARM64). !!! hint alert "Tips" From 3b82268fda31359a343844fe2cc4a638a9400888 Mon Sep 17 00:00:00 2001 From: Nurlan Moldomurov Date: Sat, 1 Feb 2025 00:27:08 +0300 Subject: [PATCH 02/14] PMM-7 Fix links. --- documentation/docs/advisors/advisors.md | 2 +- .../docs/advisors/develop_advisor_checks.md | 2 +- documentation/docs/alert/templates_list.md | 2 +- .../backup/mongodb-backup/backup_mongo.md | 2 +- .../percona_platform}/account-info.md | 0 .../check_percona_platform.md | 4 +- .../docs/configure-pmm/public-address.md | 2 +- documentation/docs/how-to/manage-users.md | 2 +- documentation/docs/install-pmm/HA.md | 2 +- documentation/docs/install-pmm/index.md | 24 +++++------ .../connect-database/mongodb.md | 2 +- .../connect-database/mysql.md | 2 +- .../baremetal/docker/index.md | 2 +- .../baremetal/docker/isolated_hosts.md | 4 +- .../podman/remove_container_podman.md | 3 +- documentation/docs/quickstart.md | 8 ++-- documentation/docs/quickstart/index.md | 34 +++++++-------- .../dashboard-mysql-user-details.md | 2 +- .../kubernetes_monitor_db_clusters_managed.md | 2 +- .../kubernetes_monitor_operators.md | 2 +- documentation/docs/reference/faq.md | 24 +++++------ documentation/docs/reference/index.md | 2 +- .../docs/reference/personal_data_handling.md | 2 +- .../docs/reference/third-party/postgresql.md | 41 +++++++++---------- .../docs/reference/third-party/victoria.md | 2 +- documentation/docs/release-notes/3.0.0.md | 2 +- documentation/docs/troubleshoot/checklist.md | 2 +- documentation/docs/use/commands/pmm-admin.md | 2 +- documentation/docs/use/qan/panels/filters.md | 2 +- documentation/docs/use/qan/share_link.md | 4 +- documentation/mkdocs-base.yml | 2 +- documentation/resources/bin/make_glossary.pl | 2 +- 32 files changed, 93 insertions(+), 97 deletions(-) rename documentation/docs/{how-to => configure-pmm/percona_platform}/account-info.md (100%) diff --git a/documentation/docs/advisors/advisors.md b/documentation/docs/advisors/advisors.md index d8cc01fdab..c1d8f59ec4 100644 --- a/documentation/docs/advisors/advisors.md +++ b/documentation/docs/advisors/advisors.md @@ -76,5 +76,5 @@ To see more details about the available checks and any checks that failed, click ## Create your own Advisors PMM Advisors offer a set of checks that can detect common security threats, performance degradation, data loss and data corruption. -Developers can create custom checks to cover additional use cases, relevant to specific database infrastructure. For more information, see [Develop Advisor checks](../details/develop-checks/index.html). +Developers can create custom checks to cover additional use cases, relevant to specific database infrastructure. For more information, see [Develop Advisor checks](develop_advisor_checks.md). diff --git a/documentation/docs/advisors/develop_advisor_checks.md b/documentation/docs/advisors/develop_advisor_checks.md index 58dfa92e96..95a6741694 100644 --- a/documentation/docs/advisors/develop_advisor_checks.md +++ b/documentation/docs/advisors/develop_advisor_checks.md @@ -199,7 +199,7 @@ Expand the table below for the list of checks types that you can use to define y | 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| - | CLICKHOUSE_SELECT |Executes 'SELECT ...' statements against PMM's [Query Analytics](https://docs.percona.com/percona-monitoring-and-management/get-started/query-analytics.html) 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| + | CLICKHOUSE_SELECT |Executes 'SELECT ...' statements against PMM's [Query Analytics](../use/qan/index.html) 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 - `METRICS_INSTANT` diff --git a/documentation/docs/alert/templates_list.md b/documentation/docs/alert/templates_list.md index 1c3336c362..33d35abd7c 100644 --- a/documentation/docs/alert/templates_list.md +++ b/documentation/docs/alert/templates_list.md @@ -4,7 +4,7 @@ The table below lists all the alert templates available in Percona Monitoring an This list includes both built-in templates (accessible to all PMM users), and customer-only templates. -To access the customer-only templates, you must be a Percona customer and [connect PMM to Percona Platform](../how-to/integrate-platform.md) using a Percona Account. +To access the customer-only templates, you must be a Percona customer and [connect PMM to Percona Platform](../configure-pmm/percona_platform/check_percona_platform.md) using a Percona Account. | Template name | Description | Availability | Database technology | | :------------ | :---------- | :----------- | :------------------ | diff --git a/documentation/docs/backup/mongodb-backup/backup_mongo.md b/documentation/docs/backup/mongodb-backup/backup_mongo.md index 9065749590..360df4569b 100644 --- a/documentation/docs/backup/mongodb-backup/backup_mongo.md +++ b/documentation/docs/backup/mongodb-backup/backup_mongo.md @@ -19,4 +19,4 @@ PMM 3 supports backing up sharded clusters. However, restoring for sharded clust - Creating Physical snapshot backups - Creating logical PITR backups both locally and on S3-compatible object storage -For a detailed overview of the supported setups for MongoDB, check out the [Support matrix](../backup/mongodb_limitations.md). \ No newline at end of file +For a detailed overview of the supported setups for MongoDB, check out the [Support matrix](mongodb_limitations.md). \ No newline at end of file diff --git a/documentation/docs/how-to/account-info.md b/documentation/docs/configure-pmm/percona_platform/account-info.md similarity index 100% rename from documentation/docs/how-to/account-info.md rename to documentation/docs/configure-pmm/percona_platform/account-info.md 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 f1c279d4d5..c1e31ff097 100644 --- a/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md +++ b/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md @@ -19,10 +19,10 @@ To confirm that you have successfully connected the server and check the list of ## Check Percona Portal entitlements -After connecting to the Percona Platform, PMM has access to [additional alert templates](/docs/alert/templates_list.md), [Advisor checks](/docs/advisors/advisors-details.md), and account information. See [Check Percona Portal account information](../how-to/account-info.md). +After connecting to the Percona Platform, PMM has access to [additional alert templates](/docs/alert/templates_list.md), [Advisor checks](/docs/advisors/advisors-details.md), and account information. See [Check Percona Portal account information](account-info.md). -After connecting to the Percona Platform, PMM has access to additional alert templates, Advisor checks, and account information. See [Check Percona Portal account information](../how-to/account-info.md). +After connecting to the Percona Platform, PMM has access to additional alert templates, Advisor checks, and account information. See [Check Percona Portal account information](account-info.md). ### Disconnect a PMM instance diff --git a/documentation/docs/configure-pmm/public-address.md b/documentation/docs/configure-pmm/public-address.md index e300756881..cf765314e9 100644 --- a/documentation/docs/configure-pmm/public-address.md +++ b/documentation/docs/configure-pmm/public-address.md @@ -4,7 +4,7 @@ The address or hostname PMM Server will be accessible at. Click **Get from brows ## Alerting -Enables [Percona Alerting](../get-started/alerting.md) and reveals the **Percona templated alerts** option on the Alerting page. +Enables [Percona Alerting](../alert/index.md) and reveals the **Percona templated alerts** option on the Alerting page. ## Microsoft Azure Monitoring diff --git a/documentation/docs/how-to/manage-users.md b/documentation/docs/how-to/manage-users.md index c676ec6f8b..755edd486f 100644 --- a/documentation/docs/how-to/manage-users.md +++ b/documentation/docs/how-to/manage-users.md @@ -2,7 +2,7 @@ This topic explains user management in PMM. -You can manage users from the [main menu](../details/interface.md#main-menu) by navigating to *Server Admin → Users* page. +You can manage users from the [main menu](../reference/ui/ui_components.md#main-menu) by navigating to *Server Admin → Users* page. ![!image](../images/PMM-manage-users.png) diff --git a/documentation/docs/install-pmm/HA.md b/documentation/docs/install-pmm/HA.md index eb6c9f28a4..1d269de4b3 100644 --- a/documentation/docs/install-pmm/HA.md +++ b/documentation/docs/install-pmm/HA.md @@ -1,7 +1,7 @@ # Install PMM in HA mode !!! caution alert alert-warning "Important" - This feature is currently in [Technical Preview](https://docs.percona.com/percona-monitoring-and-management/details/glossary.html#technical-preview). Early adopters are advised to use this feature for testing purposes only as it is subject to change. + This feature is currently in [Technical Preview](../reference/glossary.md#technical-preview). Early adopters are advised to use this feature for testing purposes only as it is subject to change. Set up PMM using Docker containers in a high-availability (HA) configuration following these instructions. diff --git a/documentation/docs/install-pmm/index.md b/documentation/docs/install-pmm/index.md index b38ce51c71..20f4b700f7 100644 --- a/documentation/docs/install-pmm/index.md +++ b/documentation/docs/install-pmm/index.md @@ -63,18 +63,18 @@ On each PMM Client instance, configure the nodes and services you want to monito - [HAProxy]; - [Remote instances]. -[MySQL]: client/mysql.md -[MongoDB]: client/mongodb.md -[PostgreSQL]: client/postgresql.md -[ProxySQL]: client/proxysql.md -[Amazon RDS]: client/aws.md -[Microsoft Azure]: client/azure.md -[Google Cloud Platform]: client/google.md -[Linux]: client/linux.md -[External services]: client/external.md -[HAProxy]: client/haproxy.md -[Remote instances]: client/remote.md -[dashboards]: ../details/dashboards/ +[MySQL]: install-pmm-client/mysql.md +[MongoDB]: install-pmm-client/mongodb.md +[PostgreSQL]: install-pmm-client/postgresql.md +[ProxySQL]: install-pmm-client/proxysql.md +[Amazon RDS]: install-pmm-client/aws.md +[Microsoft Azure]: install-pmm-client/azure.md +[Google Cloud Platform]: install-pmm-client/google.md +[Linux]: install-pmm-client/linux.md +[External services]: install-pmm-client/external.md +[HAProxy]: install-pmm-client/haproxy.md +[Remote instances]: install-pmm-client/remote.md +[dashboards]: ../use/dashboards-panels/index.md [Docker]: ../install-pmm/install-pmm-server/baremetal/docker/index.md [Podman]: ../install-pmm/install-pmm-server/baremetal/podman/index.md [Helm]: ../install-pmm/install-pmm-server/baremetal/helm/index.md diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/mongodb.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/mongodb.md index 840ee009fb..a9fe9b5dfc 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/mongodb.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/mongodb.md @@ -202,7 +202,7 @@ Use `pmm-admin` to add the database server as a service using one of these examp When successful, PMM Client will print `MongoDB Service added` with the service's ID and name. Use the `--environment` and `-custom-labels` options to set tags for the service to help identify them. !!! hint alert alert-success "Tips" - - When adding nodes to a sharded cluster, ensure to add each node separately using the `--cluster mycluster` option. This allows the [MongoDB Cluster Summary](../../details/dashboards/dashboard-mongodb-cluster-summary.md) dashboard to populate correctly. + - When adding nodes to a sharded cluster, ensure to add each node separately using the `--cluster mycluster` option. This allows the [MongoDB Cluster Summary](../../../reference/dashboards/dashboard-mongodb-cluster-summary.md) dashboard to populate correctly. - You can also use the `--replication-set` option to specify a replication set, altough they are automatically detected. For instance, you can use `--replication-set config` for your config servers; `--replication-set rs1` for your servers in the first replica set, `--replication-set rs2` for your servers in the second replica set, and so on. - When running mongos routers in containers, specify the `diagnosticDataCollectionDirectoryPath` to ensure that pmm-agent can properly capture mongos metrics. For example: `mongos --setParameter diagnosticDataCollectionDirectoryPath=/var/log/mongo/mongos.diagnostic.data/` diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md index 6664356215..4c6f51d8e9 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md @@ -176,7 +176,7 @@ Some MySQL-based database servers support extended slow query log variables. Slow query log files can grow quickly and must be managed. -When adding a service with the command line use the `pmm-admin` option `--size-slow-logs` to set at what size the slow query log file is rotated. (The size is specified as a number with a suffix. See [`pmm-admin add mysql`](../../details/commands/pmm-admin.md#mysql).) +When adding a service with the command line use the `pmm-admin` option `--size-slow-logs` to set at what size the slow query log file is rotated. (The size is specified as a number with a suffix. See [`pmm-admin add mysql`](../../../use/commands/pmm-admin.md#mysql).) When the limit is reached, PMM Client will: diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/index.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/index.md index d8b10e9dff..04787ed8c8 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/index.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/index.md @@ -72,6 +72,6 @@ You can install PMM Server with Watchtower in two ways: - To disable the Home Dashboard **PMM Upgrade** panel you can either add `-e PMM_ENABLE_UPDATES=false` to the `docker run` command (for the life of the container) or navigate to _PMM --> PMM Settings --> Advanced Settings_ and disable "Check for Updates" (can be turned back on by any admin in the UI). - - Eliminate browser certificate warnings by configuring a [trusted certificate](https://docs.percona.com/percona-monitoring-and-management/how-to/secure.html#ssl-encryption). + - Eliminate browser certificate warnings by configuring a [trusted certificate](../../../../how-to/secure.html#ssl-encryption). - You can optionally enable an (insecure) HTTP connection by adding `--publish 80:80` to the `docker run` command. However, running PMM insecure is not recommended. You should also note that PMM Client *requires* TLS to communicate with the server, only working on a secure port. diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/isolated_hosts.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/isolated_hosts.md index 4d81fe4fc9..36fefba404 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/isolated_hosts.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/isolated_hosts.md @@ -34,6 +34,6 @@ If the host where you will run PMM Server has no internet connection, you can do [Docker]: https://docs.docker.com/get-docker/ [Docker image]: https://hub.docker.com/r/percona/pmm-server [Docker compose]: https://docs.docker.com/compose/ -[PMMC_COMPOSE]: ../client/index.md#docker-compose -[trusted certificate]: ../../how-to/secure.md#ssl-encryption +[PMMC_COMPOSE]: ../../../install-pmm-client/docker.md +[trusted certificate]: ../../../../how-to/secure.md#ssl-encryption [Easy-install script]: easy-install.md diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/podman/remove_container_podman.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/podman/remove_container_podman.md index ad4ed93a16..cb611c33b8 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/podman/remove_container_podman.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/podman/remove_container_podman.md @@ -47,5 +47,4 @@ To remove your contiainer: [Docker]: docker.md [Docker image]: https://hub.docker.com/r/percona/pmm-server [Docker Environment]: docker.md#environment-variables -[trusted certificate]: ../../how-to/secure.md#ssl-encryption -[Set up repos]: ../client/index.md#package-manager \ No newline at end of file +[trusted certificate]: ../../../../how-to/secure.md#ssl-encryption \ No newline at end of file diff --git a/documentation/docs/quickstart.md b/documentation/docs/quickstart.md index ce662e7793..dd7cb63ea4 100644 --- a/documentation/docs/quickstart.md +++ b/documentation/docs/quickstart.md @@ -142,7 +142,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](../setting-up/client/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](https://docs.percona.com/pg-stat-monitor/configuration.html) for details about available parameters. 4. Set or change the value for `shared_preload_library` in your `postgresql.conf` file: @@ -211,7 +211,7 @@ Once PMM is set up, choose the database or the application that you want it to m pmm-admin add postgresql --username=pmm --password= ``` - For detailed instructions and advanced installation options, see [Adding a PostgreSQL database](../setting-up/client/postgresql.md). + For detailed instructions and advanced installation options, see [Adding a PostgreSQL database](../install-pmm/install-pmm-client/connect-database/postgresql.md). === ":simple-mongodb: MongoDB" @@ -315,7 +315,7 @@ Once PMM is set up, choose the database or the application that you want it to m pmm-admin add mongodb --username=pmm --password= ``` - For detailed instructions, see [Adding a MongoDB database for monitoring](https://docs.percona.com/percona-monitoring-and-management/setting-up/client/mongodb.html). + For detailed instructions, see [Adding a MongoDB database for monitoring](install-pmm/install-pmm-client/connect-database/mongodb.html). === ":simple-nginxproxymanager: ProxySQL" To connect a ProxySQL service: @@ -372,7 +372,7 @@ Once PMM is set up, choose the database or the application that you want it to m pmm-admin add proxysql --username=pmm --password= ``` - For detailed instructions, see [Enable ProxySQL performance metrics monitoring](../setting-up/client/proxysql.md). + For detailed instructions, see [Enable ProxySQL performance metrics monitoring](../install-pmm/install-pmm-client/connect-database/proxysql.md). === ":material-database: HAProxy" To connect an HAProxy service: diff --git a/documentation/docs/quickstart/index.md b/documentation/docs/quickstart/index.md index c41fd9fec1..21d3e17e6a 100644 --- a/documentation/docs/quickstart/index.md +++ b/documentation/docs/quickstart/index.md @@ -7,11 +7,11 @@ This is the simplest and most efficient way to install PMM with Docker. ??? info "Alternative installation options" For alternative setups or if you're not using Docker, explore the additional installation options detailed in the **Setting up** chapter: - - [Deploy on Podman](../setting-up/server/podman.md) - - [Deploy based on a Docker image](../setting-up/server/docker.md) - - [Deploy on Virtual Appliance](../setting-up/server/virtual-appliance.md) - - [Deploy on Kubernetes via Helm](../setting-up/server/helm.md) - - [Run a PMM instance hosted at AWS Marketplace](../setting-up/server/aws.md) + - [Deploy on Podman](../install-pmm/install-pmm-server/baremetal/podman/index.md) + - [Deploy based on a Docker image](../install-pmm/install-pmm-server/baremetal/docker/index.md) + - [Deploy on Virtual Appliance](../install-pmm/install-pmm-server/baremetal/virtual/index.md) + - [Deploy on Kubernetes via Helm](../install-pmm/install-pmm-server/baremetal/helm/index.md) + - [Run a PMM instance hosted at AWS Marketplace](../install-pmm/install-pmm-server/aws/aws.md) #### Prerequisites @@ -126,11 +126,11 @@ Once PMM is set up, choose the database or the application that you want it to m pmm-admin add mysql --query-source=perfschema --username=pmm --password= ``` ??? info "Alternative database connection workflows" - While the default instructions above focus on connecting a self-hosted MySQL database, PMM offers the flexibility to connect to various MySQL databases, including [AWS RDS](../setting-up/client/aws.md), [Azure MySQL](../setting-up/client/azure.md) or [Google Cloud MySQL](../setting-up/client/google.md). + While the default instructions above focus on connecting a self-hosted MySQL database, PMM offers the flexibility to connect to various MySQL databases, including [AWS RDS](../install-pmm/install-pmm-client/connect-database/aws.md), [Azure MySQL](../install-pmm/install-pmm-client/connect-database/azure.md) or [Google Cloud MySQL](../install-pmm/install-pmm-client/connect-database/google.md). - The PMM Client installation also comes with options: in addition to the installation via Package Manager described above, you can also install it as a Docker container or as a binary package. Explore [alternative PMM Client installation options](../setting-up/client/index.html#binary-package) for more information. + The PMM Client installation also comes with options: in addition to the installation via Package Manager described above, you can also install it as a Docker container or as a binary package. Explore [alternative PMM Client installation options](../install-pmm/install-pmm-client/connect-database/index.html#binary-package) for more information. - Additionally, if direct access to the database node isn't available, opt to [Add remote instance via User Interface](../setting-up/client/mysql.html#with-the-user-interface) instead. + Additionally, if direct access to the database node isn't available, opt to [Add remote instance via User Interface](../install-pmm/install-pmm-client/connect-database/mysql.html#with-the-user-interface) instead. === ":simple-postgresql: PostgreSQL" @@ -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](../setting-up/client/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](https://docs.percona.com/pg-stat-monitor/configuration.html) for details about available parameters. 4. Set or change the value for `shared_preload_library` in your `postgresql.conf` file: @@ -231,7 +231,7 @@ Once PMM is set up, choose the database or the application that you want it to m pmm-admin add postgresql --username=pmm --password= ``` - For detailed instructions and advanced installation options, see [Adding a PostgreSQL database](../setting-up/client/postgresql.md). + For detailed instructions and advanced installation options, see [Adding a PostgreSQL database](../install-pmm/install-pmm-client/connect-database/postgresql.md). === ":simple-mongodb: MongoDB" @@ -345,7 +345,7 @@ Once PMM is set up, choose the database or the application that you want it to m pmm-admin add mongodb --username=pmm --password= ``` - For detailed instructions, see [Adding a MongoDB database for monitoring](https://docs.percona.com/percona-monitoring-and-management/setting-up/client/mongodb.html). + For detailed instructions, see [Adding a MongoDB database for monitoring](../install-pmm/install-pmm-client/connect-database/mongodb.html). === ":simple-nginxproxymanager: ProxySQL" To connect a ProxySQL service: @@ -412,7 +412,7 @@ Once PMM is set up, choose the database or the application that you want it to m pmm-admin add proxysql --username=pmm --password= ``` - For detailed instructions, see [Enable ProxySQL performance metrics monitoring](../setting-up/client/proxysql.md). + For detailed instructions, see [Enable ProxySQL performance metrics monitoring](../install-pmm/install-pmm-client/connect-database/proxysql.md). === ":material-database: HAProxy" To connect an HAProxy service: @@ -478,17 +478,17 @@ Once PMM is set up, choose the database or the application that you want it to m pmm-admin add haproxy --listen-port=8404 ``` - For detailed instructions and more information on the command arguments, see the [HAProxy topic](../setting-up/client/haproxy.md). + For detailed instructions and more information on the command arguments, see the [HAProxy topic](../install-pmm/install-pmm-client/connect-database/haproxy.md). ## Check database monitoring results After installing PMM and connecting the database, go to the database's Instance Summary dashboard. This shows essential information about your database performance and an overview of your environment. -For more information, see [PMM Dashboards](../details//dashboards/index.md). +For more information, see [PMM Dashboards](../use/dashboards-panels/index.md). ## Next steps -- [Configure PMM via the interface](../how-to/configure.md) +- [Configure PMM via the interface](../configure-pmm/configure.md) - [Manage users in PMM](../how-to/manage-users.md) -- [Set up roles and permissions](../get-started/roles-and-permissions/index.md) -- [Back up and restore data in PMM](../get-started/backup/index.md) \ No newline at end of file +- [Set up roles and permissions](../pmm-admin/roles/index.md) +- [Back up and restore data in PMM](../backup/index.md) \ No newline at end of file diff --git a/documentation/docs/reference/dashboards/dashboard-mysql-user-details.md b/documentation/docs/reference/dashboards/dashboard-mysql-user-details.md index f22d1e992a..4a2f46b0e0 100644 --- a/documentation/docs/reference/dashboards/dashboard-mysql-user-details.md +++ b/documentation/docs/reference/dashboards/dashboard-mysql-user-details.md @@ -3,7 +3,7 @@ ![!image](../../images/PMM_MySQL_User_Details.jpg) !!! note alert alert-primary "" - This dashboard requires Percona Server for MySQL 5.1+ or MariaDB 10.1/10.2 with XtraDB. Also `userstat` should be enabled, for example with the `SET GLOBAL userstat=1` statement. See [Setting up MySQL](../../setting-up/client/mysql.md). + This dashboard requires Percona Server for MySQL 5.1+ or MariaDB 10.1/10.2 with XtraDB. Also `userstat` should be enabled, for example with the `SET GLOBAL userstat=1` statement. See [Setting up MySQL](../../install-pmm/install-pmm-client/connect-database/mysql.md). Data is displayed for the 5 top users. diff --git a/documentation/docs/reference/dashboards/kubernetes_monitor_db_clusters_managed.md b/documentation/docs/reference/dashboards/kubernetes_monitor_db_clusters_managed.md index 457a05fc9d..6ebf6bfadd 100644 --- a/documentation/docs/reference/dashboards/kubernetes_monitor_db_clusters_managed.md +++ b/documentation/docs/reference/dashboards/kubernetes_monitor_db_clusters_managed.md @@ -2,7 +2,7 @@ !!! caution alert alert-warning "Important" - This feature is still in [Technical Preview](https://docs.percona.com/percona-monitoring-and-management/details/glossary.html#technical-preview) and is subject to change. We recommend that early adopters use this feature for testing purposes only. + This feature is still in [Technical Preview](../../reference/glossary.md#technical-preview) and is subject to change. We recommend that early adopters use this feature for testing purposes only. This dashboard displays the primary parameters of database clusters created by Percona Operators for various databases and helps identify the performance issues. diff --git a/documentation/docs/reference/dashboards/kubernetes_monitor_operators.md b/documentation/docs/reference/dashboards/kubernetes_monitor_operators.md index 7a225ae49b..27a9643b7f 100644 --- a/documentation/docs/reference/dashboards/kubernetes_monitor_operators.md +++ b/documentation/docs/reference/dashboards/kubernetes_monitor_operators.md @@ -1,7 +1,7 @@ # Kubernetes monitoring for Percona Operators !!! caution alert alert-warning "Important" - This feature is still in [Technical Preview](https://docs.percona.com/percona-monitoring-and-management/details/glossary.html#technical-preview) and is subject to change. We recommend that early adopters use this feature for testing purposes only. + This feature is still in [Technical Preview](../../reference/glossary.md#technical-preview) and is subject to change. We recommend that early adopters use this feature for testing purposes only. Monitoring the state of the database is crucial to timely identify and react to performance issues. Percona Monitoring and Management (PMM) solution enables you to do just that. diff --git a/documentation/docs/reference/faq.md b/documentation/docs/reference/faq.md index b8f8147452..f1890ac57f 100644 --- a/documentation/docs/reference/faq.md +++ b/documentation/docs/reference/faq.md @@ -15,8 +15,8 @@ - Disk: 100 MB !!! seealso alert alert-info "See also" - - [Setting up PMM Server](setting-up/server/index.md) - - [Setting up PMM Client](setting-up/client/index.md) + - [Setting up PMM Server](../install-pmm/install-pmm-server/index.md) + - [Setting up PMM Client](../install-pmm/install-pmm-client/index.md) ## How can I upgrade from version 2? @@ -27,7 +27,7 @@ PMM 3 introduces significant architectural changes that require gradual transiti Go to **PMM Configuration > Settings > Advanced Settings > Data retention** to adjust the value in days. !!! seealso alert alert-info "See also" - [Configure data retention](how-to/configure.md#data-retention) + [Configure data retention](../configure-pmm/advanced_settings.md#data-retention) ## How are PMM Server logs rotated? @@ -40,7 +40,7 @@ SELECT, PROCESS, SUPER, REPLICATION CLIENT, RELOAD ``` !!! seealso alert alert-info "See also" - [Setting Up/Client/MySQL](setting-up/client/mysql.md#create-a-database-account-for-pmm). + [Setting Up/Client/MySQL](../install-pmm/install-pmm-client/connect-database/mysql.md#create-a-database-account-for-pmm). ## Can I monitor multiple service instances? @@ -58,7 +58,7 @@ pmm-admin add mysql --username root --password root instance-02 127.0.0.1:3002 ``` !!! seealso alert alert-info "See also" - [`pmm-admin add mysql`](details/commands/pmm-admin.md#mysql) + [`pmm-admin add mysql`](../use/commands/pmm-admin.md#mysql) ## Can I rename instances? @@ -68,7 +68,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](details/api.md). +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). ![!image](../images/aws-partitions-in-api.png) @@ -86,7 +86,7 @@ The default values (in seconds): | Custom (defaults) | 60 | 10 | 5 | !!! seealso alert alert-info "See also" - [Metrics resolution](how-to/configure.md#metrics-resolution) + [Metrics resolution](../configure-pmm/metrics_res.md) ## How do I set up Alerting? @@ -110,12 +110,12 @@ From version 2.4.0, when `pmm-managed` starts the Prometheus file generation pro The `prometheus.yml` file can be regenerated by restarting the PMM Server container, or by using the `SetSettings` API call with an empty body. !!! seealso alert alert-info "See also" - - [API](details/api.md) + - [API](../api/index.md) - [Percona blog: Extending PMM’s Prometheus Configuration](https://www.percona.com/blog/2020/03/23/extending-pmm-prometheus-configuration/) -## How to troubleshoot an update? +## How to troubleshoot an upgrade? -See [Troubleshoot update](how-to/troubleshoot.md#update). +See [Troubleshoot update](../troubleshoot/upgrade_issues.md). ## What are my login credentials when I try to connect to a Prometheus Exporter? @@ -125,7 +125,7 @@ See [Troubleshoot update](how-to/troubleshoot.md#update). PMM protects an exporter's output from unauthorized access by adding an authorization layer. To access an exporter, you can use `pmm` as a user name and the Agent ID as a password. You can find the Agent ID corresponding to a given exporter by running `pmm-admin list`. !!! seealso alert alert-info "See also" - [`pmm-admin list`](details/commands/pmm-admin.md#information-commands) + [`pmm-admin list`](../use/commands/pmm-admin.md#information-commands) ## How to provision PMM Server with non-default admin password? @@ -170,7 +170,7 @@ 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](details/personal_data_handling.md). +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). ## Why am I getting a "User already exists" error when logging back into PMM? diff --git a/documentation/docs/reference/index.md b/documentation/docs/reference/index.md index 34a73ad0ee..cf6c397815 100644 --- a/documentation/docs/reference/index.md +++ b/documentation/docs/reference/index.md @@ -62,7 +62,7 @@ PMM Server includes the following tools: The PMM Client package consists of the following: -- `pmm-admin` is a command-line tool for managing PMM Client, for example, adding and removing database instances that you want to monitor. ([Read more](../details/commands/pmm-admin.md)). +- `pmm-admin` is a command-line tool for managing PMM Client, for example, adding and removing database instances that you want to monitor. ([Read more](../use/commands/pmm-admin.md)). - `pmm-agent` is a client-side component of a minimal command-line interface, which is a central entry point in charge of bringing the client functionality: it carries on client’s authentication, gets the client configuration stored on the PMM Server, manages exporters and other agents. diff --git a/documentation/docs/reference/personal_data_handling.md b/documentation/docs/reference/personal_data_handling.md index 3d8ae69ae5..ccadb5e85b 100644 --- a/documentation/docs/reference/personal_data_handling.md +++ b/documentation/docs/reference/personal_data_handling.md @@ -11,7 +11,7 @@ The following questions are being answered related to personal and confidential | DB host to PMM | Database performance metrics
SQL query examples for query analytics (optional). | PMM to DB Host | DSN and credentials for database access. A separate DB user is used (limited access) to retrieve metrics from the database. | DB Host to S3 compatible storage location | Database backup - optional if PMM Administrator configures it with Public Cloud (AWS, GCP, etc) as a possible storage location. - | PMM Server to Percona Cloud | Telemetry data is collected.
PMM Server collects varying amounts of data from version to version, and no personal or confidential information is collected. See [here](https://docs.percona.com/percona-monitoring-and-management/how-to/configure.html#telemetry) for details on the data being transmitted. + | PMM Server to Percona Cloud | Telemetry data is collected.
PMM Server collects varying amounts of data from version to version, and no personal or confidential information is collected. See [here](../configure-pmm/advanced_settings#telemetry) for details on the data being transmitted. 2. Where is the data obtained from the DB host transmitted? diff --git a/documentation/docs/reference/third-party/postgresql.md b/documentation/docs/reference/third-party/postgresql.md index f780df7ab9..530afeca32 100644 --- a/documentation/docs/reference/third-party/postgresql.md +++ b/documentation/docs/reference/third-party/postgresql.md @@ -6,22 +6,19 @@ You can use an external PostgreSQL database instance outside the PMM Server cont PMM predefines certain flags that allow you to use PostgreSQL parameters as environment variables: -!!! caution alert alert-warning "Warning" - The `PERCONA_TEST_*` environment variables are experimental and subject to change. It is recommended that you use these variables for testing purposes only and not on production. The minimum supported PostgreSQL server version is 14. - To use PostgreSQL as an external database instance, use the following environment variables: | Environment variable | Flag | Description | | ---------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| PERCONA_TEST_POSTGRES_ADDR | [postgres-addr](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-HOST) | Hostname and port for external PostgreSQL database. | -| PERCONA_TEST_POSTGRES_DBNAME | [postgres-name](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-DBNAME) | Database name for external or internal PostgreSQL database. | -| PERCONA_TEST_POSTGRES_USERNAME | [postgres-username](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-USER) | PostgreSQL user name to connect as. | -| PERCONA_TEST_POSTGRES_DBPASSWORD | [postgres-password](https://www.postgresql.org/docs/14/libpq-connect.html#LIBPQ-CONNECT-PASSWORD) | Password to be used for database authentication. | -| PERCONA_TEST_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`. | -| PERCONA_TEST_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). | -| PERCONA_TEST_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. | -| PERCONA_TEST_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. | -| PERCONA_TEST_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. | +| 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_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 [PostgeSQL SSL instructions](https://www.postgresql.org/docs/14/ssl-tcp.html) and provide `POSTGRES_SSL_*` variables. @@ -63,7 +60,7 @@ To use PostgreSQL as an external database: 4. Create `user` and `database` for pmm-server to use. Set appropriate rights and access. -5. Install `pg_stat_statements` in PostgreSQL in order to have all metrics according to [this](../setting-up/client/postgresql.md) handy document. +5. Install `pg_stat_statements` in PostgreSQL in order to have all metrics according to [this](../../install-pmm/install-pmm-client/connect-database/postgresql.md) handy document. 6. Run PostgreSQL server. @@ -89,15 +86,15 @@ To use PostgreSQL as an external database: ```sh docker run --name pmm-server - -e PERCONA_TEST_POSTGRES_ADDR=$ADDRESS:$PORT - -e PERCONA_TEST_POSTGRES_DBNAME=$DBNAME - -e PERCONA_TEST_POSTGRES_USERNAME=$USER - -e PERCONA_TEST_POSTGRES_DBPASSWORD=$PASSWORD - -e PERCONA_TEST_POSTGRES_SSL_MODE=$SSL_MODE - -e PERCONA_TEST_POSTGRES_SSL_CA_PATH=$CA_PATH - -e PERCONA_TEST_POSTGRES_SSL_KEY_PATH=$KEY_PATH - -e PERCONA_TEST_POSTGRES_SSL_CERT_PATH=$CERT_PATH - -e PERCONA_TEST_PMM_DISABLE_BUILTIN_POSTGRES=true + -e PMM_POSTGRES_ADDR=$ADDRESS:$PORT + -e PMM_POSTGRES_DBNAME=$DBNAME + -e PMM_POSTGRES_USERNAME=$USER + -e PMM_POSTGRES_DBPASSWORD=$PASSWORD + -e PMM_POSTGRES_SSL_MODE=$SSL_MODE + -e PMM_POSTGRES_SSL_CA_PATH=$CA_PATH + -e PMM_POSTGRES_SSL_KEY_PATH=$KEY_PATH + -e PMM_POSTGRES_SSL_CERT_PATH=$CERT_PATH + -e PMM_DISABLE_BUILTIN_POSTGRES=true -e GF_DATABASE_URL=$GF_DATABASE_URL -e GF_DATABASE_SSL_MODE=$GF_SSL_MODE -e GF_DATABASE_CA_CERT_PATH=$GF_CA_PATH diff --git a/documentation/docs/reference/third-party/victoria.md b/documentation/docs/reference/third-party/victoria.md index 2d17e1e496..b767bded43 100644 --- a/documentation/docs/reference/third-party/victoria.md +++ b/documentation/docs/reference/third-party/victoria.md @@ -51,7 +51,7 @@ This instructs VictoriaMetrics to [deduplicate](https://docs.victoriametrics.com ## Using VictoriaMetrics external database instance !!! caution alert alert-warning "Important/Caution" - This feature is still in [Technical Preview](https://docs.percona.com/percona-monitoring-and-management/details/glossary.html#technical-preview) and is subject to change. We recommend that early adopters use this feature for evaluation purposes only. + This feature is still in [Technical Preview](../../reference/glossary.md#technical-preview) and is subject to change. We recommend that early adopters use this feature for evaluation purposes only. You can use an external VictoriaMetrics database for monitoring in PMM. diff --git a/documentation/docs/release-notes/3.0.0.md b/documentation/docs/release-notes/3.0.0.md index 58d5888405..a3b68b3f3d 100644 --- a/documentation/docs/release-notes/3.0.0.md +++ b/documentation/docs/release-notes/3.0.0.md @@ -282,7 +282,7 @@ When migrating from PMM 2 to PMM 3, you’ll need to update your environment var - some boolean flags reversed (e.g., `DISABLE_` > `ENABLE_`) - removed deprecated variables -To check the Migration reference table, see [Environment variables in PMM](../install-pmm/install-pmm-server/baremetal/docker/env_var.md##variables-for-migrating-from-pmm-v2-to-pmm-v3). +To check the Migration reference table, see [Environment variables in PMM](../install-pmm/install-pmm-server/baremetal/docker/env_var.md#variables-for-migrating-from-pmm-v2-to-pmm-v3). ### Grafana Angular support discontinuation diff --git a/documentation/docs/troubleshoot/checklist.md b/documentation/docs/troubleshoot/checklist.md index d1475a1188..52c5df5e12 100644 --- a/documentation/docs/troubleshoot/checklist.md +++ b/documentation/docs/troubleshoot/checklist.md @@ -16,7 +16,7 @@ The following questions might help you identify the origin of the problem while 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? -12. Is the [PMM Client](../install-pmm/install-pmm-client/index.md) installed, and is the node [registered with PMM Server](../setting-up/client/index.md#register)? +12. Is the [PMM Client](../install-pmm/install-pmm-client/index.md) installed, and is the node [registered with PMM Server](../install-pmm/install-pmm-client/index.md#register)? 13. Is PMM Client configured correctly and has access to the config file? 14. For monitoring MongoDB, do you have adminUserAnyDatabase or superuser role privilege to any database servers you want to monitor? 15. For monitoring Amazon RDS using PMM, is there too much latency between PMM Server and the Amazon RDS instance? diff --git a/documentation/docs/use/commands/pmm-admin.md b/documentation/docs/use/commands/pmm-admin.md index 9c89c102a5..f6236bd863 100644 --- a/documentation/docs/use/commands/pmm-admin.md +++ b/documentation/docs/use/commands/pmm-admin.md @@ -446,7 +446,7 @@ Enable all collectors and limit monitoring for `dbstats`, `indexstats`, `collsta ##### Resolutions -PMM collects metrics in two [resolutions](../../how-to/configure.md#metrics-resolution) to decrease CPU and Memory usage: high and low resolutions. +PMM collects metrics in two [resolutions](../../configure-pmm/metrics_res.md) to decrease CPU and Memory usage: high and low resolutions. In high resolution we collect metrics from collectors which work fast: - `diagnosticdata` diff --git a/documentation/docs/use/qan/panels/filters.md b/documentation/docs/use/qan/panels/filters.md index cc9066cb29..9f2672e54c 100644 --- a/documentation/docs/use/qan/panels/filters.md +++ b/documentation/docs/use/qan/panels/filters.md @@ -14,7 +14,7 @@ ## Custom filter groups !!! caution alert alert-warning "Important/Caution" - This feature is still in [Technical Preview](https://docs.percona.com/percona-monitoring-and-management/details/glossary.html#technical-preview) and is subject to change. We recommend that early adopters use this feature for testing purposes only. + This feature is still in [Technical Preview](../../../reference/glossary.md#technical-preview) and is subject to change. We recommend that early adopters use this feature for testing purposes only. Filter queries using custom key=value pairs from query comments. This feature is disabled by default. diff --git a/documentation/docs/use/qan/share_link.md b/documentation/docs/use/qan/share_link.md index da92333b37..36530b6d5a 100644 --- a/documentation/docs/use/qan/share_link.md +++ b/documentation/docs/use/qan/share_link.md @@ -10,6 +10,6 @@ To share a link for Query Analytics, use **Copy Link**. It copies the link to th ![!image](../../images/PMM_Query_Analytics_Share_Link.jpg) -[SLOW_QUERY_LOG]: ../setting-up/client/mysql.md#slow-query-log -[PERFORMANCE_SCHEMA]: ../setting-up/client/mysql.md#performance-schema +[SLOW_QUERY_LOG]: ../../install-pmm/install-pmm-client/connect-database/mysql.md#slow-query-log +[PERFORMANCE_SCHEMA]: ../../install-pmm/install-pmm-client/connect-database/mysql.md#performance-schema diff --git a/documentation/mkdocs-base.yml b/documentation/mkdocs-base.yml index 4d3127d0cf..99c263acbc 100644 --- a/documentation/mkdocs-base.yml +++ b/documentation/mkdocs-base.yml @@ -118,7 +118,7 @@ plugins: # https://pypi.org/project/mkdocs-exclude/ exclude: glob: - - "setting-up/client/docker.md" + - "install-pmm/install-pmm-client/docker.md" mike: version_selector: true css_dir: css diff --git a/documentation/resources/bin/make_glossary.pl b/documentation/resources/bin/make_glossary.pl index 1b875fe09b..7b110a8703 100755 --- a/documentation/resources/bin/make_glossary.pl +++ b/documentation/resources/bin/make_glossary.pl @@ -4,7 +4,7 @@ # Master copy: https://docs.google.com/spreadsheets/d/1KUL-dcfBrR3bWsFUcugy5SsJcR5ot-P4Bt27z3ka0x0/edit#gid=0 # Export this sheet as tab-separated values into source/_res/glossary.tsv # Usage: -# sort resources/bin/glossary.tsv | resources/bin/make_glossary_md.pl > docs/details/glossary.md +# sort resources/bin/glossary.tsv | resources/bin/make_glossary_md.pl > docs/reference/glossary.md use File::Basename; my $prog = basename($0); From ff62ca6ba2c74c4c5e0836df8b65af6e62965674 Mon Sep 17 00:00:00 2001 From: Catalina A Date: Mon, 3 Feb 2025 11:46:06 +0200 Subject: [PATCH 03/14] additional link fix --- .../percona_platform/account-info.md | 4 ++-- .../percona_platform/check_percona_platform.md | 4 +--- .../baremetal/docker/isolated_hosts.md | 18 ++++++++++++------ 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/documentation/docs/configure-pmm/percona_platform/account-info.md b/documentation/docs/configure-pmm/percona_platform/account-info.md index 34cf59fc60..fdd22ffd9d 100644 --- a/documentation/docs/configure-pmm/percona_platform/account-info.md +++ b/documentation/docs/configure-pmm/percona_platform/account-info.md @@ -12,6 +12,6 @@ You can check the list of available Paid Advisor checks on the [Advisors details When you connect with a customer account, PMM reveals two new tabs on the main menu, where you can check all the information available for your customer accounts: **Entitlements** and **Support tickets**: -![!image](../images/CustomerTickets.png) +![!image](../../images/CustomerTickets.png) -![!image](../images/CustomerEntitlements.png) +![!image](../../images/CustomerEntitlements.png) 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 c1e31ff097..858d8f2291 100644 --- a/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md +++ b/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md @@ -19,11 +19,9 @@ To confirm that you have successfully connected the server and check the list of ## Check Percona Portal entitlements -After connecting to the Percona Platform, PMM has access to [additional alert templates](/docs/alert/templates_list.md), [Advisor checks](/docs/advisors/advisors-details.md), and account information. See [Check Percona Portal account information](account-info.md). +After connecting to the Percona Platform, PMM has access to [additional alert templates](../../alert/templates_list.md), [Advisor checks](../../advisors/advisors-details.md), and account information. See [Check Percona Portal account information](account-info.md). -After connecting to the Percona Platform, PMM has access to additional alert templates, Advisor checks, and account information. See [Check Percona Portal account information](account-info.md). - ### Disconnect a PMM instance Disconnect a PMM instance when you want to unlink it from your Percona Platform organization or stop monitoring it there. diff --git a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/isolated_hosts.md b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/isolated_hosts.md index 36fefba404..3a4ace3ab4 100644 --- a/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/isolated_hosts.md +++ b/documentation/docs/install-pmm/install-pmm-server/baremetal/docker/isolated_hosts.md @@ -1,10 +1,9 @@ - # Isolated hosts -If the host where you will run PMM Server has no internet connection, you can download the Docker image on a separate (internet-connected) host and securely copy it. +If the host where you will run [PMM Server][Docker image] has no internet connection, you can download the Docker image on a separate (internet-connected) host and securely copy it. {.power-number} -1. On an internet-connected host, download the Docker image and its checksum file. +1. On an internet-connected host, download the [Docker][Docker] image and its checksum file: ```sh wget https://downloads.percona.com/downloads/pmm/{{release}}/docker/pmm-server-{{release}}.docker @@ -15,13 +14,13 @@ If the host where you will run PMM Server has no internet connection, you can do 3. Open a terminal on the PMM Server host. -4. (Optional) Check the Docker image file integrity. +4. (Optional) Check the Docker image file integrity: ```sh shasum -ca 256 pmm-server-{{release}}.sha256sum ``` -5. Load the image. +5. Load the image: ```sh docker load -i pmm-server-{{release}}.docker @@ -29,6 +28,13 @@ If the host where you will run PMM Server has no internet connection, you can do 6. [Run the container](index.md#run-docker-container) as if your image is already pulled using your desired method for a storage volume (you can step over any docker pull commands as the image has been pre-staged). +For more information, see: +- [Docker installation guide][Docker] +- [Docker Compose installation][Docker compose] +- [PMM Server Docker tags][tags] +- [PMM Client Docker setup][PMMC_COMPOSE] +- [Setting up trusted certificates][trusted certificate] +- [Easy installation script][Easy-install script] [tags]: https://hub.docker.com/r/percona/pmm-server/tags [Docker]: https://docs.docker.com/get-docker/ @@ -36,4 +42,4 @@ If the host where you will run PMM Server has no internet connection, you can do [Docker compose]: https://docs.docker.com/compose/ [PMMC_COMPOSE]: ../../../install-pmm-client/docker.md [trusted certificate]: ../../../../how-to/secure.md#ssl-encryption -[Easy-install script]: easy-install.md +[Easy-install script]: easy-install.md \ No newline at end of file From 9dea30f68a3a50f9b0ef5f4b362329e9ed94acc3 Mon Sep 17 00:00:00 2001 From: Catalina A Date: Mon, 3 Feb 2025 13:33:36 +0200 Subject: [PATCH 04/14] feedback from Matthew --- documentation/docs/install-pmm/index.md | 42 +++++++-------- .../connect-database/mysql.md | 51 +++++++++++-------- documentation/docs/reference/faq.md | 27 ++++++---- documentation/docs/reference/index.md | 2 +- documentation/docs/use/qan/share_link.md | 4 -- 5 files changed, 68 insertions(+), 58 deletions(-) diff --git a/documentation/docs/install-pmm/index.md b/documentation/docs/install-pmm/index.md index 20f4b700f7..b564b5102a 100644 --- a/documentation/docs/install-pmm/index.md +++ b/documentation/docs/install-pmm/index.md @@ -31,15 +31,15 @@ The installation choices are: === "With Docker" - - [Docker installation](install-pmm-client/docker.md) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64). + - [Docker installation](../install-pmm/install-pmm-client/docker.md) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64). === "With package manager" - - [Linux package](install-pmm-client/package_manager.md). Use `apt`, `apt-get`, `dnf`, `yum`. The package manager automatically selects the correct version for your architecture. + - [Linux package](../install-pmm/install-pmm-client/package_manager.md). Use `apt`, `apt-get`, `dnf`, `yum`. The package manager automatically selects the correct version for your architecture. === "With binary package" - - [Binary package](install-pmm-client/binary_package.md): Download the appropriate `.tar.gz` file for your architecture (x86_64 or ARM64). + - [Binary package](../install-pmm/install-pmm-client/binary_package.md): Download the appropriate `.tar.gz` file for your architecture (x86_64 or ARM64). !!! hint alert "Tips" @@ -63,21 +63,21 @@ On each PMM Client instance, configure the nodes and services you want to monito - [HAProxy]; - [Remote instances]. -[MySQL]: install-pmm-client/mysql.md -[MongoDB]: install-pmm-client/mongodb.md -[PostgreSQL]: install-pmm-client/postgresql.md -[ProxySQL]: install-pmm-client/proxysql.md -[Amazon RDS]: install-pmm-client/aws.md -[Microsoft Azure]: install-pmm-client/azure.md -[Google Cloud Platform]: install-pmm-client/google.md -[Linux]: install-pmm-client/linux.md -[External services]: install-pmm-client/external.md -[HAProxy]: install-pmm-client/haproxy.md -[Remote instances]: install-pmm-client/remote.md -[dashboards]: ../use/dashboards-panels/index.md -[Docker]: ../install-pmm/install-pmm-server/baremetal/docker/index.md -[Podman]: ../install-pmm/install-pmm-server/baremetal/podman/index.md -[Helm]: ../install-pmm/install-pmm-server/baremetal/helm/index.md -[virtual appliance]: ../install-pmm/install-pmm-server/baremetal/virtual/index.md -[Amazon AWS]: ../install-pmm/install-pmm-server/aws/aws.md -[easy install]: ../install-pmm/install-pmm-server/baremetal/easy-install.md +[MySQL]: install-pmm/install-pmm-client/connect-database/mysql.md +[MongoDB]: install-pmm/install-pmm-client/connect-database/mongodb.md +[PostgreSQL]: install-pmm/install-pmm-client/connect-database/postgresql.md +[ProxySQL]: install-pmm/install-pmm-client/connect-database/proxysql.md +[Amazon RDS]: install-pmm/install-pmm-client/connect-database/aws.md +[Microsoft Azure]: install-pmm/install-pmm-client/connect-database/azure.md +[Google Cloud Platform]: install-pmm/install-pmm-client/connect-database/google.md +[Linux]: install-pmm/install-pmm-client/connect-database/linux.md +[External services]: install-pmm-client/connect-database/external.md +[HAProxy]: install-pmm/install-pmm-client/connect-database/haproxy.md +[Remote instances]: install-pmm/install-pmm-client/connect-database/remote.md +[dashboards]: use/dashboards-panels/index.md +[Docker]: install-pmm/install-pmm-server/baremetal/docker/index.md +[Podman]: install-pmm/install-pmm-server/baremetal/podman/index.md +[Helm]: install-pmm/install-pmm-server/baremetal/helm/index.md +[virtual appliance]: install-pmm/install-pmm-server/baremetal/virtual/index.md +[Amazon AWS]: install-pmm/install-pmm-server/aws/aws.md +[easy install]: install-pmm/install-pmm-server/baremetal/docker/easy-install.md diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md index 4c6f51d8e9..e3c3bf9e3f 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md @@ -102,7 +102,7 @@ The *slow query log* records the details of queries that take more than a certai ??? info "Examples" - - Configuration file. + - Configuration file: ```ini slow_query_log=ON @@ -112,7 +112,7 @@ The *slow query log* records the details of queries that take more than a certai log_slow_slave_statements=ON ``` - - Session. + - Session: ```sql SET GLOBAL slow_query_log = 1; @@ -146,7 +146,7 @@ Some MySQL-based database servers support extended slow query log variables. ??? info "Examples" - - Configuration file (Percona Server for MySQL, Percona XtraDB Cluster). + - Configuration file (Percona Server for MySQL, Percona XtraDB Cluster): ```sh log_slow_rate_limit=100 @@ -156,13 +156,13 @@ Some MySQL-based database servers support extended slow query log variables. slow_query_log_use_global_control='all' ``` - - Configuration file (MariaDB). + - Configuration file (MariaDB): ```sh log_slow_rate_limit=100 ``` - - Session (Percona Server for MySQL, Percona XtraDB Cluster). + - Session (Percona Server for MySQL, Percona XtraDB Cluster): ```sh SET GLOBAL log_slow_rate_limit = 100; @@ -202,7 +202,7 @@ This section covers how to configure a MySQL-based database server to use *Perfo PMM's [*MySQL Performance Schema Details* dashboard](../../../use/dashboards/dashboard-mysql-performance-schema-details.md) charts the various [`performance_schema`][performance-schema-startup-configuration] metrics. -To use *Performance Schema*, set these variables. +To use **Performance Schema**, set these variables: | Variable | Value | Description |--------------------------------------------------------------------------------------------|--------------------|--------------------------------------------------------------------------------- @@ -213,7 +213,7 @@ To use *Performance Schema*, set these variables. ??? info "Examples" - - Configuration file. + - Configuration file: ```ini performance_schema=ON @@ -222,7 +222,7 @@ To use *Performance Schema*, set these variables. innodb_monitor_enable=all ``` - - Session. + - Session: (`performance_schema` cannot be set in a session and must be set at server start-up.) @@ -276,7 +276,7 @@ Set this variable to see query time distribution charts. |-------------------------------------------------------------|-------|----------------------------------------------------------------------------------- | [`query_response_time_stats`][ps_query_response_time_stats] | ON | Report *query response time distributions*. (Requires plugin installation. See below.) -- Configuration file. +- Configuration file: ```ini query_response_time_stats=ON @@ -285,6 +285,8 @@ Set this variable to see query time distribution charts. You must also install the plugins. - **Session** + Before installing the plugins, ensure you have the necessary plugin files and run these commands in your MySQL session: + {.power-number} 1. Check that `/usr/lib/mysql/plugin/query_response_time.so` exists. 2. Install the plugins and activate. @@ -347,6 +349,7 @@ User activity, individual table and index access details are shown on the [MySQL ## Add service There are two ways to install PMM Client for monitoring your MySQL database: +{.power-number} 1. [Local installation](#Install-PMM-Client locally): Installs PMM Client directly on the database node, collecting both database and OS/host metrics. This option enables more effective comparison and problem identification. 2. [Remote instance](#Install-PMM-Client-as-a-remote-instance): Use when local installation isn't possible. This method doesn't provide OS/Node metrics in PMM. @@ -356,6 +359,7 @@ There are two ways to install PMM Client for monitoring your MySQL database: Add the MySQL server as a service using one of the following example commands. Upon successful addition, PMM Client will display "MySQL Service added" along with the service's ID and name. +{.power-number} 1. Select **PMM Configuration > PMM Inventory > Add Service > MySQL**. @@ -363,9 +367,9 @@ Upon successful addition, PMM Client will display "MySQL Service added" along wi 3. Click **Add service**. -![!](../../../images/PMM_Add_Instance_MySQL.jpg) + ![!](../../../images/PMM_Add_Instance_MySQL.jpg) -If your MySQL instance is configured to use TLS, click on the *Use TLS for database connections* check box and fill in your TLS certificates and key. +If your MySQL instance is configured to use TLS, click on the **Use TLS for database connections*** check box and fill in your TLS certificates and key: ![!](../../../images/PMM_Add_Instance_MySQL_TLS.jpg) @@ -382,6 +386,8 @@ pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --usern ``` ### Install PMM Client as a remote instance +If you need to monitor a MySQL instance from a different server where PMM Client is installed, follow these steps in the PMM web interface: +{.power-number} 1. Select ** PMM Configuration > PMM Inventory > {{icon.addinstance}} Add Service**. @@ -391,16 +397,17 @@ pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --usern 4. Click **Add service**. -![!](../../images/PMM_Add_Instance_MySQL.png) + ![!](../../../images/PMM_Add_Instance_MySQL.png) #### For MySQL instances using TLS If your MySQL instance is configured to use TLS: +{.power-number} 1. Click on the **Use TLS for database connections** check box. 2. Fill in your TLS certificates and key. -![!](../../images/PMM_Add_Instance_MySQL_TLS.png) + ![!](../../../images/PMM_Add_Instance_MySQL_TLS.png) ## Check the service @@ -451,8 +458,8 @@ Open the [*PXC/Galera Cluster Summary* dashboard][DASH_PXCGALERACLUSTER]. - [Percona Blog -- Impact of logging on MySQL's performance][BLOG_LOGGING] - [Percona Blog -- Running Custom MySQL Queries in Percona Monitoring and Management][BLOG_CUSTOM_QUERIES_MYSQL] -[DASH_MYSQLUSERDETAILS]: ../../../use/dashboards/dashboard-mysql-user-details.md -[DASH_PXCGALERACLUSTER]: ../../../use/dashboards/dashboard-pxc-galera-cluster-summary.md +[DASH_MYSQLUSERDETAILS]: ../../../reference/dashboards/dashboard-mysql-user-details.md +[DASH_PXCGALERACLUSTER]: ../../../reference/dashboards/dashboard-pxc-galera-cluster-summary.md [LOGROTATE]: https://linux.die.net/man/8/logrotate [PERCONA_SERVER_MYSQL]: https://www.percona.com/software/mysql-database/percona-server [PERCONA_XTRADB_CLUSTER]: https://www.percona.com/software/mysql-database/percona-xtradb-cluster @@ -464,19 +471,19 @@ Open the [*PXC/Galera Cluster Summary* dashboard][DASH_PXCGALERACLUSTER]. [BLOG_LOG_ROTATION]: https://www.percona.com/blog/2013/04/18/rotating-mysql-slow-logs-safely/ [BLOG_PS_VS_SLOW]: https://www.percona.com/blog/2014/02/11/performance_schema-vs-slow-query-log/ [PS_FEATURES_REMOVED]: https://www.percona.com/doc/percona-server/LATEST/changed_in_version.html -[ps_slow_query_ext]: https://www.percona.com/doc/percona-server/LATEST/diagnostics/slow_extended.html +[ps_slow_query_ext]: https://docs.percona.com/percona-server/latest/slow-extended.html [ps_query_response_time_stats]: https://www.percona.com/doc/percona-server/5.7/diagnostics/response_time_distribution.html#usage -[ps_userstats]: https://www.percona.com/doc/percona-server/LATEST/diagnostics/user_stats.html +[ps_userstats]: https://docs.percona.com/percona-server/latest/user-stats.html [mariadb_slow_query_log]: https://mariadb.com/kb/en/slow-query-log-overview/ [mariadb_slow_query_ext]: https://mariadb.com/kb/en/slow-query-log-extended-statistics/ [mariadb_query_response_time]: https://mariadb.com/kb/en/query-response-time-plugin/ [mariadb_perfschema_instr_table]: https://mariadb.com/kb/en/performance-schema-setup_instruments-table/ [mariadb_userstats]: https://mariadb.com/kb/en/user-statistics/ -[log_slow_rate_limit]: https://www.percona.com/doc/percona-server/LATEST/diagnostics/slow_extended.html#log_slow_rate_limit -[log_slow_rate_type]: https://www.percona.com/doc/percona-server/LATEST/diagnostics/slow_extended.html#log_slow_rate_type -[log_slow_verbosity]: https://www.percona.com/doc/percona-server/LATEST/diagnostics/slow_extended.html#log_slow_verbosity -[slow_query_log_always_write_time]: https://www.percona.com/doc/percona-server/LATEST/diagnostics/slow_extended.html#slow_query_log_always_write_time -[slow_query_log_use_global_control]: https://www.percona.com/doc/percona-server/LATEST/diagnostics/slow_extended.html#slow_query_log_use_global_control +[log_slow_rate_limit]: https://www.percona.com/doc/percona-server/LATEST/slow-extended.html?h=log_slow_rate_limit#log_slow_rate_limit +[log_slow_rate_type]: https://docs.percona.com/percona-server/latest/slow-extended.html?h=log_slow_rate_limit#log_slow_rate_limit +[log_slow_verbosity]: https://docs.percona.com/percona-server/latest/slow-extended.html?h=log_slow_rate_limit#log_slow_verbosity +[slow_query_log_always_write_time]: https://docs.percona.com/percona-server/latest/slow-extended.html?h=log_slow_rate_limit#slow_query_log_always_write_time +[slow_query_log_use_global_control]: https://docs.percona.com/percona-server/latest/slow-extended.html?h=log_slow_rate_limit#slow_query_log_use_global_control [sysvar_innodb_monitor_enable]: https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_monitor_enable [sysvar_log_output]: https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_log_output [sysvar_log_slow_admin_statements]: https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_log_slow_admin_statements diff --git a/documentation/docs/reference/faq.md b/documentation/docs/reference/faq.md index f1890ac57f..2c91a10a0c 100644 --- a/documentation/docs/reference/faq.md +++ b/documentation/docs/reference/faq.md @@ -7,16 +7,23 @@ ## What are the minimum system requirements? -- Server: - - Disk: 1 GB per monitored database (1 week data retention) - - Memory: 2 GB per monitored database - - CPU: Supports [`SSE4.2`](https://wikipedia.org/wiki/SSE4#SSE4.2) -- Client: - - Disk: 100 MB - -!!! seealso alert alert-info "See also" - - [Setting up PMM Server](../install-pmm/install-pmm-server/index.md) - - [Setting up PMM Client](../install-pmm/install-pmm-client/index.md) +See our detailed guides: + +- [PMM hardware and system requirements](../install-pmm/plan-pmm-installation/hardware_and_system.md) for complete specifications +- [Setting up PMM Server](../install-pmm/install-pmm-server/index.md) for server installation +- [Setting up PMM Client](../install-pmm/install-pmm-client/index.md) for client setup + +Quick reference for typical deployment (up to 30 nodes): +- **Server**: + - CPU: 4 cores (must support SSE4.2) + - Memory: 8 GB + - Storage: 100 GB (approximately 1 GB per node per week) +- **Client**: + - Storage: 100 MB + - Supports x86_64 and ARM64 architectures + +!!! note alert alert-info "Note" + For larger deployments (200+ nodes) or longer retention periods, see our [Hardware and system requirements](../install-pmm/plan-pmm-installation/hardware_and_system.md) for detailed sizing recommendations. ## How can I upgrade from version 2? diff --git a/documentation/docs/reference/index.md b/documentation/docs/reference/index.md index cf6c397815..eb0704063c 100644 --- a/documentation/docs/reference/index.md +++ b/documentation/docs/reference/index.md @@ -8,7 +8,7 @@ PMM is a client/server application built by Percona comprising its own and third ## PMM Server -PMM Server is the heart of PMM. It receives data from clients, collects it, and stores it. Metrics are drawn as tables, charts and graphs within [_dashboards_](../use/dashboards-panels/index.md), each a part of the web-based [user interface](../reference/ui/index.md). +PMM Server is the heart of PMM. It receives data from clients, collects it, and stores it. Metrics are drawn as tables, charts and graphs within [_dashboards_](../use/dashboards-panels/index.md), each a part of the web-based [user interface](../reference/ui/ui_components.md). ## PMM Client diff --git a/documentation/docs/use/qan/share_link.md b/documentation/docs/use/qan/share_link.md index 36530b6d5a..10e9affd70 100644 --- a/documentation/docs/use/qan/share_link.md +++ b/documentation/docs/use/qan/share_link.md @@ -9,7 +9,3 @@ To share a link for Query Analytics, use **Copy Link**. It copies the link to th ![!image](../../images/PMM_Query_Analytics_Share_Link.jpg) - -[SLOW_QUERY_LOG]: ../../install-pmm/install-pmm-client/connect-database/mysql.md#slow-query-log -[PERFORMANCE_SCHEMA]: ../../install-pmm/install-pmm-client/connect-database/mysql.md#performance-schema - From 53f04e1c1068d24f33fcfe600160ea2adc2d81a5 Mon Sep 17 00:00:00 2001 From: Catalina A Date: Mon, 3 Feb 2025 13:51:07 +0200 Subject: [PATCH 05/14] PMM install links --- documentation/docs/install-pmm/index.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/documentation/docs/install-pmm/index.md b/documentation/docs/install-pmm/index.md index b564b5102a..df483b68a1 100644 --- a/documentation/docs/install-pmm/index.md +++ b/documentation/docs/install-pmm/index.md @@ -17,11 +17,11 @@ Install and run at least one PMM Server. Choose from the following options: | Use | :material-thumb-up: **Benefits** | :material-thumb-down: **Drawbacks**| |---|---|--- -| [Docker] | 1. Quick
2. Simple
3. Rootless | Additional network configuration required. -| [Podman] | 1. Quick
2. Simple
3. Rootless | Podman installation required. -| [Helm] (Technical Preview) | 1. Quick
2. Simple
3. Cloud-compatible
4. Rootless| Requires running a Kubernetes cluster. -| [Virtual appliance] | 1. Easily import into Hypervisor of your choice
2. Rootless| More system resources compared to Docker footprint. -| [Amazon AWS] | 1. Wizard-driven install.
2. Rootless| Paid, incurs infrastructure costs. +| [Docker](../install-pmm/install-pmm-server/baremetal/docker/index.md) | 1. Quick
2. Simple
3. Rootless | Additional network configuration required. +| [Podman](../install-pmm/install-pmm-server/baremetal/podman/index.md) | 1. Quick
2. Simple
3. Rootless | Podman installation required. +| [Helm](../install-pmm/install-pmm-server/baremetal/helm/index.md) (Technical Preview) | 1. Quick
2. Simple
3. Cloud-compatible
4. Rootless| Requires running a Kubernetes cluster. +| [Virtual appliance](../install-pmm/install-pmm-server/baremetal/virtual/index.md) | 1. Easily import into Hypervisor of your choice
2. Rootless| More system resources compared to Docker footprint. +| [Amazon AWS](../install-pmm/install-pmm-server/aws/aws.md) | 1. Wizard-driven install.
2. Rootless| Paid, incurs infrastructure costs. ## Install PMM Client @@ -31,15 +31,15 @@ The installation choices are: === "With Docker" - - [Docker installation](../install-pmm/install-pmm-client/docker.md) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64). + [Docker installation](../install-pmm/install-pmm-client/docker.md) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64). === "With package manager" - - [Linux package](../install-pmm/install-pmm-client/package_manager.md). Use `apt`, `apt-get`, `dnf`, `yum`. The package manager automatically selects the correct version for your architecture. + [Linux package](../install-pmm/install-pmm-client/package_manager.md). Use `apt`, `apt-get`, `dnf`, `yum`. The package manager automatically selects the correct version for your architecture. === "With binary package" - - [Binary package](../install-pmm/install-pmm-client/binary_package.md): Download the appropriate `.tar.gz` file for your architecture (x86_64 or ARM64). + [Binary package](../install-pmm/install-pmm-client/binary_package.md): Download the appropriate `.tar.gz` file for your architecture (x86_64 or ARM64). !!! hint alert "Tips" @@ -75,8 +75,6 @@ On each PMM Client instance, configure the nodes and services you want to monito [HAProxy]: install-pmm/install-pmm-client/connect-database/haproxy.md [Remote instances]: install-pmm/install-pmm-client/connect-database/remote.md [dashboards]: use/dashboards-panels/index.md -[Docker]: install-pmm/install-pmm-server/baremetal/docker/index.md -[Podman]: install-pmm/install-pmm-server/baremetal/podman/index.md [Helm]: install-pmm/install-pmm-server/baremetal/helm/index.md [virtual appliance]: install-pmm/install-pmm-server/baremetal/virtual/index.md [Amazon AWS]: install-pmm/install-pmm-server/aws/aws.md From 58d6e3084d386379c9153e1762d5c6e7a33bceb0 Mon Sep 17 00:00:00 2001 From: Catalina A Date: Mon, 3 Feb 2025 14:13:38 +0200 Subject: [PATCH 06/14] typo --- documentation/docs/install-pmm/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/docs/install-pmm/index.md b/documentation/docs/install-pmm/index.md index df483b68a1..60a8505cf6 100644 --- a/documentation/docs/install-pmm/index.md +++ b/documentation/docs/install-pmm/index.md @@ -35,7 +35,7 @@ The installation choices are: === "With package manager" - [Linux package](../install-pmm/install-pmm-client/package_manager.md). Use `apt`, `apt-get`, `dnf`, `yum`. The package manager automatically selects the correct version for your architecture. + [Linux package](../install-pmm/install-pmm-client/package_manager.md): Use `apt`, `apt-get`, `dnf`, `yum`. The package manager automatically selects the correct version for your architecture. === "With binary package" @@ -78,4 +78,4 @@ On each PMM Client instance, configure the nodes and services you want to monito [Helm]: install-pmm/install-pmm-server/baremetal/helm/index.md [virtual appliance]: install-pmm/install-pmm-server/baremetal/virtual/index.md [Amazon AWS]: install-pmm/install-pmm-server/aws/aws.md -[easy install]: install-pmm/install-pmm-server/baremetal/docker/easy-install.md +[Easy install]: install-pmm/install-pmm-server/baremetal/docker/easy-install.md From ca1f9ee27d0b6c2f3c7a1e93dbaf7adfdb01f7a3 Mon Sep 17 00:00:00 2001 From: Catalina A Date: Mon, 3 Feb 2025 14:29:31 +0200 Subject: [PATCH 07/14] updated ToC reference --- documentation/mkdocs-base.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/mkdocs-base.yml b/documentation/mkdocs-base.yml index 7c479b8177..f82ecbf694 100644 --- a/documentation/mkdocs-base.yml +++ b/documentation/mkdocs-base.yml @@ -189,7 +189,7 @@ nav: - install-pmm/install-pmm-client/index.md - install-pmm/install-pmm-client/prerequisites.md - Percona repositories: install-pmm/install-pmm-client/package_manager.md - - Images: install-pmm/install-pmm-client/docker.md + - Docker: install-pmm/install-pmm-client/docker.md - Manual binaries: install-pmm/install-pmm-client/binary_package.md - Register Client node: install-pmm/register-client-node/index.md - Add services to PMM: From 9e47f86e72c0623ee83ef8bb81ac2403102a85e7 Mon Sep 17 00:00:00 2001 From: Catalina A Date: Mon, 3 Feb 2025 14:37:05 +0200 Subject: [PATCH 08/14] improve title --- documentation/docs/install-pmm/index.md | 4 +++- documentation/docs/install-pmm/install-pmm-client/docker.md | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/documentation/docs/install-pmm/index.md b/documentation/docs/install-pmm/index.md index 60a8505cf6..9a9d58ece6 100644 --- a/documentation/docs/install-pmm/index.md +++ b/documentation/docs/install-pmm/index.md @@ -27,11 +27,13 @@ Install and run at least one PMM Server. Choose from the following options: Install and run PMM Client on every node where there is a service you want to monitor. PMM Client now supports both x86_64 and ARM64 architectures. +[Docker installation](../install-pmm/install-pmm-client/docker.md): + The installation choices are: === "With Docker" - [Docker installation](../install-pmm/install-pmm-client/docker.md) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64). + [Running PMM Client as a Docker container](../install-pmm/install-pmm-client/docker.md) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64). === "With package manager" diff --git a/documentation/docs/install-pmm/install-pmm-client/docker.md b/documentation/docs/install-pmm/install-pmm-client/docker.md index 71fb4f785a..0cc00ce2a4 100644 --- a/documentation/docs/install-pmm/install-pmm-client/docker.md +++ b/documentation/docs/install-pmm/install-pmm-client/docker.md @@ -1,4 +1,4 @@ -# Run PMM client as a Docker container +# Run PMM Client as a Docker container The [PMM Client Docker image](https://hub.docker.com/r/percona/pmm-client/tags/) is a convenient way to run PMM Client as a preconfigured [Docker](https://docs.docker.com/get-docker/) container. From dbd10e6e7f12aea861f6562be03b7e08153e27dd Mon Sep 17 00:00:00 2001 From: Catalina A Date: Mon, 3 Feb 2025 14:44:54 +0200 Subject: [PATCH 09/14] changed links --- documentation/docs/install-pmm/index.md | 41 +++++++------------------ 1 file changed, 11 insertions(+), 30 deletions(-) diff --git a/documentation/docs/install-pmm/index.md b/documentation/docs/install-pmm/index.md index 9a9d58ece6..c25513dc10 100644 --- a/documentation/docs/install-pmm/index.md +++ b/documentation/docs/install-pmm/index.md @@ -27,8 +27,6 @@ Install and run at least one PMM Server. Choose from the following options: Install and run PMM Client on every node where there is a service you want to monitor. PMM Client now supports both x86_64 and ARM64 architectures. -[Docker installation](../install-pmm/install-pmm-client/docker.md): - The installation choices are: === "With Docker" @@ -53,31 +51,14 @@ On each PMM Client instance, configure the nodes and services you want to monito ??? info "Which services you can monitor?" - - [MySQL] (and variants: Percona Server for MySQL, Percona XtraDB Cluster, MariaDB); - - [MongoDB]; - - [PostgreSQL]; - - [ProxySQL]; - - [Amazon RDS]; - - [Microsoft Azure]; - - [Google Cloud Platform] (MySQL and PostgreSQL); - - [Linux]; - - [External services]; - - [HAProxy]; - - [Remote instances]. - -[MySQL]: install-pmm/install-pmm-client/connect-database/mysql.md -[MongoDB]: install-pmm/install-pmm-client/connect-database/mongodb.md -[PostgreSQL]: install-pmm/install-pmm-client/connect-database/postgresql.md -[ProxySQL]: install-pmm/install-pmm-client/connect-database/proxysql.md -[Amazon RDS]: install-pmm/install-pmm-client/connect-database/aws.md -[Microsoft Azure]: install-pmm/install-pmm-client/connect-database/azure.md -[Google Cloud Platform]: install-pmm/install-pmm-client/connect-database/google.md -[Linux]: install-pmm/install-pmm-client/connect-database/linux.md -[External services]: install-pmm-client/connect-database/external.md -[HAProxy]: install-pmm/install-pmm-client/connect-database/haproxy.md -[Remote instances]: install-pmm/install-pmm-client/connect-database/remote.md -[dashboards]: use/dashboards-panels/index.md -[Helm]: install-pmm/install-pmm-server/baremetal/helm/index.md -[virtual appliance]: install-pmm/install-pmm-server/baremetal/virtual/index.md -[Amazon AWS]: install-pmm/install-pmm-server/aws/aws.md -[Easy install]: install-pmm/install-pmm-server/baremetal/docker/easy-install.md + - [MySQL](../install-pmm/install-pmm-client/connect-database/mysql.md) and variants: Percona Server for MySQL, Percona XtraDB Cluster, MariaDB + - [MongoDB](../install-pmm/install-pmm-client/connect-database/mongodb.md) + - [PostgreSQL](../install-pmm/install-pmm-client/connect-database/postgresql.md) + - [ProxySQL](../install-pmm/install-pmm-client/connect-database/proxysql.md) + - [Amazon RDS](../install-pmm/install-pmm-client/connect-database/aws.md) + - [Microsoft Azure](../install-pmm/install-pmm-client/connect-database/azure.md) + - [Google Cloud Platform](../install-pmm/install-pmm-client/connect-database/google.md) + - [Linux](../install-pmm/install-pmm-client/connect-database/linux.md) + - [External services](../install-pmm/install-pmm-client/connect-database/external.md) + - [HAProxy](../install-pmm/install-pmm-client/connect-database/haproxy.md) + - [Remote instances](../install-pmm/install-pmm-client/connect-database/remote)md From 1b0eb7359c4ee2a9e90ff8158d2d56a8565d14dd Mon Sep 17 00:00:00 2001 From: Catalina A Date: Mon, 3 Feb 2025 15:09:02 +0200 Subject: [PATCH 10/14] fixed anchors --- documentation/docs/install-pmm/index.md | 2 +- .../install-pmm-client/connect-database/mysql.md | 7 +++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/documentation/docs/install-pmm/index.md b/documentation/docs/install-pmm/index.md index c25513dc10..dee4bde54d 100644 --- a/documentation/docs/install-pmm/index.md +++ b/documentation/docs/install-pmm/index.md @@ -61,4 +61,4 @@ On each PMM Client instance, configure the nodes and services you want to monito - [Linux](../install-pmm/install-pmm-client/connect-database/linux.md) - [External services](../install-pmm/install-pmm-client/connect-database/external.md) - [HAProxy](../install-pmm/install-pmm-client/connect-database/haproxy.md) - - [Remote instances](../install-pmm/install-pmm-client/connect-database/remote)md + - [Remote instances](../install-pmm/install-pmm-client/connect-database/remote) diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md index e3c3bf9e3f..6f4385c34d 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md @@ -200,7 +200,7 @@ This section covers how to configure a MySQL-based database server to use *Perfo | Percona XtraDB Cluster | 5.6, 5.7, 8.0 | MariaDB | [10.3+][mariadb_perfschema_instr_table] -PMM's [*MySQL Performance Schema Details* dashboard](../../../use/dashboards/dashboard-mysql-performance-schema-details.md) charts the various [`performance_schema`][performance-schema-startup-configuration] metrics. +PMM's [*MySQL Performance Schema Details* dashboard](../../../reference/dashboards/dashboard-mysql-performance-schema-details.md) charts the various [`performance_schema`][performance-schema-startup-configuration] metrics. To use **Performance Schema**, set these variables: @@ -351,8 +351,8 @@ User activity, individual table and index access details are shown on the [MySQL There are two ways to install PMM Client for monitoring your MySQL database: {.power-number} -1. [Local installation](#Install-PMM-Client locally): Installs PMM Client directly on the database node, collecting both database and OS/host metrics. This option enables more effective comparison and problem identification. -2. [Remote instance](#Install-PMM-Client-as-a-remote-instance): Use when local installation isn't possible. This method doesn't provide OS/Node metrics in PMM. +1. [Local installation](#install-pmm-client-locally): Installs PMM Client directly on the database node, collecting both database and OS/host metrics. This option enables more effective comparison and problem identification. +2. [Remote instance](#install-pmm-client-as-a-remote-instance): Use when local installation isn't possible. This method doesn't provide OS/Node metrics in PMM. ### Install PMM Client locally @@ -377,7 +377,6 @@ If your MySQL instance is configured to use TLS, click on the **Use TLS for data Add the database server as a service using one of these example commands. If successful, PMM Client will print `MySQL Service added` with the service's ID and name. Use the `--environment` and `-custom-labels` options to set tags for the service to help identify them. -??? info "Examples" #### TLS connection From 7d9a7752477616def37850cc20fac350eaf444f8 Mon Sep 17 00:00:00 2001 From: Catalina A <94133018+catalinaadam@users.noreply.github.com> Date: Mon, 3 Feb 2025 15:41:46 +0200 Subject: [PATCH 11/14] Update documentation/docs/install-pmm/index.md Co-authored-by: Alex Demidoff --- documentation/docs/install-pmm/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/install-pmm/index.md b/documentation/docs/install-pmm/index.md index dee4bde54d..fcf59a7e4f 100644 --- a/documentation/docs/install-pmm/index.md +++ b/documentation/docs/install-pmm/index.md @@ -31,7 +31,7 @@ The installation choices are: === "With Docker" - [Running PMM Client as a Docker container](../install-pmm/install-pmm-client/docker.md) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64). + [Running PMM Client as a Docker container](../install-pmm/install-pmm-client/docker.html) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64). === "With package manager" From 017c63f0dd79b29414b77bfd1b281b05b525339c Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Mon, 3 Feb 2025 16:57:20 +0300 Subject: [PATCH 12/14] fix: docker.md rendering --- documentation/docs/install-pmm/index.md | 2 +- .../install-pmm/install-pmm-client/docker.md | 40 +++++++++---------- documentation/mkdocs-base.yml | 2 +- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/documentation/docs/install-pmm/index.md b/documentation/docs/install-pmm/index.md index fcf59a7e4f..dee4bde54d 100644 --- a/documentation/docs/install-pmm/index.md +++ b/documentation/docs/install-pmm/index.md @@ -31,7 +31,7 @@ The installation choices are: === "With Docker" - [Running PMM Client as a Docker container](../install-pmm/install-pmm-client/docker.html) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64). + [Running PMM Client as a Docker container](../install-pmm/install-pmm-client/docker.md) simplifies deployment across different architectures and automatically selects the appropriate image for your architecture (x86_64 or ARM64). === "With package manager" diff --git a/documentation/docs/install-pmm/install-pmm-client/docker.md b/documentation/docs/install-pmm/install-pmm-client/docker.md index 0cc00ce2a4..74c38e330f 100644 --- a/documentation/docs/install-pmm/install-pmm-client/docker.md +++ b/documentation/docs/install-pmm/install-pmm-client/docker.md @@ -8,34 +8,34 @@ The PMM Client Docker image is available for both x86_64 and ARM64 architectures 1. Pull the PMM Client Docker image: ```sh - docker pull \ - percona/pmm-client:3 + docker pull \ + percona/pmm-client:3 ``` 2. Use the image as a template to create a persistent data store that preserves local data when the image is updated: ```sh - docker create \ - --volume /srv \ - --name pmm-client-data \ - percona/pmm-client:3 /bin/true + docker create \ + --volume /srv \ + --name pmm-client-data \ + percona/pmm-client:3 /bin/true ``` 3. Run the container to start [pmm-agent](../../use/commands/pmm-agent.md) in setup mode. Set `X.X.X.X` to the IP address of your PMM Server. (Do not use the `docker --detach` option as PMM agent only logs to the console.) ```sh - PMM_SERVER=X.X.X.X:443 - docker run \ - --rm \ - --name pmm-client \ - -e PMM_AGENT_SERVER_ADDRESS=${PMM_SERVER} \ - -e PMM_AGENT_SERVER_USERNAME=admin \ - -e PMM_AGENT_SERVER_PASSWORD=admin \ - -e PMM_AGENT_SERVER_INSECURE_TLS=1 \ - -e PMM_AGENT_SETUP=1 \ - -e PMM_AGENT_CONFIG_FILE=config/pmm-agent.yaml \ - --volumes-from pmm-client-data \ - percona/pmm-client:3 + PMM_SERVER=X.X.X.X:443 + docker run \ + --rm \ + --name pmm-client \ + -e PMM_AGENT_SERVER_ADDRESS=${PMM_SERVER} \ + -e PMM_AGENT_SERVER_USERNAME=admin \ + -e PMM_AGENT_SERVER_PASSWORD=admin \ + -e PMM_AGENT_SERVER_INSECURE_TLS=1 \ + -e PMM_AGENT_SETUP=1 \ + -e PMM_AGENT_CONFIG_FILE=config/pmm-agent.yaml \ + --volumes-from pmm-client-data \ + percona/pmm-client:3 ``` !!! hint alert-success "Tips" You can find a complete list of compatible environment variables [here](../../use/commands/pmm-agent.md). @@ -43,8 +43,8 @@ The PMM Client Docker image is available for both x86_64 and ARM64 architectures 3. Check status. ```sh - docker exec pmm-client \ - pmm-admin status + docker exec pmm-client \ + pmm-admin status ``` In the PMM user interface you will also see an increase in the number of monitored nodes. diff --git a/documentation/mkdocs-base.yml b/documentation/mkdocs-base.yml index f82ecbf694..45a3a54913 100644 --- a/documentation/mkdocs-base.yml +++ b/documentation/mkdocs-base.yml @@ -118,7 +118,7 @@ plugins: # https://pypi.org/project/mkdocs-exclude/ exclude: glob: - - "install-pmm/install-pmm-client/docker.md" + # - "install-pmm/install-pmm-client/docker.md" mike: version_selector: true css_dir: css From a6ea41e4587f1f8540463158ab9b139e9fcffe90 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Mon, 3 Feb 2025 17:04:23 +0300 Subject: [PATCH 13/14] chore: make one-liners look better --- documentation/docs/install-pmm/install-pmm-client/docker.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/documentation/docs/install-pmm/install-pmm-client/docker.md b/documentation/docs/install-pmm/install-pmm-client/docker.md index 74c38e330f..4dc943773f 100644 --- a/documentation/docs/install-pmm/install-pmm-client/docker.md +++ b/documentation/docs/install-pmm/install-pmm-client/docker.md @@ -8,8 +8,7 @@ The PMM Client Docker image is available for both x86_64 and ARM64 architectures 1. Pull the PMM Client Docker image: ```sh - docker pull \ - percona/pmm-client:3 + docker pull percona/pmm-client:3 ``` 2. Use the image as a template to create a persistent data store that preserves local data when the image is updated: @@ -43,8 +42,7 @@ The PMM Client Docker image is available for both x86_64 and ARM64 architectures 3. Check status. ```sh - docker exec pmm-client \ - pmm-admin status + docker exec -t pmm-client pmm-admin status ``` In the PMM user interface you will also see an increase in the number of monitored nodes. From fb92860469226a852bbf7bfa401ee3e9f6f8fb66 Mon Sep 17 00:00:00 2001 From: Catalina A Date: Mon, 3 Feb 2025 16:08:32 +0200 Subject: [PATCH 14/14] fixed capitalization --- documentation/docs/install-pmm/install-pmm-client/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/install-pmm/install-pmm-client/index.md b/documentation/docs/install-pmm/install-pmm-client/index.md index 6d61e7b8a1..b0901faaab 100644 --- a/documentation/docs/install-pmm/install-pmm-client/index.md +++ b/documentation/docs/install-pmm/install-pmm-client/index.md @@ -1,4 +1,4 @@ -# About PMM client installation +# About PMM Client installation There are different ways to install PMM Client on a node and register it with PMM Server. Choose from: