From f986ac009620cea0924cfcfa2ca9c8b191fd1548 Mon Sep 17 00:00:00 2001 From: Anastasia Alexadrova Date: Thu, 7 Oct 2021 15:11:25 +0300 Subject: [PATCH] PG-255 Doc - Fix README title and TOC modified: README.md --- README.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index cae7861..1dcee35 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,16 @@ ![pg13-test](https://github.com/percona/pg_stat_monitor/workflows/pg13-test/badge.svg) ![pg14-test](https://github.com/percona/pg_stat_monitor/workflows/pg14-test/badge.svg) -# pg_stat_monitor: Query Performance Tool for PostgreSQL +# pg_stat_monitor: Query Performance Monitoring Tool for PostgreSQL ## Table of Contents * [Overview](#overview) -* [pg_stat_monitor features](#pg_stat_monitor-features) -* [Documentation](#documentation) * [Supported versions](#supported-versions) +* [Features](#features) +* [Documentation](#documentation) * [Supported platforms](#supported-platforms) -* [Installation](#installation) +* [Installation guidelines](#installation-guidelines) * [Configuration](#configuration) * [Setup](#setup) * [Building from source code](#building-from-source) @@ -38,8 +38,17 @@ The RPM (for RHEL and CentOS) and the DEB (for Debian and Ubuntu) packages are a The RPM packages are also available in the official PostgreSQL (PGDG) yum repositories. +### Supported versions -### pg_stat_monitor features +The `pg_stat_monitor` should work on the latest version of both [Percona Distribution for PostgreSQL](https://www.percona.com/software/postgresql-distribution) and PostgreSQL, but is only tested with these versions: + +| **Distribution** | **Version** | **Provider** | +| ---------------- | --------------- | ------------ | +|[Percona Distribution for PostgreSQL](https://www.percona.com/software/postgresql-distribution)| [11](https://www.percona.com/downloads/percona-postgresql-11/LATEST/), [12](https://www.percona.com/downloads/postgresql-distribution-12/LATEST/) and [13](https://www.percona.com/downloads/postgresql-distribution-13/LATEST/)| Percona| +| PostgreSQL | 11, 12, and 13 | PostgreSQL Global Development Group (PGDG) | + + +### Features `pg_stat_monitor` simplifies query observability by providing a more holistic view of query from performance, application and analysis perspectives. This is achieved by grouping data in configurable time buckets that allow capturing of load and performance information for smaller time windows. So performance issues and patterns can be identified based on time and workload. @@ -61,16 +70,6 @@ The RPM packages are also available in the official PostgreSQL (PGDG) yum reposi 5. Contributing guide (https://github.com/percona/pg_stat_monitor/blob/master/CONTRIBUTING.md) -### Supported versions - -The `pg_stat_monitor` should work on the latest version of both [Percona Distribution for PostgreSQL](https://www.percona.com/software/postgresql-distribution) and PostgreSQL, but is only tested with these versions: - -| **Distribution** | **Version** | **Provider** | -| ---------------- | --------------- | ------------ | -|[Percona Distribution for PostgreSQL](https://www.percona.com/software/postgresql-distribution)| [11](https://www.percona.com/downloads/percona-postgresql-11/LATEST/), [12](https://www.percona.com/downloads/postgresql-distribution-12/LATEST/) and [13](https://www.percona.com/downloads/postgresql-distribution-13/LATEST/)| Percona| -| PostgreSQL | 11, 12, and 13 | PostgreSQL Global Development Group (PGDG) | - - ### Supported platforms The PostgreSQL YUM repository supports `pg_stat_monitor` for all [supported versions](#supported-versions) for the following platforms: @@ -81,7 +80,7 @@ The PostgreSQL YUM repository supports `pg_stat_monitor` for all [supported vers Find the list of supported platforms for `pg_stat_monitor` within [Percona Distribution for PostgreSQL](https://www.percona.com/software/postgresql-distribution) on the [Percona Release Lifecycle Overview](https://www.percona.com/services/policies/percona-software-support-lifecycle#pgsql) page. -### Installation +### Installation Guidelines You can install `pg_stat_monitor` from the following sources: