From 3441e988dcb24685d88a4eb3813928983d21591a Mon Sep 17 00:00:00 2001 From: Roman Novikov Date: Fri, 15 Dec 2023 16:12:23 +0200 Subject: [PATCH 01/13] PMM-9966 [DOC] Documentation suggest wrong method of adding db instance to PMM --- docs/setting-up/client/mysql.md | 46 ++++++++++++++++++--------------- 1 file changed, 25 insertions(+), 21 deletions(-) diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index 6d20af6573..bd755a46e4 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -341,32 +341,19 @@ User activity, individual table and index access details are shown on the [MySQL ## Add service -When you have configured your database server, you can add a MySQL service with the user interface or on the command line. +There are two ways to install PMM Client to monitor your Database. +1. [By Installing PMM Client locally] - This option collects both database and OS/host metrics, allowing for more effective comparison between the two and better problem identification. +2. [As a Remote Instance] - This option should be used when it is not possible to install PMM Client on the Database node. It will not provide OS/Node metrics in PMM. -When adding a service with the command line, you must use the `pmm-admin --query-source=SOURCE` option to match the source you've chosen and configured the database server for. -With the PMM user interface, you select *Use performance schema*, or deselect it to use *slow query log*. - -### With the user interface - -1. Select *Configuration* → {{icon.inventory}} *Inventory* → {{icon.addinstance}} *Add Service*. - -2. Select *MySQL -- Add a remote instance*. - -3. Enter or select values for the fields. - -4. Click *Add service*. - -![!](../../_images/PMM_Add_Instance_MySQL.png) - -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.png) - -### On the command line +### By Installing PMM Client locally 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. +```sh +pmm-admin add mysql --username=pmm --password= MYSQL_SERVICE_NAME +``` + ### Examples #### TLS connection @@ -423,6 +410,23 @@ Default query source (`slowlog`), environment labeled `test`, custom labels sett pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --username=root --password=password --query-source=slowlog MySQLSlowLog localhost:3306 ``` +### As a Remote instance + +1. Select *Configuration* → {{icon.inventory}} *Inventory* → {{icon.addinstance}} *Add Service*. + +2. Select *MySQL -- Add a remote instance*. + +3. Enter or select values for the fields. + +4. Click *Add service*. + +![!](../../_images/PMM_Add_Instance_MySQL.png) + +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.png) + + ## Check the service ### PMM user interface From 78ead2bd882754e7b33455fa5ee0ecd2cf348601 Mon Sep 17 00:00:00 2001 From: Roman Novikov Date: Wed, 3 Jul 2024 11:18:50 +0300 Subject: [PATCH 02/13] Update docs/setting-up/client/mysql.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/setting-up/client/mysql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index bd755a46e4..77b8736e1a 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -341,7 +341,7 @@ User activity, individual table and index access details are shown on the [MySQL ## Add service -There are two ways to install PMM Client to monitor your Database. +There are two ways to install PMM Client for monitoring your MySQL database: 1. [By Installing PMM Client locally] - This option collects both database and OS/host metrics, allowing for more effective comparison between the two and better problem identification. 2. [As a Remote Instance] - This option should be used when it is not possible to install PMM Client on the Database node. It will not provide OS/Node metrics in PMM. From e13816e8762a681a01c70cbaa24cc764155f5ba6 Mon Sep 17 00:00:00 2001 From: Roman Novikov Date: Wed, 3 Jul 2024 11:18:59 +0300 Subject: [PATCH 03/13] Update docs/setting-up/client/mysql.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/setting-up/client/mysql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index 77b8736e1a..6d162e99ea 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -342,7 +342,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: -1. [By Installing PMM Client locally] - This option collects both database and OS/host metrics, allowing for more effective comparison between the two and better problem identification. +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. [As a Remote Instance] - This option should be used when it is not possible to install PMM Client on the Database node. It will not provide OS/Node metrics in PMM. From 1895778a11da2e0ce10fe6dfb633805d562ce73c Mon Sep 17 00:00:00 2001 From: Roman Novikov Date: Wed, 3 Jul 2024 11:19:07 +0300 Subject: [PATCH 04/13] Update docs/setting-up/client/mysql.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/setting-up/client/mysql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index 6d162e99ea..965730c9e0 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -346,7 +346,7 @@ There are two ways to install PMM Client for monitoring your MySQL database: 2. [As a Remote Instance] - This option should be used when it is not possible to install PMM Client on the Database node. It will not provide OS/Node metrics in PMM. -### By Installing PMM Client locally +### Install PMM Client locally 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. From c835d2b563ad8d1957de7f0f5ed56954b834750b Mon Sep 17 00:00:00 2001 From: Roman Novikov Date: Wed, 3 Jul 2024 11:19:16 +0300 Subject: [PATCH 05/13] Update docs/setting-up/client/mysql.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/setting-up/client/mysql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index 965730c9e0..63f354a3ec 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -343,7 +343,7 @@ 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: 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. [As a Remote Instance] - This option should be used when it is not possible to install PMM Client on the Database node. It will not provide OS/Node metrics in PMM. +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 From a718bca30578fd85b8acb14e9b69eabd06a57b53 Mon Sep 17 00:00:00 2001 From: Roman Novikov Date: Wed, 3 Jul 2024 11:19:22 +0300 Subject: [PATCH 06/13] Update docs/setting-up/client/mysql.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/setting-up/client/mysql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index 63f354a3ec..9ef3eb84e4 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -348,7 +348,7 @@ There are two ways to install PMM Client for monitoring your MySQL database: ### Install PMM Client locally -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. +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. Use --environment and --custom-labels options to set identifying tags for the service. ```sh pmm-admin add mysql --username=pmm --password= MYSQL_SERVICE_NAME From 8b58eb0e10ac4107a89f91da3d0c4d1ef9873240 Mon Sep 17 00:00:00 2001 From: Roman Novikov Date: Wed, 3 Jul 2024 11:19:31 +0300 Subject: [PATCH 07/13] Update docs/setting-up/client/mysql.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/setting-up/client/mysql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index 9ef3eb84e4..2782ac055e 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -412,7 +412,7 @@ pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --usern ### As a Remote instance -1. Select *Configuration* → {{icon.inventory}} *Inventory* → {{icon.addinstance}} *Add Service*. +1. Select **Configuration > {{icon.inventory}} Inventory >{{icon.addinstance}} Add Service**. 2. Select *MySQL -- Add a remote instance*. From bd31e82e194326f8125110a6691a161bac878bcf Mon Sep 17 00:00:00 2001 From: Roman Novikov Date: Wed, 3 Jul 2024 11:19:39 +0300 Subject: [PATCH 08/13] Update docs/setting-up/client/mysql.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/setting-up/client/mysql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index 2782ac055e..68f99ef026 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -354,7 +354,7 @@ Add the MySQL server as a service using one of the following example commands. U pmm-admin add mysql --username=pmm --password= MYSQL_SERVICE_NAME ``` -### Examples +### Example configurations #### TLS connection From 6606f6a35f6f5ca10f686c2ea5d45ca6c7acce8a Mon Sep 17 00:00:00 2001 From: Roman Novikov Date: Wed, 3 Jul 2024 11:19:49 +0300 Subject: [PATCH 09/13] Update docs/setting-up/client/mysql.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/setting-up/client/mysql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index 68f99ef026..8a18134f60 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -410,7 +410,7 @@ Default query source (`slowlog`), environment labeled `test`, custom labels sett pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --username=root --password=password --query-source=slowlog MySQLSlowLog localhost:3306 ``` -### As a Remote instance +### Install PMM Client as a remote instance 1. Select **Configuration > {{icon.inventory}} Inventory >{{icon.addinstance}} Add Service**. From b8d30e446506b2f0356e737c06e75339cb9138eb Mon Sep 17 00:00:00 2001 From: Roman Novikov Date: Wed, 3 Jul 2024 11:19:55 +0300 Subject: [PATCH 10/13] Update docs/setting-up/client/mysql.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/setting-up/client/mysql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index 8a18134f60..360ac7ab3a 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -414,7 +414,7 @@ pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --usern 1. Select **Configuration > {{icon.inventory}} Inventory >{{icon.addinstance}} Add Service**. -2. Select *MySQL -- Add a remote instance*. +2. Choose **MySQL > Add a remote instance**. 3. Enter or select values for the fields. From f9222a94ea557800f5e2c2a383f22448d11a7c4a Mon Sep 17 00:00:00 2001 From: Roman Novikov Date: Wed, 3 Jul 2024 11:20:00 +0300 Subject: [PATCH 11/13] Update docs/setting-up/client/mysql.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/setting-up/client/mysql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index 360ac7ab3a..b036b3c092 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -416,7 +416,7 @@ pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --usern 2. Choose **MySQL > Add a remote instance**. -3. Enter or select values for the fields. +3. Complete the required fields. 4. Click *Add service*. From e2fbf40beae1fb8c4b4e27b704bdec09bed0bd51 Mon Sep 17 00:00:00 2001 From: Roman Novikov Date: Wed, 3 Jul 2024 11:20:08 +0300 Subject: [PATCH 12/13] Update docs/setting-up/client/mysql.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/setting-up/client/mysql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index b036b3c092..bfc970db05 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -418,7 +418,7 @@ pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --usern 3. Complete the required fields. -4. Click *Add service*. +4. Click **Add service**. ![!](../../_images/PMM_Add_Instance_MySQL.png) From 41fdfd39e917f48ab7e3742149eb5ab35fc1956a Mon Sep 17 00:00:00 2001 From: Roman Novikov Date: Wed, 3 Jul 2024 11:20:22 +0300 Subject: [PATCH 13/13] Update docs/setting-up/client/mysql.md Co-authored-by: Catalina A <94133018+catalinaadam@users.noreply.github.com> --- docs/setting-up/client/mysql.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index bfc970db05..c03a0062ae 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -422,7 +422,12 @@ pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --usern ![!](../../_images/PMM_Add_Instance_MySQL.png) -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. +#### For MySQL instances using TLS + +If your MySQL instance is configured to use TLS: + +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)