From 36a893f6cef7a8873821891b416c8d7ff4299860 Mon Sep 17 00:00:00 2001 From: Catalina A <94133018+catalinaadam@users.noreply.github.com> Date: Mon, 22 Jul 2024 14:12:20 +0300 Subject: [PATCH 1/6] PMM-13251 --- .../dashboards/dashboard-manage-dashboards.md | 115 +++++++++--------- 1 file changed, 59 insertions(+), 56 deletions(-) diff --git a/docs/details/dashboards/dashboard-manage-dashboards.md b/docs/details/dashboards/dashboard-manage-dashboards.md index 46232e229d..c12c19fb3e 100644 --- a/docs/details/dashboards/dashboard-manage-dashboards.md +++ b/docs/details/dashboards/dashboard-manage-dashboards.md @@ -1,118 +1,121 @@ -# Manage dashboards +# Manage PMM dashboards +PMM offers various types of dashboards for monitoring and managing the performance of your databases: -This section describes how to manage your PMM dashboards and the widgets on those dashboards, including: +1. **Standard dashboards**: include database overviews, database-specific dashboards, query analytics, system-level metrics, replication, and high availability dashboards. These offer comprehensive insights into various aspects of your database environment. +2. **Experimental dashboards**: newer, or less stable dashboards that usually introduce new metrics or visualizations or monitoring approaches. +3. **Custom dashboards**: user-created dashboards tailored to specific metrics or needs, allowing you to combine data from different sources for customized monitoring and analysis. -- Creating dashboard folders +Standard and experimental dashboards are "provisioned dashboards", meaning they are: -- Managing dashboard folders +- created by PMM out of the box based on predefined configurations to ensure consistency across deployments. +- protected from editing through the UI to prevent accidental modifications. Trying to modify these dashboards via the UI will result in a `Cannot save provisioned dashboard` error. +- replaced during PMM upgrades, to ensure they are always up-to-date with the latest version. Any manual changes made by setting `allowUIUpdates: true` in `/usr/share/grafana/conf/provisioning/dashboards/default.yml` will be overwritten. -- Setting custom Home dashboard +Remember: +- Always work with cloned copies of PMM dashboards +- Changes to original PMM dashboards will be lost during updates +- Experimental dashboards may change more frequently, therefore consider re-cloning them after upgrades. ## Create dashboard folders -Folders help you organize and group PMM dashboards, which is crucial when you have multiple dashboards or teams using the same PMM instance. +Folders help you organize and group PMM dashboards, especially useful for numerous dashboards and multiple teams using the same PMM instance. -!!! note alert alert-primary "Note" - To create a dashboard folder, you must have PMM's *Admin* privileges. +To create a dashboard folder (requires **Admin** privileges): -To create a dashboard folder: +1. On the PMM dashboards page, from the side menu, go to **Dashboards > New folder**. -1. On the PMM dashboards page, from the side menu, go to *Dashboards > New folder*. +2. Enter a unique name for your folder and click **Create**. -2. Enter a unique name for your folder and click *Create*. - - -## Managing dashboard folders - -This section describes how to delete multiple dashboards, move dashboards from one folder to another and navigate to a folder page where you can assign folder and dashboard permissions. +## Manage dashboard folders ### Delete multiple dashboards To delete multiple dashboards at once: -From the side menu, go to *Dashboards > Browse* and check the dashboards that you want to delete, and click *Delete*. - +1. From the side menu, go to **Dashboards > Browse**. +2. Select the dashboards that you want to delete, and click **Delete**. -![!image](../../_images/PMM_Delete_multiple_dashboards.png) +### Move dashboards between folders -### Move dashboards from one folder to another +To move dashboards from one folder to another (requires **Editor** rights): -You can move dashboards from one folder to another in the following two ways: +#### Method 1 - -1. From the side menu, go to *Dashboards > Browse* and check the dashboards that you want to move. Click *Move*. +1. Go to **Dashboards > Browse**. +2. Select the dashboards that you want to move and click **Move**. ![!image](../../_images/PMM_Move_dashboards.png) -2. On the *Choose Dashboard Folder* dialog box select the dashboards that you want to move from the drop-down. Click *Move*. +3. On the **Choose Dashboard Folder** dialog box select the dashboards that you want to move from the drop-down. Click *Move*. -The other way of moving dashboards from one folder to another is: +#### Method 2 +The other way of moving dashboards from one folder to another is: 1. Open the dashboard that you want to move to another folder. -2. Click on {{icon.configuration}} icon to open *Dashboard Settings*. -3. On the *General* page, under *Folder* select the folder name that you want to move from the dropdown. +2. Click on {{icon.configuration}} icon to open **Dashboard Settings**. +3. On the **General** page, under **Folder** select the folder name that you want to move from the dropdown. ![!image](../../_images/PMM_Move_dashboards-way2.png) -4. Click *Save Dashboard* on the the left to save the change. - -!!! note alert alert-primary "Note" - You should have atleast an *Editor* role to move a dashboard. +4. Click *Save Dashboard* on the left. -### Navigate to a dashboard folder page to assign permissions +### Navigate to a dashboard folder page to assign folder permissions -1. From the side menu, go to *Dashboards > Browse* and hover over the dashboard folder whose permissions you want to set. Click *Go to Folder*. -2. Go to the *Permissions* tab and select the requisite permission from the drop-down for the various roles. +1. From the side menu, go to **Dashboards > Browse** and hover over the dashboard folder whose permissions you want to set. +2. Click **Go to Folder**. +3. Go to the **Permissions** tab and select the requisite permission from the drop-down for the various roles. ![!image](../../_images/PMM_Permissions_dashboards_folder.png) +## Edit dashboards -## Setting custom Home Dashboard +You cannot directly edit provisioned dashboards. Instead, clone the dashboard and edit or move the cloned dashboard freely: -The home dashboard you set is the dashboard all the users will see after logging in to PMM UI. You can set the home dashboard for a server, an organization, a team, or your user account. +1. Open the dashboard. +2. Click the settings icon. +3. Select **Save as** to create a copy. +4. Name your copy and choose where to save it. -### Set home dashboard for your organization +## Setting a custom Home dashboard + +The Home dashboard you set is the dashboard all the users will see after logging in to PMM UI. You can set the home dashboard for a server, an organization, a team, or your user account. + +### For your organization Organization Admins can set the home dashboard for their organization. For information on managing users in an organization, see [Manage Users](../../how-to/manage-users.md) 1. Navigate to the dashboard that you want to set as the home dashboard. 2. Click the star next to the dashboard title to mark the dashboard as a favorite. -3. Hover your cursor over {{icon.configuration}} *Configuration* -4. Click *Preferences*. -5. In the Home Dashboard field, select the dashboard that you want to set as your home dashboard. -6. Click *Save*. +3. Hover your cursor over {{icon.configuration}} **Configuration**. +4. Click **Preferences**. +5. In the **Home Dashboard** field, select the dashboard that you want to set as your home dashboard. +6. Click **Save**. +#### For a team -### Set home dashboard for your team - -Organization and team Admins can set the home dashboard for their team as follows: +Organization and team Admins can set the home dashboard for their team: 1. Navigate to the dashboard that you want to set as your home dashboard. 2. Click star next to the dashboard to mark the dashboard as a favorite. -3. On the main menu, hover your cursor over {{icon.configuration}} *Configuration*. -4. Click *Teams*. Grafana displays the team list. -5. Click on the team for whom you want to set the home dashboard and then navigate to the *Settings* tab. +3. On the main menu, hover your cursor over {{icon.configuration}} **Configuration**. +4. Click **Teams**. Grafana displays the team list. +5. Click on the team for whom you want to set the home dashboard and then navigate to the **Settings** tab. 6. In the Home Dashboard field, select the dashboard that you want to use for your home dashboard. -7. Click *Save*. - +7. Click **Save**. ### Set your Personal Home Dashboard -1. From the main menu, go to *Dashboards > Browse* and select the dashboard you want to set as your home dashboard. +1. From the main menu, go to **Dashboards > Browse** and select the dashboard you want to set as your home dashboard. 2. Click the star next to the dashboard title to mark it as a favorite. ![!image](../../_images/PMM_click_to_add_favorite_dashboard.png) - -3. From the side menu go to {{icon.configuration}} *Configuration > Preferences*. In the *Home Dashboard* field, select the dashboard that you want to set as your home dashboard. +3. From the side menu go to {{icon.configuration}} **Configuration > Preferences**. In the **Home Dashboard** field, select the dashboard that you want to set as your home dashboard. ![!image](../../_images/PMM_set_home_dashboard.png) -4. Click *Save*. - - - +4. Click **Save**. From 7e3eeff4e03472919fd21ac8b396e020c3c90c7a Mon Sep 17 00:00:00 2001 From: Catalina A <94133018+catalinaadam@users.noreply.github.com> Date: Mon, 22 Jul 2024 14:38:36 +0300 Subject: [PATCH 2/6] formatting --- .../dashboards/dashboard-manage-dashboards.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/docs/details/dashboards/dashboard-manage-dashboards.md b/docs/details/dashboards/dashboard-manage-dashboards.md index c12c19fb3e..d31c83c094 100644 --- a/docs/details/dashboards/dashboard-manage-dashboards.md +++ b/docs/details/dashboards/dashboard-manage-dashboards.md @@ -60,7 +60,7 @@ The other way of moving dashboards from one folder to another is: ![!image](../../_images/PMM_Move_dashboards-way2.png) -4. Click *Save Dashboard* on the left. +4. Click **Save Dashboard** on the left. ### Navigate to a dashboard folder page to assign folder permissions @@ -85,7 +85,7 @@ The Home dashboard you set is the dashboard all the users will see after logging ### For your organization -Organization Admins can set the home dashboard for their organization. For information on managing users in an organization, see [Manage Users](../../how-to/manage-users.md) +Organization Admins can set the home dashboard for their organization. For information on managing users in an organization, see [Manage Users](../../how-to/manage-users.md). 1. Navigate to the dashboard that you want to set as the home dashboard. 2. Click the star next to the dashboard title to mark the dashboard as a favorite. @@ -103,19 +103,15 @@ Organization and team Admins can set the home dashboard for their team: 3. On the main menu, hover your cursor over {{icon.configuration}} **Configuration**. 4. Click **Teams**. Grafana displays the team list. 5. Click on the team for whom you want to set the home dashboard and then navigate to the **Settings** tab. -6. In the Home Dashboard field, select the dashboard that you want to use for your home dashboard. +6. In the **Home Dashboard** field, select the dashboard that you want to use for your home dashboard. 7. Click **Save**. -### Set your Personal Home Dashboard +### Set your personal Home dashboard 1. From the main menu, go to **Dashboards > Browse** and select the dashboard you want to set as your home dashboard. 2. Click the star next to the dashboard title to mark it as a favorite. - - ![!image](../../_images/PMM_click_to_add_favorite_dashboard.png) - 3. From the side menu go to {{icon.configuration}} **Configuration > Preferences**. In the **Home Dashboard** field, select the dashboard that you want to set as your home dashboard. ![!image](../../_images/PMM_set_home_dashboard.png) -4. Click **Save**. - +4. Click **Save**. \ No newline at end of file From d09a6af00266662f443d0f34ef56a298bed8ab37 Mon Sep 17 00:00:00 2001 From: Catalina A <94133018+catalinaadam@users.noreply.github.com> Date: Mon, 22 Jul 2024 14:40:08 +0300 Subject: [PATCH 3/6] formatting --- docs/details/dashboards/dashboard-manage-dashboards.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/details/dashboards/dashboard-manage-dashboards.md b/docs/details/dashboards/dashboard-manage-dashboards.md index d31c83c094..c8e588ba35 100644 --- a/docs/details/dashboards/dashboard-manage-dashboards.md +++ b/docs/details/dashboards/dashboard-manage-dashboards.md @@ -48,7 +48,7 @@ To move dashboards from one folder to another (requires **Editor** rights): ![!image](../../_images/PMM_Move_dashboards.png) -3. On the **Choose Dashboard Folder** dialog box select the dashboards that you want to move from the drop-down. Click *Move*. +3. On the **Choose Dashboard Folder** dialog box select the dashboards that you want to move from the drop-down. Click **Move**. #### Method 2 @@ -56,7 +56,7 @@ The other way of moving dashboards from one folder to another is: 1. Open the dashboard that you want to move to another folder. 2. Click on {{icon.configuration}} icon to open **Dashboard Settings**. -3. On the **General** page, under **Folder** select the folder name that you want to move from the dropdown. +3. On the **General** page, under **Folder** select the folder name that you want to move from the drop-down menu. ![!image](../../_images/PMM_Move_dashboards-way2.png) From a2c2c3303af13177df654e5baf443b8537866af5 Mon Sep 17 00:00:00 2001 From: Catalina A <94133018+catalinaadam@users.noreply.github.com> Date: Tue, 23 Jul 2024 12:31:37 +0300 Subject: [PATCH 4/6] Update docs/details/dashboards/dashboard-manage-dashboards.md Co-authored-by: Roman Novikov --- docs/details/dashboards/dashboard-manage-dashboards.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/details/dashboards/dashboard-manage-dashboards.md b/docs/details/dashboards/dashboard-manage-dashboards.md index c8e588ba35..534d065df5 100644 --- a/docs/details/dashboards/dashboard-manage-dashboards.md +++ b/docs/details/dashboards/dashboard-manage-dashboards.md @@ -2,7 +2,7 @@ PMM offers various types of dashboards for monitoring and managing the performance of your databases: -1. **Standard dashboards**: include database overviews, database-specific dashboards, query analytics, system-level metrics, replication, and high availability dashboards. These offer comprehensive insights into various aspects of your database environment. +1. **Standard dashboards**: include database overviews, database-specific dashboards, system-level metrics, replication, and high availability dashboards. These offer comprehensive insights into various aspects of your database environment. 2. **Experimental dashboards**: newer, or less stable dashboards that usually introduce new metrics or visualizations or monitoring approaches. 3. **Custom dashboards**: user-created dashboards tailored to specific metrics or needs, allowing you to combine data from different sources for customized monitoring and analysis. From eed1fad4e8179c019fad09793d69046ebe9f8078 Mon Sep 17 00:00:00 2001 From: Catalina A <94133018+catalinaadam@users.noreply.github.com> Date: Tue, 23 Jul 2024 12:32:03 +0300 Subject: [PATCH 5/6] Update docs/details/dashboards/dashboard-manage-dashboards.md Co-authored-by: Nurlan Moldomurov --- docs/details/dashboards/dashboard-manage-dashboards.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/details/dashboards/dashboard-manage-dashboards.md b/docs/details/dashboards/dashboard-manage-dashboards.md index 534d065df5..84b8532548 100644 --- a/docs/details/dashboards/dashboard-manage-dashboards.md +++ b/docs/details/dashboards/dashboard-manage-dashboards.md @@ -10,7 +10,7 @@ Standard and experimental dashboards are "provisioned dashboards", meaning they - created by PMM out of the box based on predefined configurations to ensure consistency across deployments. - protected from editing through the UI to prevent accidental modifications. Trying to modify these dashboards via the UI will result in a `Cannot save provisioned dashboard` error. -- replaced during PMM upgrades, to ensure they are always up-to-date with the latest version. Any manual changes made by setting `allowUIUpdates: true` in `/usr/share/grafana/conf/provisioning/dashboards/default.yml` will be overwritten. +- replaced during PMM upgrades, to ensure they are always up-to-date with the latest version. Any manual changes will be overwritten. Remember: From cef0a7ceac7cd073f433674836e70406cbbd8758 Mon Sep 17 00:00:00 2001 From: Catalina A <94133018+catalinaadam@users.noreply.github.com> Date: Tue, 23 Jul 2024 12:32:03 +0300 Subject: [PATCH 6/6] Update docs/details/dashboards/dashboard-manage-dashboards.md Co-authored-by: Nurlan Moldomurov