2.11.0 (#266)

* RM-814 Release prep * Add missing RN entry to md index * RM-814 RN updates * PMM-6597 image rendering admonitions (#260) * PMM-6515 New images for QAN dashboard shortcuts * Info icon * PMM-6515 Wording tweak * PMM-6598 image sharing (#263) * Update 2.10.0.rst (#261) * Update 2.10.0.rst * Update 2.10.0.rst Add link * Update 2.10.1.md Add link * Update 2.10.1.md * Update 2.10.1.md Revert (wrong file) * Update 2.10.0.md Add link Co-authored-by: PaulJacobs-percona <[email protected]> * Update dashboard-mongodb-wiredtiger-details.rst Add link * Update dashboard-mongodb-wiredtiger-details.md Add link * PMM-6598 New images Co-authored-by: Roma Novikov <[email protected]> * PMM-6464 new pg-stat-monitor extension (#262) * PMM-6464 WIP * PMM-6464 WIP pending answers * PMM-6464 Pending Linux install instructions * PMM-6464 Source code instructions * PMM-6464 Move flag * PMM-6464 md file version * PMM-6464 Mention pg_stat_monitor in reference * PMM-6464 Extension is unsupported * PMM-6464 Placeholder clarification * PMM-6729 RN 2.11.0 (#265) * Update 2.10.0.rst (#261) * Update 2.10.0.rst * Update 2.10.0.rst Add link * Update 2.10.1.md Add link * Update 2.10.1.md * Update 2.10.1.md Revert (wrong file) * Update 2.10.0.md Add link Co-authored-by: PaulJacobs-percona <[email protected]> * Update dashboard-mongodb-wiredtiger-details.rst Add link * Update dashboard-mongodb-wiredtiger-details.md Add link * Set font of page footer/header elements (md) * Mkdocs link doesn't work unless in nav * MkDocs PDF version * Delete unused image & dir * MkDocs live preview * Hide rst edit link * Change github link text * Prep for switch to md * Prep for md * Make version switcher work with md * Revert version chooser to match PMM1 * Latest RN missing from md home page * Version picker test (#264) * URL variations * Testing relative URL for switcher * Relative URLs work * PMM-6341 Match PDF build output dir * PMM-6729 Release Notes 2.11.0 * PMM-6729 Version number * PMM-6729 Latest additions * PMM-6729 Latest changes * PMM-6729 Latest changes * PMM-6729 Review feedback & recent additions * PMM-6729 Even more last minute changes to Sprint contents Co-authored-by: Roma Novikov <[email protected]> Co-authored-by: Roma Novikov <[email protected]>
percona · Oct 14, 2020 · d86fc68 · d86fc68
1 parent 3a11a24
commit d86fc68
Show file tree

Hide file tree

Showing 44 changed files with 1,199 additions and 583 deletions.
diff --git a/docs/_images/PMM_Common_Panel_Menu_Share.jpg b/docs/_images/PMM_Common_Panel_Menu_Share.jpg
diff --git a/docs/_images/PMM_Common_Panel_Menu_Share_Link_Missing_Plugins.jpg b/docs/_images/PMM_Common_Panel_Menu_Share_Link_Missing_Plugins.jpg
diff --git a/docs/_images/PMM_Query_Analytics_Devices_Examples_Icon.jpg b/docs/_images/PMM_Query_Analytics_Devices_Examples_Icon.jpg
diff --git a/docs/_images/PMM_Query_Analytics_Filter_Panel_Controls_Dashboard_Shortcut.jpg b/docs/_images/PMM_Query_Analytics_Filter_Panel_Controls_Dashboard_Shortcut.jpg
diff --git a/docs/_images/PMM_Query_Analytics_Panels_Dimension_Search.jpg b/docs/_images/PMM_Query_Analytics_Panels_Dimension_Search.jpg
diff --git a/docs/_images/PMM_Query_Analytics_Panels_Filters.jpg b/docs/_images/PMM_Query_Analytics_Panels_Filters.jpg
diff --git a/docs/_images/PMM_Query_Analytics_filters.jpg b/docs/_images/PMM_Query_Analytics_filters.jpg
diff --git a/docs/index.md b/docs/index.md
@@ -51,6 +51,7 @@
 - [Contact Us](contact.md)
 - [Glossary](glossary-terminology.md)
 - [Release Notes](release-notes/index.md)
+    - [Percona Monitoring and Management 2.11.0](release-notes/2.11.0.md)
     - [Percona Monitoring and Management 2.10.1](release-notes/2.10.1.md)
     - [Percona Monitoring and Management 2.10.0](release-notes/2.10.0.md)
     - [Percona Monitoring and Management 2.9.1](release-notes/2.9.1.md)

diff --git a/docs/manage/conf-postgres.md b/docs/manage/conf-postgres.md
@@ -1,46 +1,299 @@
 # PostgreSQL
 
-PMM provides both metrics and queries monitoring for PostgreSQL. Queries monitoring needs additional `pg_stat_statements` extension to be installed and enabled.
+To monitor PostgreSQL queries, you must install a database extension. There are two choices:
 
-## Adding PostgreSQL extension for queries monitoring
+- `pg_stat_monitor`, a new extension created by Percona, based on `pg_stat_statements` and compatible with it.
 
-The needed extension is `pg_stat_statements`. It is included in the official PostgreSQL contrib package, so you have to install this package first with your Linux distribution package manager. Particularly, on Debian-based systems it is done as follows:
+- `pg_stat_statements`, the original extension created by PostgreSQL, part of the `postgres-contrib` package available on Linux.
+
+`pg_stat_monitor` provides all the features of `pg_stat_statements`, but extends it to provide bucket-based data aggregation, a feature missing from `pg_stat_statements`. (`pg_stat_statements` accumulates data without providing aggregated statistics or histogram information.)
+
+!!! note
+
+    - `pg_stat_monitor` is the recommended option.
+
+    - Although nothing prevents you from installing and using both, we don't recommend this as you will get duplicate metrics.
+
+!!! caution
+
+    `pg_stat_monitor` is beta software and currently unsupported.
+
+
+## Prerequisites
+
+We recommend that you create a PostgreSQL user for `SUPERUSER` level access. This lets you gather the most data with the least fuss.
+
+This user must be able to connect to the `postgres` database where the extension was installed. The PostgreSQL user should have local password authentication enabled to access PMM. To do this, set `ident` to `md5` for the user in the `pg_hba.conf` configuration file.
+
+To create a superuser:
+
+```sql
+CREATE USER pmm_user WITH SUPERUSER ENCRYPTED PASSWORD '******';
+```
+
+Or, if your database runs on Amazon RDS:
+
+```sql
+CREATE USER pmm_user WITH rds_superuser ENCRYPTED PASSWORD '******';
+```
+
+## `pg_stat_monitor`
+
+`pg_stat_monitor` collects statistics and aggregates data in a data collection unit called a *bucket* linked together to form a *bucket chain*.
+
+You can specify:
+
+- the number of buckets (the length of the chain);
+- how much space is available for all buckets;
+- a time limit for each bucket's data collection (the *bucket expiry*).
+
+When a bucket's expiration time is reached, accumulated statistics are reset and data is stored in the next available bucket in the chain.
+
+When all buckets in the chain have been used, the first bucket is reused and its contents are overwritten.
+
+If a bucket fills before its expiration time is reached, data is discarded.
+
+### Compatibility
+
+`pg_stat_monitor` has been tested with:
+
+- PostgreSQL versions 11, 12.
+- Percona Distribution for PostgreSQL versions 11, 12.
+
+(It should also work with versions 13 of both, but hasn't been tested.)
+
+### Install
+
+This extension can be installed in two ways:
+
+- For Percona Distribution for PostgreSQL: Using standard Linux package manager tools.
+
+- For PostgreSQL or Percona Distribution for PostgreSQL: [download and compile the source code](https://github.com/percona/pg_stat_monitor#installation).
+
+#### Install using Linux package manager
+
+The `pg-stat-monitor` extension is included in *Percona Distribution for PostgreSQL*. This can be installed via the `percona-release` package.
+
+This section reproduces parts of the following:
+
+- [Configuring Percona Repositories with percona-release](https://www.percona.com/doc/percona-repo-config/percona-release.html)
+
+- [Installing Percona Distribution for PostgreSQL](https://www.percona.com/doc/postgresql/LATEST/installing.html)
+
+##### Debian
 
 ```sh
-sudo apt-get install postgresql-contrib
+sudo apt-get install -y wget gnupg2 lsb-release
+wget https://repo.percona.com/apt/percona-release_latest.generic_all.deb
+sudo dpkg -i percona-release_latest.generic_all.deb
+
+sudo percona-release setup ppg-12 # version 12 (others available)
+sudo apt install -y percona-postgresql-12
 ```
 
-Now add/edit the following three lines in your `postgres.conf` file:
+##### Red Hat
+
+```sh
+sudo yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm
+
+# If RHEL 8
+sudo dnf module disable postgresql
 
-```ini
-shared_preload_libraries = 'pg_stat_statements'
-track_activity_query_size = 2048
-pg_stat_statements.track = all
+# If RHEL 7
+sudo yum install -y epel-release
+sudo yum repolist
+
+sudo percona-release setup ppg-12
+sudo yum install -y percona-postgresql12-server
 ```
 
-Besides making the appropriate module to be loaded, these edits will increase the maximum size of the query strings PostgreSQL records and will allow it to track all statements including nested ones. When the editing is over, restart PostgreSQL.
+#### Install from source code
 
-Finally, the following statement should be executed in the PostgreSQL shell to install the extension:
+##### Debian
 
-```sql
-CREATE EXTENSION pg_stat_statements SCHEMA public;
+1. Install common packages
+
+    ```sh
+    sudo apt-get install -y curl git wget gnupg2 lsb-release
+    sudo apt-get update -y
+    ```
+
+2. Install PostgreSQL development packages
+
+    With Percona Distribution for PostgreSQL (version 12):
+
+    ```sh
+    wget https://repo.percona.com/apt/percona-release_latest.generic_all.deb
+    sudo dpkg -i percona-release_latest.generic_all.deb
+    sudo percona-release setup ppg-12
+    sudo apt install -y percona-postgresql-server-dev-all
+    ```
+
+    With PostgreSQL:
+
+    ```sh
+    wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo  apt-key add -
+    echo "deb http://apt.postgresql.org/pub/repos/apt/ `lsb_release -cs`-pgdg main" | sudo tee /etc/apt/sources.list.d/pgdg.list
+    sudo apt install -y postgresql-server-dev-all
+    ```
+
+3. Download, compile, and install extension
+
+    ```sh
+    git clone git://github.com/percona/pg_stat_monitor.git && cd pg_stat_monitor
+    sudo make USE_PGXS=1
+    sudo make USE_PGXS=1 install
+    ```
+
+##### Red Hat
+
+1. Install common packages
+
+    ```sh
+    sudo yum install -y centos-release-scl epel-release
+    sudo yum update -y
+    sudo yum install -y git gcc gcc-c++ llvm-toolset-7
+    ```
+
+2. Install PostgreSQL development packages
+
+    With Percona Distribution for PostgreSQL (version 12):
+
+    ```sh
+    sudo yum install -y https://repo.percona.com/yum/percona-release-latest.noarch.rpm
+    sudo percona-release setup ppg-12
+    sudo yum install -y percona-postgresql12-devel
+    ```
+
+    With PostgreSQL version 12:
+
+    ```sh
+    sudo yum install -y https://download.postgresql.org/pub/repos/yum/reporpms/EL-7-x86_64/pgdg-redhat-repo-latest.noarch.rpm
+    sudo yum install -y postgresql12-devel
+    ```
+
+3. Download, compile, and install extension
+
+    ```sh
+    git clone git://github.com/percona/pg_stat_monitor.git && cd pg_stat_monitor
+    sudo make PG_CONFIG=/usr/pgsql-12/bin/pg_config USE_PGXS=1
+    sudo make PG_CONFIG=/usr/pgsql-12/bin/pg_config USE_PGXS=1 install
+    ```
+
+### Configure
+
+1. Set or change the value for `shared_preload_library` in your `postgresql.conf` file:
+
+    ```ini
+    shared_preload_libraries = 'pg_stat_monitor'
+    ```
+
+2. Set the value
+
+pg_stat_monitor.pgsm_normalized_query
+
+2. Start or restart your PostgreSQL instance.
+
+3. In a `psql` session:
+
+    ```sql
+    CREATE EXTENSION pg_stat_monitor;
+    ```
+
+
+### Configuration Parameters
+
+Here are the configuration parameters, available values ranges, and default values. All require a restart of PostgreSQL except for `pg_stat_monitor.pgsm_track_utility` and `pg_stat_monitor.pgsm_normalized_query`.
+
+To make settings permanent, add them to your `postgresql.conf` file before starting your PostgreSQL instance.
+
+`pg_stat_monitor.pgsm_max` (5000-2147483647 bytes) Default: 5000
+:    Defines the limit of shared memory. Memory is used by buckets in a circular manner and is divided between buckets equally when PostgreSQL starts.
+
+`pg_stat_monitor.pgsm_query_max_len` (1024-2147483647 bytes) Default: 1024
+:    The maximum size of the query. Long queries are truncated to this length to avoid unnecessary usage of shared memory. This parameter must be set before PostgreSQL starts.
+
+`pg_stat_monitor.pgsm_enable` (0-1) Default: 1 (true).
+:    Enables or disables monitoring. A value of `Disable` means that `pg_stat_monitor` will not collect statistics for the entire cluster.
+
+`pg_stat_monitor.pgsm_track_utility` (0-1) Default: 1 (true)
+:    Controls whether utility commands (all except SELECT, INSERT, UPDATE and DELETE) are tracked.
+
+`pg_stat_monitor.pgsm_normalized_query` (0-1) Default: 0 (false)
+:    By default, a query shows the actual parameter instead of a placeholder. Set to 1 to change to showing value placeholders (as `$n` where `n` is an integer).
+
+`pg_stat_monitor.pgsm_max_buckets` (1-10) Default: 10
+:    Sets the maximum number of available data buckets.
+
+`pg_stat_monitor.pgsm_bucket_time` (1-2147483647 seconds) Default: 60
+:    Sets the lifetime of the bucket. The system switches between buckets on the basis of this value.
+
+`pg_stat_monitor.pgsm_object_cache` (50-2147483647) Default: 50
+:    The maximum number of objects in the information cache.
+
+`pg_stat_monitor.pgsm_respose_time_lower_bound` (1-2147483647 milliseconds) Default: 1
+:    Sets the lower bound of the execution time histogram.
+
+`pg_stat_monitor.pgsm_respose_time_step` (1-2147483647 milliseconds) Default: 1
+:    Sets the time value of the steps for the histogram.
+
+`pg_stat_monitor.pgsm_query_shared_buffer` (500000-2147483647 bytes) Default: 500000
+:   Sets the query shared_buffer size.
+
+`pg_stat_monitor.pgsm_track_planning` (0-1) Default: 1 (true)
+:   Whether to track planning statistics.
+
+
+## `pg_stat_statements`
+
+`pg_stat_statements` is included in the official PostgreSQL `postgresql-contrib` available from your Linux distribution package manager.
+
+### Install
+
+#### Debian
+
+```sh
+sudo apt-get install postgresql-contrib
 ```
 
-!!! note
+#### Red Hat
+
+```sh
+sudo yum install -y postgresql-contrib
+```
+
+### Configure
+
+1. Add these lines to your `postgresql.conf` file:
+
+    ```sh
+    shared_preload_libraries = 'pg_stat_statements'
+    track_activity_query_size = 2048 # Increase tracked query string size
+    pg_stat_statements.track = all   # Track all statements including nested
+    ```
 
-    `CREATE EXTENSION` statement should be run in the `postgres` database.
+2. Restart your PostgreSQL instance.
+
+3. Install the extension (run in the `postgres` database).
+
+    ```sh
+    CREATE EXTENSION pg_stat_statements SCHEMA public;
+    ```
 
 ## Adding PostgreSQL queries and metrics monitoring
 
-You can add PostgreSQL metrics and queries monitoring with the following command:
+You add PostgreSQL metrics and queries monitoring with the following command:
 
 ```sh
-pmm-admin add postgresql --username=pmm --password=pmm
+pmm-admin add postgresql --username=<user name> --password=<password>
 ```
 
-where username and password parameters should contain actual PostgreSQL user credentials.
+Where `<user name>` and `<password>` are the PostgreSQL user credentials.
 
-Additionally, two positional arguments can be appended to the command line flags: a service name to be used by PMM, and a service address. If not specified, they are substituted automatically as `<node>-postgresql` and `127.0.0.1:5432`.
+Additionally, two positional arguments can be appended to the command line
+flags: a service name to be used by PMM, and a service address. If not
+specified, they are substituted automatically as `<node>-postgresql` and
+`127.0.0.1:5432`.
 
 The command line and the output of this command may look as follows:
 
@@ -51,7 +304,7 @@ Service ID  : /service_id/28f1d93a-5c16-467f-841b-8c014bf81ca6
 Service name: postgres
 ```
 
-As a result, you should be able to see data in PostgreSQL Overview dashboard, and also Query Analytics should contain PostgreSQL queries, if the needed extension was installed and configured correctly.
+If correct installed and set up, you should be able to see data in PostgreSQL Overview dashboard, and also Query Analytics should contain PostgreSQL queries.
 
 Beside positional arguments shown above you can specify service name and service address with the following flags: `--service-name`, `--host` (the hostname or IP address of the service), and `--port` (the port number of the service). If both flag and positional argument are present, flag gains higher priority. Here is the previous example modified to use these flags:
 
@@ -67,25 +320,14 @@ pmm-admin add postgresql --socket=/var/run/postgresql
 
 Capturing read and write time statistics is possible only if `track_io_timing` setting is enabled. This can be done either in configuration file or with the following query executed on the running system:
 
-```sql
+
+```sh
 ALTER SYSTEM SET track_io_timing=ON;
 SELECT pg_reload_conf();
 ```
 
-## Setting up the required user permissions and authentication
-
-Percona recommends that a PostgreSQL user be configured for `SUPERUSER` level access, in order to gather the maximum amount of data with a minimum amount of complexity. This can be done with the following command for the standalone PostgreSQL installation:
-
-```sql
-CREATE USER pmm_user WITH SUPERUSER ENCRYPTED PASSWORD 'secret';
-```
-
-In case of monitoring a PostgreSQL database running on an Amazon RDS instance, the command should look as follows:
+!!! seealso "See also"
 
-```sql
-CREATE USER pmm_user WITH rds_superuser ENCRYPTED PASSWORD 'secret';
-```
-
-!!! note
+    - `pg_stat_monitor Github repository <https://github.com/percona/pg_stat_monitor>`__
 
-    Specified PostgreSQL user should have enabled local password authentication to enable access for PMM. This can be set in the `pg_hba.conf` configuration file changing `ident` to `md5` for the correspondent user. Also, this user should be able to connect to the `postgres` database which we have installed the extension into.
+    - `PostgreSQL pg_stat_statements module <https://www.postgresql.org/docs/current/pgstatstatements.html>`__
diff --git a/docs/metrics-monitor-dashboards.md b/docs/metrics-monitor-dashboards.md
@@ -80,6 +80,6 @@ PMM Server can't currently directly render dashboard images exported by Grafana
 5. A new browser tab opens. Wait for the image to be rendered then use your browser's image save function to download the image.
 
 
-If the Grafana plugins are not installed, a message in the Share Panel will say so.
+If the necessary plugins are not installed, a message in the Share Panel will say so.
 
 ![image](_images/PMM_Common_Panel_Menu_Share_Link_Missing_Plugins.jpg)
diff --git a/docs/qan-filtering.md b/docs/qan-filtering.md
@@ -1,2 +1,2 @@
 <!-- Redirect to new location -->
-<script type="text/javascript">window.location.href = "qan-intro.html";</script>
+<script type="text/javascript">window.location.href = "query-analytics.html";</script>