diff --git a/docs/_images/INVENTORY_ICON.png b/docs/_images/INVENTORY_ICON.png new file mode 100644 index 0000000000..40f071efcf Binary files /dev/null and b/docs/_images/INVENTORY_ICON.png differ diff --git a/docs/_images/Inventory.png b/docs/_images/Inventory.png new file mode 100644 index 0000000000..3c1767b884 Binary files /dev/null and b/docs/_images/Inventory.png differ diff --git a/docs/_images/PMM_Add_Instance_MySQL.png b/docs/_images/PMM_Add_Instance_MySQL.png new file mode 100644 index 0000000000..85161a6284 Binary files /dev/null and b/docs/_images/PMM_Add_Instance_MySQL.png differ diff --git a/docs/_images/PMM_Add_Instance_MySQL_TLS.png b/docs/_images/PMM_Add_Instance_MySQL_TLS.png new file mode 100644 index 0000000000..f060589b1f Binary files /dev/null and b/docs/_images/PMM_Add_Instance_MySQL_TLS.png differ diff --git a/docs/_images/PMM_Add_Instance_PostgreSQL.png b/docs/_images/PMM_Add_Instance_PostgreSQL.png new file mode 100644 index 0000000000..90de870ec2 Binary files /dev/null and b/docs/_images/PMM_Add_Instance_PostgreSQL.png differ diff --git a/docs/_images/PMM_Add_Instance_PostgreSQL_TLS.png b/docs/_images/PMM_Add_Instance_PostgreSQL_TLS.png new file mode 100644 index 0000000000..1f5a915ddf Binary files /dev/null and b/docs/_images/PMM_Add_Instance_PostgreSQL_TLS.png differ diff --git a/docs/_images/PMM_Inventory_Item_Selection.png b/docs/_images/PMM_Inventory_Item_Selection.png new file mode 100644 index 0000000000..b62c2b863e Binary files /dev/null and b/docs/_images/PMM_Inventory_Item_Selection.png differ diff --git a/docs/_images/PMM_K8s_Cluster_Summary.png b/docs/_images/PMM_K8s_Cluster_Summary.png new file mode 100644 index 0000000000..db46096f67 Binary files /dev/null and b/docs/_images/PMM_K8s_Cluster_Summary.png differ diff --git a/docs/_images/PMM_K8s_Pods_Status.png b/docs/_images/PMM_K8s_Pods_Status.png new file mode 100644 index 0000000000..1505eb3f8c Binary files /dev/null and b/docs/_images/PMM_K8s_Pods_Status.png differ diff --git a/docs/_images/PMM_K8s_volume.png b/docs/_images/PMM_K8s_volume.png new file mode 100644 index 0000000000..c294a89222 Binary files /dev/null and b/docs/_images/PMM_K8s_volume.png differ diff --git a/docs/_images/arrow-downward.ico b/docs/_images/arrow-downward.ico new file mode 100644 index 0000000000..bbf9637399 Binary files /dev/null and b/docs/_images/arrow-downward.ico differ diff --git a/docs/_images/dots-three-vertical.ico b/docs/_images/dots-three-vertical.ico new file mode 100644 index 0000000000..506de3bbc0 Binary files /dev/null and b/docs/_images/dots-three-vertical.ico differ diff --git a/docs/details/dashboards/dashboard-inventory.md b/docs/details/dashboards/dashboard-inventory.md index a86ffb657e..9540c3650a 100644 --- a/docs/details/dashboards/dashboard-inventory.md +++ b/docs/details/dashboards/dashboard-inventory.md @@ -1,41 +1,47 @@ # PMM Inventory -The *Inventory* dashboard is a high level overview of all objects registered by PMM. +The **Inventory** dashboard is a high-level overview of all objects registered in PMM. -To see it select *Configuration* → {{icon.inventory}} *PMM Inventory* → {{icon.inventory}} *Inventory list*. +To check your inventory list, go to **Configuration** > **Inventory**. -![!image](../../_images/PMM_Inventory.jpg) +![!image](../../_images/Inventory.png) -Inventory objects form a hierarchy with Node at the top, then Service and Agents assigned to a Node. +Inventory objects form a hierarchy with Node at the top, then Service and Agents assigned to a Node. This information is detailed in the two tabs available on this page. -There are three tabs where items for each type are listed with their details: +### **Services** tab -- *Services* +Shows individual services, the nodes on which they run, and the Agents that help collect the service metrics. +The **Status** column shows the status of your databases based on metrics coming directly from the database. +The **Monitoring** column summarizes the status of all the Agents assigned to the service. - Individual service names and where they run, against which agents will be assigned. Each instance of a service gets a `service_id` value that is related to a `node_id`. Examples are MySQL, Amazon Aurora MySQL. This feature also allows to support multiple mysqld instances on a single node, with different service names, e.g. `mysql1-3306`, and `mysql1-3307`. +You can check Query Analytics information and the Service Overview Dashboard for each service by clicking on the icon in the **Options** column. -- *Agents* +From here you can also check additional information about the service, by clicking on the icon. This expands the service entry to show reference information like service labels and IDs. - Each binary (exporter, agent) running on a client will get an `agent_id` value. Examples: +Each instance of a service gets a `service_type` attribute so one can clearly tell what type of database it is, for instance: `mysql`, `postgresql`, `mongodb`, etc. Every service is related to a certain node via its `node_id` attribute. This feature allows to support multiple instances on a single node, with different service names, e.g. `mysql1-3306`, and `mysql1-3307`. - - `pmm-agent` one is the top of the tree, assigned to a `node_id` - - `node_exporter` is assigned to pmm-agent `agent_id` - - `mysqld_exporter` and QAN MySQL Perfschema are assigned to a `service_id`. +Each binary (exporter, agent) running on a client will get an `agent_type` value. Examples: -- *Nodes* +- `pmm-agent` is at the top of the tree, assigned to PMM Agent itself +- `node_exporter` is assigned to an agent that extracts the node metrics +- `mysqld_exporter` and `qan-mysql-perfschema-agent` are assigned to agents that extract metrics from mysql and its performance schema respectively. - Where the service and agents will run. Assigned a `node_id`, associated with a `machine_id` (from `/etc/machine-id`). Some examples are bare metal, virtualized, container. +### **Nodes** tab + +Shows where the service and agents run. + +Each `node_id` is associated with a `machine_id` (from `/etc/machine-id`). Nodes also have `node_type` attributes, which give an idea about their nature. Some examples are: generic, container, remote, remote_rds, etc. + +By expanding the entry from the options column, you can check the node labels and attributes. ## Removing items from the inventory -You can remove items from the inventory. +To remove items from the inventory: -1. Select *Configuration* → {{icon.inventory}} *PMM Inventory* → {{icon.inventory}} *Inventory list*. +1. Go to **Configuration** > {{icon.inventory}} **Inventory**. 2. In the first column, select the items to be removed. - ![!image](../../_images/PMM_Inventory_Item_Selection.jpg) - -3. Click *Delete*. The interface will ask you to confirm the operation: + ![!image](../../_images/PMM_Inventory_Item_Selection.png) - ![!image](../../_images/PMM_Inventory_Item_Delete.jpg) +3. Click **Delete** and confirm the removal. diff --git a/docs/details/dashboards/index.md b/docs/details/dashboards/index.md index 146d4273e7..ce59cf7f4c 100644 --- a/docs/details/dashboards/index.md +++ b/docs/details/dashboards/index.md @@ -2,6 +2,9 @@ | Category | Dashboard | Elements { data-sort-method='number'} | |-------------------|------------------------------------------------------------------------------------------|:-------------------------------------:| +| Kubernetes | [Kubernetes Cluster Summary] | 7 +| Kubernetes | [Kubernetes Pods Status] | 26 +| Kubernetes | [Kubernetes Volumes] | 57 | Insight | [Advanced Data Exploration] | 7 | Insight | [Home Dashboard] | 26 | Insight | [Prometheus Exporter Status] | 57 @@ -63,6 +66,9 @@ [Advanced Data Exploration]: dashboard-advanced-data-exploration.md [Home Dashboard]: dashboard-home.md +[Kubernetes Cluster Summary]: kubernetes_cluster_summary.md +[Kubernetes Pods Status]: kubernetes_pods_status.md +[Kubernetes Volumes]: kubernetes_volume.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/dashboards/kubernetes_cluster_summary.md b/docs/details/dashboards/kubernetes_cluster_summary.md new file mode 100644 index 0000000000..b854858dbf --- /dev/null +++ b/docs/details/dashboards/kubernetes_cluster_summary.md @@ -0,0 +1,24 @@ +# Kubernetes Cluster Summary + +!!! caution alert alert-warning "Disclaimer" + This is an Experimental Dashboard that is not part of the official Percona Monitoring and Management (PMM) deployment and might be updated. We ship this Dashboard to obtain feedback from our users. + +!!! note alert alert-primary "Availability" + This experimental dashboard is available starting with PMM 2.30.0. + + +![!image](../../_images/PMM_K8s_volume.png) + +*Kubernetes Volumes* dashboard provides a comprehensive overview of your Kubernetes cluster, including: + +- Resources +- Node Status +- [Pod](https://kubernetes.io/docs/concepts/workloads/pods/) Status +- [PVC](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) status +- CPU Overview +- Kubernetes Resource Count +- Memory Overview and more + +With this dashboard, you can view all workloads running in the cluster and optimize their performance. + + diff --git a/docs/details/dashboards/kubernetes_pods_status.md b/docs/details/dashboards/kubernetes_pods_status.md new file mode 100644 index 0000000000..8cf2a73251 --- /dev/null +++ b/docs/details/dashboards/kubernetes_pods_status.md @@ -0,0 +1,16 @@ +# Kubernetes Pods Status + +!!! caution alert alert-warning "Disclaimer" + This is an Experimental Dashboard that is not part of the official Percona Monitoring and Management (PMM) deployment and might be updated. We ship this Dashboard to obtain feedback from our users. + +!!! note alert alert-primary "Availability" + This experimental dashboard is available starting with PMM 2.37.0. + + +![!image](../../_images/PMM_K8s_Pods_Status.png) + +Kubernetes Pods Status dashboard provides detailed information about the state and performance of your pods, including CPU, Memory, and Network metrics. + +This dashboard can help you quickly pinpoint any issues affecting your pods and ensure they continue to operate smoothly. + + diff --git a/docs/details/dashboards/kubernetes_volume.md b/docs/details/dashboards/kubernetes_volume.md new file mode 100644 index 0000000000..4e41c05b1c --- /dev/null +++ b/docs/details/dashboards/kubernetes_volume.md @@ -0,0 +1,16 @@ +# Kubernetes Volumes + +!!! caution alert alert-warning "Disclaimer" + This is an Experimental Dashboard that is not part of the official Percona Monitoring and Management (PMM) deployment and might be updated. We ship this Dashboard to obtain feedback from our users. + +!!! note alert alert-primary "" + This dashboard will not work for minikube cluster as there are no drivers for it. + + +![!image](../../_images/PMM_K8s_volume.png) + +Starting with PMM 2.37.0 we have introduced *Kubernetes Volumes* dashboard. This dashboard provides insights into your Kubernetes volumes, including capacity and usage, in real-time. + +With this dashboard, you can easily monitor the performance and usage of your volumes and take proactive measures to ensure their performance. + + diff --git a/docs/details/postgresql.md b/docs/details/postgresql.md index 1ddbc1d5de..65549a4001 100644 --- a/docs/details/postgresql.md +++ b/docs/details/postgresql.md @@ -7,7 +7,7 @@ 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. + 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: diff --git a/docs/get-started/backup/mongo-prerequisites.md b/docs/get-started/backup/mongo-prerequisites.md index f40d30e6ec..2d6b41936a 100644 --- a/docs/get-started/backup/mongo-prerequisites.md +++ b/docs/get-started/backup/mongo-prerequisites.md @@ -7,7 +7,8 @@ Before creating MongoDB backups, make sure to: 3. For setups where PMM Server runs as a Docker container, enable backup features at container creation time by adding `-e ENABLE_BACKUP_MANAGEMENT=1` to your `docker run` command. 4. Check that [PMM Client](../../setting-up/client/index.md) is installed. For creating logical backups, the PMM client should run on at least one node of the replica set. Make sure this is the one that will be used for backup and restore jobs. For physical backups, make sure PMM client runs on all nodes instead. 5. Check that [Percona Backup for MongoDB](https://docs.percona.com/percona-backup-mongodb/index.html) (PBM) is installed and `pbm-agent` is running on all MongoDB nodes in the replica set. PMM 2.32 and later require PBM 2.0.1 or newer. -6. Check that your MongoDB Services are managed as clusters in PMM. Go to **PMM Inventory > Services** page and make sure that all the services in the table specify a cluster name in the **Other Details** column. Services that do not specify a cluster name should be removed and re-added using command like the following: +6. Check that your MongoDB Services are managed as clusters in PMM. Go to **PMM Inventory > Services** page, expand the **Details** section on the **Options** column, and make sure that all the services in the table specify a cluster name. +Services that do not specify a cluster name should be removed and re-added using command like the following: 
pmm-admin add mongodb \
    --username=pmm_mongodb --password=password \
    query-source=profiler --cluster=mycluster
diff --git a/docs/release-notes/2.37.0.md b/docs/release-notes/2.37.0.md new file mode 100644 index 0000000000..8140c6bc1d --- /dev/null +++ b/docs/release-notes/2.37.0.md @@ -0,0 +1,168 @@ +# Percona Monitoring and Management 2.37.0 + +| **Release date:** | April 24, 2023 | +| ----------------- | ----------------------------------------------------------------------------------------------- | +| **Installation:** | [Installing Percona Monitoring and Management](https://www.percona.com/software/pmm/quickstart) | + +Percona Monitoring and Management (PMM) is an open source database monitoring, management, and observability solution for MySQL, PostgreSQL, and MongoDB. + + + + +## Release Highlights + + +### Improved Inventory view + +This release of PMM starts the series of enhancements that will improve the way you work with Services and Nodes in PMM. +With this first set of changes, we’re revamping the **Inventory** page to give you more context on your inventory objects, and more actionable information for exploring and fixing possible issues. + +Here are all the specific changes: + +- Improved design of the **Inventory** page for a clearer presentation of all the objects registered by PMM. +- Services now show their database status, which is based on the monitoring metrics. This enables you to quickly check the status of the databases when you are working with the inventory. +- New **Monitoring** column showing the live status for the monitoring Agents assigned to a Service. This enables you to quickly spot any possible issues with the Agents. +- Quick access to the Service Summary **Dashboard** and to **QueryAnalytics** results so that you can easily explore important related information. +- New **Details** section grouping together all the relevant parameters and labels for a Service. To keep things clean, this section is collapsed by default, so that you can view extra information only when you need it. + +Here's what's coming: + +Building up on these changes, subsequent releases will further improve PMM Inventory with: + +- More useful features to filter and better connect Services and Nodes. +- Services organized in clusters so that you can capture the bigger picture, instead of working at of individual Service-level. + +### New Experimental Dashboards for Kubernetes Monitoring + +!!! caution alert alert-warning "Important" + These experimental dashboards are subject to change. It is recommended to use these dashboards for testing purposes only. + +We are pleased to announce the release of PMM 2.37, which introduces three new experimental dashboards: + +- Kubernetes Cluster Summary +- Kubernetes Pods Status +- Kubernetes Volumes + +These dashboards are designed to provide valuable insights into the status and performance of your Kubernetes cluster, pods, and volumes, helping you to identify and troubleshoot issues quickly and easily. + +We welcome your feedback as we continue to enhance PMM with these new dashboards. + +**Experimental Kubernetes Cluster Summary Dashboard** + +*Kubernetes Cluster Summary* provides a comprehensive overview of your Kubernetes cluster, including: + +- Components +- Node +- Pod +- PVC status +- CPU +- Memory overview, and more. + +This dashboard displays all workloads running in the cluster, enabling you to take action and optimize its performance. + +**Experimental Kubernetes Pods Status Dashboard** + +*Kubernetes Pods Status dashboard* provides detailed information about the state and performance of your pods, including CPU, Memory, and Network metrics. + +This dashboard can help you quickly pinpoint any issues affecting your pods and ensure they continue to operate smoothly. + +**Experimental Kubernetes Volume Dashboard** + +*Kubernetes Volumes* dashboard provides insights into your Kubernetes volumes, including capacity and usage, in real time. With this dashboard, you can easily monitor the performance and usage of your volumes and take proactive measures to ensure their performance. + +Refer to the [documentation]() to learn more about these new experimental dashboards and how to use them. + +Here are the steps to create a new folder and move all experimental dashboards to the new folder for quick access and internal use: + +!!! note alert alert-primary "Note" + You should have at least an *Editor* role to create a new folder and move all experimental dashboards. + +1. Navigate to the **Main** menu and hover on the {{icon.dashboards}} _Dashboards_ icon. +2. Click **New folder**. +3. Provide a name for your folder, and then select **Create**. +4. Navigate to {{icon.dashboards}} _Dashboards_ from the **Main** menu and click **Browse**. +5. Select the dashboard that you want to move and click **Move**. +6. On the **Choose Dashboard** dialogue box, from the dropdown under **Folder** option, choose the folder where you want to move the dashboard. +7. To apply your changes, select **Save Dashboard**. + +## Components upgrade + +VictoriaMetrics has been upgraded to version [1.89.1]. + +## New Features + +- [PMM-10913](https://jira.percona.com/browse/PMM-10913) - Starting with PMM 2.37.0, you can use an external PostgreSQL server as data storage for PMM. Thus, even if PMM fails, your data will be stored in an external source, reducing the risk associated with data loss. Furthermore, clustered PostgreSQL instances also enhance performance. + +- [PMM-11281](https://jira.percona.com/browse/PMM-11281) - We have written a query for the postgres exporter to deal with lock conflicts in databases that block several transactions, thus impacting performance. With this query, you can find the PID of the blocking session and how many sessions it blocked. The proactive approach enables customers to address non-responsive databases quickly by understanding the underlying causes. + +- [PMM-11384](https://jira.percona.com/browse/PMM-11384) and [PMM-11834](https://jira.percona.com/browse/PMM-11834) - PMM 2.37.0 now supports PSMDB operator versions 1.13 and 1.14. + +- [PMM-11438](https://jira.percona.com/browse/PMM-11438) - Starting with PMM 2.37.0, PMM administrators can disable the internal PostgreSQL server, which helps to fine-tune the server. + +- [PMM-11439](https://jira.percona.com/browse/PMM-11439) - Starting with PMM 2.37.0, a PMM administrator can now view metrics from an external PostgreSQL server. + + +## Improvements + +- [PMM-4466](https://jira.percona.com/browse/PMM-4466) - We have migrated Grafana to use PostgreSQL instead of SQLite, which enhances the performance of the Auth system and sessions and makes the system less complex. +- [PMM-11412](https://jira.percona.com/browse/PMM-11412) - We have enhanced our dashboards to be more user-oriented, displaying the DB cluster's status along with its components, such as metrics of stateful, pods, and so on. Also, you can apply filters based on DB name or DB type. +- [PMM-11832](https://jira.percona.com/browse/PMM-11832) - When hovering over the **Backup** option on the main menu, PMM now displays the subcategories for easier navigation. +- [PMM-11522](https://jira.percona.com/browse/PMM-11522) - With the newly added support for Clickhouse as a datasource for Advisors, Advisors can now use data produced by Query Analytics (QAN) to run checks on databases. +- [PMM-11544](https://jira.percona.com/browse/PMM-11544) - Improved functionality for EXPLAIN query in QAN. +- [PMM-11926](https://jira.percona.com/browse/PMM-11926) - Updated the format of the **Upgrade to a Premium plan** URL on the **Advisor Insights** page. +- [PMM-11078](https://jira.percona.com/browse/PMM-11078) - Following the replacement of Integrated Alerting with Percona Alerting in PMM 2.311, we have now phased out all the APIs related to this deprecated feature. + +## Bugs Fixed + + +- [PMM-8690](https://jira.percona.com/browse/PMM-8690) - Fixed an issue where the Replica set lag displayed incorrect values on the MongoDB ReplSet Summary dashboard for an ARBITER node. +- [PMM-9775](https://jira.percona.com/browse/PMM-9775) - QAN: PMM failed to display the set timezone for QAN despite it being set to UTC. +- [PMM-10687](https://jira.percona.com/browse/PMM-10687) - DBaaS: Fixed an issue where DB cluster creation failed when using an unreleased version of pmm-server. +- [PMM-11121](https://jira.percona.com/browse/PMM-11121) - DBaaS: Fixed an issue where the list of DB clusters did not load if one of the K8s clusters was unresponsive. +- [PMM-11226](https://jira.percona.com/browse/PMM-11226) - Fixed an issue where different operator versions and names were displayed for each K8s cluster. +- [PMM-11313](https://jira.percona.com/browse/PMM-11313) - Rows Fetched/Read and Users by Rows Read dashboards are not working in the MySQL User Details dashboard +- [PMM-11555](https://jira.percona.com/browse/PMM-11555) - For thousands of client connections for ProxySQL, the graph for Active Frontend connections did not render due to sluggish performance. Furthermore, this could affect the rendering and usage of the ProxySQL Instance summary dashboard. The issue has been resolved now. +- [PMM-11829](https://jira.percona.com/browse/PMM-11829) - PMM Agent does not work with PG 12 and PGSM 2.0. This issue has been resolved now. +- [PMM-11844](https://jira.percona.com/browse/PMM-11844) - Fixed an issue where a user failed to add PSMDB with pmm-admin using native LDAP authentication and TLS. +- [PMM-11862](https://jira.percona.com/browse/PMM-11862) - Fixed inconsistent naming of the Advisors feature across PMM UI. +- [PMM-11875](https://jira.percona.com/browse/PMM-11875) - Fixed an issue where the users could not select and compare multiple nodes on the Summary dashboard. +- [PMM-11904](https://jira.percona.com/browse/PMM-11904) - Index Size and Concurrent Inserts panels were broken on the Insight / VictoriaMetrics dashboard after updating to version 1.89.1. +- [PMM-10795](https://jira.percona.com/browse/PMM-10795) - Node summary was not visible under MongoDB ReplSet Summary when the node name contained a dot (.) in the name. +- [PMM-11465](https://jira.percona.com/browse/PMM-11465) - Fixed problem with empty output for EXPLAIN in QAN. +- [PMM-11729](https://jira.percona.com/browse/PMM-11729) - Fixed syntax issues with placeholders for EXPLAIN in QAN. +- [PMM-11849](https://jira.percona.com/browse/PMM-11849) - Fixed issue that affected Advisors, where Actions and Jobs would always be executed on the primary node in a MongoDB cluster. +- [PMM-11934](https://jira.percona.com/browse/PMM-11934) - Product tour is now correctly displaying the Advisors information. + + + + \ No newline at end of file diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index 346b8819c5..4f3375e93c 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -1,4 +1,5 @@ # Release Notes +- [Percona Monitoring and Management 2.37.0](2.37.0.md) - [Percona Monitoring and Management 2.36.0](2.36.0.md) - [Percona Monitoring and Management 2.35.0](2.35.0.md) - [Percona Monitoring and Management 2.34.0](2.34.0.md) diff --git a/docs/setting-up/client/mongodb.md b/docs/setting-up/client/mongodb.md index 6f9e262274..907778748f 100644 --- a/docs/setting-up/client/mongodb.md +++ b/docs/setting-up/client/mongodb.md @@ -198,7 +198,7 @@ When you have configured your database server, you can add a MongoDB service wit ### With the user interface -1. Select *Configuration* → {{icon.inventory}} *PMM Inventory* → {{icon.addinstance}} *Add Instance*. +1. Select *Configuration* → {{icon.inventory}} *Inventory*. 2. Select *MongoDB -- Add a remote instance*. @@ -206,7 +206,7 @@ When you have configured your database server, you can add a MongoDB service wit 4. Click *Add service*. -![!](../../_images/PMM_Add_Instance_MongoDB.jpg) +![!](../../_images/PMM_Add_Instance_MongoDB.png) ### On the command line @@ -268,11 +268,11 @@ where: ### With the user interface -1. Select *Configuration* → {{icon.inventory}} *PMM Inventory* → {{icon.inventory}} *Inventory list*. -2. Look in the *Services* tab for a matching *Service Type* (MongoDB), *Service name*, *Addresses*, and any other values used when adding the service. -3. Look in the *Agents* tab to check the desired data source is being used. +1. Select *Configuration* → {{icon.inventory}} *Inventory*. +2. In the *Services* tab, verify the *Service name*, *Addresses*, and any other relevant values used when adding the service. +3. In the *Options* column, expand the *Details* section and check that the Agents are using the desired data source. 4. If your MongoDB instance is configured to use TLS, click on the **Use TLS for database connection** check box and fill in TLS certificates and keys. - 1. If you use TLS, the authentication mechanism is automatically set to `MONGODB-X509`. +If you use TLS, the authentication mechanism is automatically set to `MONGODB-X509`. ![!](../../_images/PMM_Add_Instance_MongoDB_TLS.jpg) @@ -300,7 +300,7 @@ pmm-admin inventory list services --service-type=mongodb ### With the user interface -1. Select *Configuration* → {{icon.inventory}} *PMM Inventory* → {{icon.inventory}} *Inventory List*. +1. Select *Configuration* → {{icon.inventory}} *Inventory*. 2. In the first column, click the tick box for the service you want to remove. 3. Click *Delete*. 4. On the *Confirm action* dialog window: diff --git a/docs/setting-up/client/mysql.md b/docs/setting-up/client/mysql.md index cddc99a907..cecf62c624 100644 --- a/docs/setting-up/client/mysql.md +++ b/docs/setting-up/client/mysql.md @@ -346,7 +346,7 @@ With the PMM user interface, you select *Use performance schema*, or deselect it ### With the user interface -1. Select *Configuration* → {{icon.inventory}} *PMM Inventory* → {{icon.addinstance}} *Add Instance*. +1. Select *Configuration* → {{icon.inventory}} *Inventory* → {{icon.addinstance}} *Add Service*. 2. Select *MySQL -- Add a remote instance*. @@ -354,11 +354,11 @@ With the PMM user interface, you select *Use performance schema*, or deselect it 4. Click *Add service*. -![!](../../_images/PMM_Add_Instance_MySQL.jpg) +![!](../../_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.jpg) +![!](../../_images/PMM_Add_Instance_MySQL_TLS.png) ### On the command line @@ -424,9 +424,9 @@ pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --usern ### PMM user interface -1. Select *Configuration* → {{icon.inventory}} *PMM Inventory* → *Inventory list*. -2. Look in the *Services* tab for a matching *Service Type* (MySQL), *Service name*, *Addresses*, and any other details entered in the form. -3. Look in the *Agents* tab to check the desired data source is being used. +1. Select *Configuration* → {{icon.inventory}} *Inventory*. +2. In the *Services* tab, verify the *Service name*, *Addresses*, and any other relevant information in the form. +3. In the *Options* column, expand the *Details* section and check that the Agents are using the desired data source. ### Command line diff --git a/docs/setting-up/client/postgresql.md b/docs/setting-up/client/postgresql.md index 0ca36cd728..2a65414bec 100644 --- a/docs/setting-up/client/postgresql.md +++ b/docs/setting-up/client/postgresql.md @@ -228,7 +228,7 @@ When you have configured your database server, you can add a PostgreSQL service ### With the user interface -1. Select *Configuration* → {{icon.inventory}} *PMM Inventory* → {{icon.addinstance}} *Add Instance*. +1. Select *Configuration* → {{icon.inventory}} *Inventory* → {{icon.addinstance}} *Add Service*. 2. Select *PostgreSQL -- Add a remote instance*. @@ -236,11 +236,11 @@ When you have configured your database server, you can add a PostgreSQL service 4. Click *Add service*. -![!](../../_images/PMM_Add_Instance_PostgreSQL.jpg) +![!](../../_images/PMM_Add_Instance_PostgreSQL.png) If your PostgreSQL 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_PostgreSQL_TLS.jpg) +![!](../../_images/PMM_Add_Instance_PostgreSQL_TLS.png) !!! hint alert alert-success "Note" For TLS connection to work SSL needs to be configured in your PostgreSQL instance. Make sure SSL is enabled in the server configuration file `postgresql.conf`, and that hosts are allowed to connect in the client authentication configuration file `pg_hba.conf`. (See PostgreSQL documentation on [Secure TCP/IP Connections with SSL].) @@ -314,11 +314,9 @@ where: ### Check service - PMM user interface -1. Select *Configuration* → {{icon.inventory}} *PMM Inventory* → {{icon.inventory}} *Inventory list*. - -2. Look in the *Services* tab for a matching *Service Type* (PostgreSQL), *Service name*, *Addresses*, and any other details entered in the form. - -3. Look in the *Agents* tab to check the desired data source is being used. +1. Select *Configuration* → {{icon.inventory}} *Inventory*. +2. In the *Services* tab, verify the *Service name*, *Address* and any other relevant details. +3. In the *Options* column, expand the *Details* section and check that the Agents are using the desired data source. ### Check service - Command line diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 53f2f9e8e0..c073fd6183 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -92,7 +92,7 @@ plugins: with-pdf: output_path: '_pdf/PerconaMonitoringAndManagement-2.36.0.pdf' cover_title: 'Percona Monitoring and Management Documentation' - cover_subtitle: 2.36.0 (Mar 23, 2023) + cover_subtitle: 2.37.0 (May 02, 2023) author: "Percona Technical Documentation Team" cover_logo: docs/_images/Percona_Logo_Color.png custom_template_path: _resources/templates @@ -208,6 +208,10 @@ nav: - details/dashboards/dashboard-advanced-data-exploration.md - details/dashboards/dashboard-victoriametrics.md - details/dashboards/dashboard-victoriametrics-agents-overview.md + - Kubernetes: + - details/dashboards/kubernetes_cluster_summary.md + - details/dashboards/kubernetes_pods_status.md + - details/dashboards/kubernetes_volume.md - PMM Inventory: - details/dashboards/dashboard-inventory.md - details/dashboards/dashboard-env-overview.md @@ -304,6 +308,7 @@ nav: - faq.md - Release Notes: - release-notes/index.md + - "PMM 2.37.0": release-notes/2.37.0.md - "PMM 2.36.0": release-notes/2.36.0.md - "PMM 2.35.0": release-notes/2.35.0.md - "PMM 2.34.0": release-notes/2.34.0.md diff --git a/variables.yml b/variables.yml index 7a6437bd70..6cb89ff08a 100644 --- a/variables.yml +++ b/variables.yml @@ -1,9 +1,9 @@ # PMM Version for HTML # See also mkdocs.yml plugins.with-pdf.cover_subtitle and output_path -release: '2.36.0' -version: '2.36' -release_date: 2023-03-23 +release: '2.37.0' +version: '2.37' +release_date: 2023-05-02 # SVG icons. Use in markdown as {{icon.}} # For the Percona image icon (encoded inline SVG), see https://css-tricks.com/using-svg/