Release Branch for PMM 2.32.0 (#900)

* Release Branch for PMM 2.32.0 * PMM-8792 MySQL max query length. (#889) * PMM-8792 Doc. * Update docs/details/commands/pmm-admin.md Co-authored-by: Rasika Chivate <[email protected]> * Update docs/details/commands/pmm-admin.md Co-authored-by: Rasika Chivate <[email protected]> * PMM-10385 Fix. * Update docs/details/commands/pmm-admin.md * Revert "Update docs/details/commands/pmm-admin.md" This reverts commit 7545a8e. Co-authored-by: Rasika Chivate <[email protected]> * PMM-10842 PG max query length. (#902) * PMM-10842 Doc for PG. * PMM-10385 Fix. * PMM-10843 Mongo max query length. (#903) * PMM-10843 Changes. * PMM-10385 Fix. * Update docs/details/commands/pmm-admin.md * Revert "Update docs/details/commands/pmm-admin.md" This reverts commit 51bc9b1. Co-authored-by: Rasika Chivate <[email protected]> * PMM-11029 Known issue QAN (#911) * PMM-11029 Known issue QAN * Update pmm-admin.md * Update pmm-admin.md * Known bug about QAN. * Update pmm-admin.md * Update pmm-admin.md * Update pmm-admin.md Co-authored-by: Jiří Čtvrtka <[email protected]> * PMM 10156 Home Dashboard (#909) * PMM 10156 Home Dashboard * Updated the home dashbaord image * Update dashboard-home.md * Updated the index * Update dashboard-home.md * Added a note about availability of this dashboard * Update dashboard-home.md * PMM-10612 enhanced main menu (#913) * PMM-10612 enhanced main me nu * PMM-10612 enhanced main menu * Update interface.md * Update interface.md * Update interface.md * Update interface.md * Release Notes PMM 2.32.0 (#904) * Release Notes PMM 2.32.0 * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Commited the config changes * trigger a feature build * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update mkdocs-base.yml * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Server Features changes * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update docs/release-notes/2.32.0.md Co-authored-by: Jiří Čtvrtka <[email protected]> * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Update 2.32.0.md * Added known issue * removed info that should go in the release blog * Update 2.32.0.md * added link to backup toipic * Added link for to the documentation page * Update docs/release-notes/2.32.0.md Co-authored-by: Jiří Čtvrtka <[email protected]> * Update 2.32.0.md * Update 2.32.0.md * Space between two words * Update 2.32.0.md Co-authored-by: Alex Tymchuk <[email protected]> Co-authored-by: Catalina A <[email protected]> Co-authored-by: Jiří Čtvrtka <[email protected]> Co-authored-by: Catalina A <[email protected]> * Config-changes-PMM-2.32.0 (#910) * Update the date * Mongo bm (#912) * draft * draft * draft * draft * first draft * formatting * ToC * fix image * tr table column fix * tr table column fix * try table format * Update docs/using/mongodb_limitations.md Co-authored-by: Michael Okoko <[email protected]> * Update docs/using/backup.md Co-authored-by: Pavel Khripkov <[email protected]> * try table formatting * removed support mamtrix mysql * moved info from separate lmysql limisations topic * Update docs/using/mongodb_limitations.md Co-authored-by: Pavel Khripkov <[email protected]> * Update docs/using/mongodb_limitations.md Co-authored-by: Pavel Khripkov <[email protected]> * implemented feedback from Pavel * Update docs/using/backup.md Co-authored-by: Pavel Khripkov <[email protected]> * Update docs/using/backup.md Co-authored-by: Pavel Khripkov <[email protected]> * Update docs/using/backup.md Co-authored-by: Pavel Khripkov <[email protected]> * Update docs/using/backup.md Co-authored-by: Pavel Khripkov <[email protected]> * Update docs/using/backup.md Co-authored-by: Pavel Khripkov <[email protected]> * Update docs/using/mongodb_limitations.md Co-authored-by: Pavel Khripkov <[email protected]> * Update docs/using/backup.md Co-authored-by: Pavel Khripkov <[email protected]> * removed extra tables * Update docs/using/backup.md Co-authored-by: Pavel Khripkov <[email protected]> * Update docs/using/backup.md Co-authored-by: Pavel Khripkov <[email protected]> * Update docs/using/mongodb_limitations.md Co-authored-by: Roma Novikov <[email protected]> * Update docs/using/backup.md Co-authored-by: Pavel Khripkov <[email protected]> * fixed lists * fixed list Co-authored-by: Michael Okoko <[email protected]> Co-authored-by: Pavel Khripkov <[email protected]> Co-authored-by: Roma Novikov <[email protected]> Co-authored-by: Jiří Čtvrtka <[email protected]> Co-authored-by: Jiří Čtvrtka <[email protected]> Co-authored-by: Alex Tymchuk <[email protected]> Co-authored-by: Catalina A <[email protected]> Co-authored-by: Catalina A <[email protected]> Co-authored-by: Michael Okoko <[email protected]> Co-authored-by: Pavel Khripkov <[email protected]> Co-authored-by: Roma Novikov <[email protected]>
percona · Nov 8, 2022 · cec66c5 · cec66c5
1 parent a54651b
commit cec66c5
Show file tree

Hide file tree

Showing 20 changed files with 463 additions and 300 deletions.
diff --git a/docs/_images/PMM_Backup_Management-MongoDB-PITR-Enable-Error.jpg b/docs/_images/PMM_Backup_Management-MongoDB-PITR-Enable-Error.jpg
diff --git a/docs/_images/PMM_Backup_Management-MongoDB-PITR-Enable.jpg b/docs/_images/PMM_Backup_Management-MongoDB-PITR-Enable.jpg
diff --git a/docs/_images/PMM_Backup_Management-MongoDB-PITR-Inventory.jpg b/docs/_images/PMM_Backup_Management-MongoDB-PITR-Inventory.jpg
diff --git a/docs/_images/PMM_Backup_Management.jpg b/docs/_images/PMM_Backup_Management.jpg
diff --git a/docs/_images/PMM_Backup_Management_Scheduled_Backups_Copy.jpg b/docs/_images/PMM_Backup_Management_Scheduled_Backups_Copy.jpg
diff --git a/docs/_images/PMM_Home_Dashboard.png b/docs/_images/PMM_Home_Dashboard.png
diff --git a/docs/_images/PMM_Home_Dashboard_Numbered.png b/docs/_images/PMM_Home_Dashboard_Numbered.png
diff --git a/docs/_images/PMM_Home_Dashboard_Numbered_old.png b/docs/_images/PMM_Home_Dashboard_Numbered_old.png
diff --git a/docs/_images/dots-three-vertical.png b/docs/_images/dots-three-vertical.png
diff --git a/docs/details/commands/pmm-admin.md b/docs/details/commands/pmm-admin.md
@@ -346,6 +346,15 @@ When you remove a service, collected data remains on PMM Server for the specifie
         - `push`: agent will push metrics.
         - `pull`: server scrapes metrics from agent.
 
+    `--max-query-length=NUMBER` (This parameter is available starting with PMM 2.32.0.)
+    : Limit query length in QAN. Allowed values:
+        - -1: No limit.
+        -  0: Default value. The default value is 2048 chars.
+        - >0: Query will be truncated after <NUMBER> chars.
+
+        !!! caution ""
+            Ensure you do not set the value of `max-query-length` to 1, 2, or 3. Otherwise, the PMM agent will get terminated.
+
 ##### Advanced Options
 
 :  PMM starts the MongoDB exporter by default only with `diagnosticdata` and `replicasetstatus` collectors enabled.
@@ -560,6 +569,15 @@ In low resolution we collect metrics from collectors which could take some time:
         - `push`: agent will push metrics.
         - `pull`: server scrapes metrics from agent.
 
+    `--max-query-length=NUMBER` (This parameter is available starting with PMM 2.32.0.)
+    : Limit query length in QAN. Allowed values:
+        - -1: No limit.
+        -  0: Default value. The default value is 2048 chars.
+        - >0: Query will be truncated after <NUMBER> chars.
+
+        !!! caution ""
+            Ensure you do not set the value of `max-query-length` to 1, 2, or 3. Otherwise, the PMM agent will get terminated.
+        
 #### PostgreSQL
 
 `pmm-admin add postgresql [FLAGS] [node-name] [node-address]`
@@ -627,6 +645,15 @@ In low resolution we collect metrics from collectors which could take some time:
         - `push`: agent will push metrics.
         - `pull`: server scrapes metrics from agent.
 
+    `--max-query-length=NUMBER` (This parameter is available starting with PMM 2.32.0.)
+    : Limit query length in QAN. Allowed values:
+        - -1: No limit.
+        -  0: Default value. The default value is 2048 chars.
+        - >0: Query will be truncated after <NUMBER> chars.
+
+        !!! caution ""
+            Ensure you do not set the value of `max-query-length` to 1, 2, or 3. Otherwise, the PMM agent will get terminated.
+
 #### ProxySQL
 
 `pmm-admin add proxysql [FLAGS] [node-name] [node-address]`

diff --git a/docs/details/dashboards/dashboard-home-experimental.md b/docs/details/dashboards/dashboard-home-experimental.md
diff --git a/docs/details/dashboards/dashboard-home.md b/docs/details/dashboards/dashboard-home.md
@@ -1,28 +1,24 @@
 # Home Dashboard
 
-![!image](../../_images/PMM_Home_Dashboard.png)
-
-The Home Dashboard is a high-level overview of your environment, the starting page of the PMM portal from which you can open the tools of PMM, and browse to online resources.
-
-On the PMM home page, you can also find the version number and a button to update your PMM Server.
+!!! note alert alert-primary "Availability"
+    The new Home dashboard is available starting with PMM 2.32.0.
 
-## General Information
+The Home Dashboard provides a high-level overview of your environment, such as the services, infrastructure, and critical issues (if any). It is the starting page of PMM from which you can open the tools of PMM and browse online resources.
 
-This section contains links to online resources, such as PMM documentation, releases notes, and blogs.
+This Home Dashboard displays data that is organized in panels as given below.
 
-## Shared and Recently Used Dashboards
 
-This section is automatically updated to show the most recent dashboards that you worked with. It also contains the dashboards that you have bookmarked.
+![!image](../../_images/PMM_Home_Dashboard.png)
 
-## Statistics
 
-This section shows the total number of hosts added to PMM and the total number of database instances being monitored. This section also displays the current version number. Use the *Upgrade to X.X.X version* to upgrade to the most recent version of PMM.
+## Overview
 
-## Environment Overview
+This panel lists all added hosts along with essential information about their performance. For each host, you can find the current values of the following metrics:
 
-This section lists all added hosts along with essential information about their performance. For each host, you can find the current values of the following metrics:
 
-* CPU Busy
+* Monitored DB Services
+* Monitored DB Instances
+* Monitored Nodes
 * Memory Available
 * Disk Reads
 * Disk Writes
@@ -33,3 +29,48 @@ This section lists all added hosts along with essential information about their
 * RAM
 * Host Uptime
 * DB Uptime
+* Advisors check
+
+ This panel also displays the current version number. Use **Upgrade to X.X.X version** to upgrade to the most recent version of PMM.
+
+
+## Anomaly Detection
+
+The **Anomaly Detection** panel lists all the anomalies in your environment. Color-coded states on the panels provide a quick visual representation of the problem areas.
+
+The following anomalies are displayed on this panel:
+
+* CPU anomalies (high as well as low)
+* High CPU servers
+* Low CPU servers
+* Disk Queue anomalies
+* High disk queue
+* High Memory Used
+
+
+## Command Center
+
+You can find critical information such as CPU utlization, memory utilization, anomalies, read and write latency, etc., about your environment on the **Command Center** panel. 
+
+The information is represented graphically on the **Command Center** panel. In this panel, the graphs for the last hour and the previous week are displayed adjacently, making it easy to identify the trends.
+
+The following information is displayed on the **Command Center** for the **Top 20** nodes:
+
+* CPU usage
+* Disk queue
+* Disk Write latency
+* Disk Read latency
+* Memory usage
+
+Command Center lists the 
+
+## Service Summary
+
+The Service Summary panel provides the following information for the services being monitored:
+
+* DB connections
+* DB QPS (Query per sec)
+* DB uptime
+
+
+
diff --git a/docs/details/dashboards/index.md b/docs/details/dashboards/index.md
@@ -4,7 +4,6 @@
 |-------------------|------------------------------------------------------------------------------------------|:-------------------------------------:|
 | Insight           | [Advanced Data Exploration]                                                              | 7
 | Insight           | [Home Dashboard]                                                                         | 26
-| Insight           | [Experimental Home Dashboard]                                                            | 26
 | Insight           | [Prometheus Exporter Status]                                                             | 57
 | Insight           | [Prometheus Exporters Overview]                                                          | 27
 | Insight           | [VictoriaMetrics]                                                                        | 52
@@ -64,7 +63,6 @@
 
 [Advanced Data Exploration]: dashboard-advanced-data-exploration.md
 [Home Dashboard]: dashboard-home.md
-[Experimental Home Dashboard]: dashboard-home-experimental.md
 [DB Cluster Summary]: dashboard-cluster-summary.md
 [Prometheus Exporter Status]: dashboard-prometheus-exporter-status.md
 [Prometheus Exporters Overview]: dashboard-prometheus-exporters-overview.md

diff --git a/docs/details/interface.md b/docs/details/interface.md
@@ -87,6 +87,9 @@ This menu bar is context-sensitive; it changes according to the page you are on.
 | Service Name                  | Filter by service name.
 | PMM Annotations               | View [annotations](../how-to/annotate.md).
 
+## Shortcut menu
+
+This menu contains shortcut for *Home*, *Query Analytics*, *Services*, and *PMM*.
 
 ### Services menu
 
@@ -100,6 +103,11 @@ The *Services* menu choice determines the Service Type menu.
 |           | Nodes Overview                 | <i class="uil uil-bars"></i> OS         | OS dashboards.
 |           | PostgreSQL Instances Overview  | <i class="uil uil-bars"></i> PostgreSQL | PostgreSQL dashboards.
 
+
+!!! hint alert alert-success "Note"
+    - You can easily access all dashboards for monitored services from the *Main menu* via *Other Dashboards* in the *Services* sub menu.
+    - Only the services being monitored by PMM will appear on the main menu.
+
 ### PMM menu
 
 This item lists shortcuts to utility pages.