From 030952336796343ab3beba863f586c6c2121926f Mon Sep 17 00:00:00 2001 From: piano35-edb <160748516+piano35-edb@users.noreply.github.com> Date: Thu, 16 May 2024 13:19:01 -0500 Subject: [PATCH 1/5] add extensions: wal2json, system_stats --- advocacy_docs/pg_extensions/index.mdx.in | 2 + .../system_stats/configuring.mdx | 32 +++++++++ .../pg_extensions/system_stats/index.mdx | 15 ++++ .../pg_extensions/system_stats/installing.mdx | 71 +++++++++++++++++++ .../pg_extensions/system_stats/using.mdx | 6 ++ .../pg_extensions/wal2json/configuring.mdx | 33 +++++++++ .../pg_extensions/wal2json/index.mdx | 23 ++++++ .../pg_extensions/wal2json/installing.mdx | 71 +++++++++++++++++++ .../pg_extensions/wal2json/using.mdx | 6 ++ src/pages/index.js | 8 +++ 10 files changed, 267 insertions(+) create mode 100644 advocacy_docs/pg_extensions/system_stats/configuring.mdx create mode 100644 advocacy_docs/pg_extensions/system_stats/index.mdx create mode 100644 advocacy_docs/pg_extensions/system_stats/installing.mdx create mode 100644 advocacy_docs/pg_extensions/system_stats/using.mdx create mode 100644 advocacy_docs/pg_extensions/wal2json/configuring.mdx create mode 100644 advocacy_docs/pg_extensions/wal2json/index.mdx create mode 100644 advocacy_docs/pg_extensions/wal2json/installing.mdx create mode 100644 advocacy_docs/pg_extensions/wal2json/using.mdx diff --git a/advocacy_docs/pg_extensions/index.mdx.in b/advocacy_docs/pg_extensions/index.mdx.in index eb5d53649dd..697a41b12fb 100644 --- a/advocacy_docs/pg_extensions/index.mdx.in +++ b/advocacy_docs/pg_extensions/index.mdx.in @@ -14,6 +14,8 @@ navigation: - "#EDB Postgres Advanced Server only" - spl_check - edb_job_scheduler + - wal2json + - system_stats --- Categories of extensions: diff --git a/advocacy_docs/pg_extensions/system_stats/configuring.mdx b/advocacy_docs/pg_extensions/system_stats/configuring.mdx new file mode 100644 index 00000000000..c35077c80e8 --- /dev/null +++ b/advocacy_docs/pg_extensions/system_stats/configuring.mdx @@ -0,0 +1,32 @@ +--- +title: Configuring system_stats +navTitle: Configuring +--- + +1. Add `system_stats` to the `shared_preload_libraries` parameter: + + ```ini + shared_preload_libraries = 'system_stats' + ``` + + !!! Note + If `shared_preload_libraries` has other extensions, then you can add `system_stats` to the list. The order doesn't matter. + !!! + +1. Add these changes to `postgresql.conf`: + + ```shell + wal_level = logical + max_replication_slots = 1 # ... or add 1 to the current value. + ``` + +1. Restart Postgres. + +1. Create the `system_stats` extension in your database: + + ```shell + CREATE EXTENSION system_stats; + ``` +!!! Note + When upgrading a database cluster with `system_stats` installed (either using `pg_dumpall`/`pg_restore` or `pg_upgrade`), make sure that the new cluster has `system_stats` in `shared_preload_libraries` before you upgrade. Otherwise the upgrade fails. + diff --git a/advocacy_docs/pg_extensions/system_stats/index.mdx b/advocacy_docs/pg_extensions/system_stats/index.mdx new file mode 100644 index 00000000000..4bc03f7de73 --- /dev/null +++ b/advocacy_docs/pg_extensions/system_stats/index.mdx @@ -0,0 +1,15 @@ +--- +title: 'system_stats' +indexCards: none +navigation: + - installing + - configuring + - using +--- +system_stats (`system_stats`) is a Postgres extension that provides functions to access system level statistics that can be used for monitoring. It supports Linux, macOS and Windows. + +For more information about `system_stats`, see: + +- [Installing system_stats](installing.mdx) +- [Configuring system_stats](configuring.mdx) +- [Using system_stats](using.mdx) \ No newline at end of file diff --git a/advocacy_docs/pg_extensions/system_stats/installing.mdx b/advocacy_docs/pg_extensions/system_stats/installing.mdx new file mode 100644 index 00000000000..a8094899988 --- /dev/null +++ b/advocacy_docs/pg_extensions/system_stats/installing.mdx @@ -0,0 +1,71 @@ +--- +title: Installing system_stats +navTitle: Installing +--- + +`system_stats` is supported on the same platforms as the Postgres distribution you're using. Support for `system_stats` starts with Postgres 12. For details, see: + +- [EDB Postgres Advanced Server Product Compatibility](https://www.enterprisedb.com/platform-compatibility#epas) +- [PostgreSQL Product Compatibility](https://www.enterprisedb.com/resources/platform-compatibility#pg) +- [EDB Postgres Extended Server Product Compatibility](https://www.enterprisedb.com/resources/platform-compatibility#epas_extended) + +## Installation + +Before you begin the installation process: + +- Install Postgres. See: + + - [Installing EDB Postgres Advanced Server](/epas/latest/installing/) + + - [Installing PostgreSQL](https://www.postgresql.org/download/) + + - [Installing EDB Postgres Extended Server](/pge/latest/installing/) + +- Set up the repository. + + Setting up the repository is a one-time task. If you've already set up your repository, you don't need to perform this step. + + To set up the repository, go to [EDB repositories](https://www.enterprisedb.com/repos-downloads) and follow the instructions provided there. + +## Install the package + +The syntax for the package install command is: + +```shell +# For SLES, CentOS, RHEL and its derivatives +sudo -y install edb--pg-system_stats2 + +# For Debian and Ubuntu +sudo -y install edb--pg-system_stats2 +``` + +Where: +- ``is the package manager used with your operating system: + + | Package manager | Operating system | + | --------------- | -------------------------------- | + | dnf | RHEL 8/9 and derivatives | + | yum | RHEL 7 and derivatives, CentOS 7 | + | zypper | SLES | + | apt-get | Debian and derivatives | + +- `` is the distribution of Postgres you're using: + + | Postgres distribution | Value | + | ---------------------------- | ---------- | + | PostgreSQL | pg | + | EDB Postgres Advanced Server | as | + | EDB Postgres Extended Server | postgresextended | + +- `` is the version of Postgres you're using. + +For example, to install system_stats for EDB Postgres Advanced Server 15 on a RHEL 8 platform: + +```shell +sudo dnf -y install edb-as15-pg-system_stats2 +``` + + + + + diff --git a/advocacy_docs/pg_extensions/system_stats/using.mdx b/advocacy_docs/pg_extensions/system_stats/using.mdx new file mode 100644 index 00000000000..82bac4f86fe --- /dev/null +++ b/advocacy_docs/pg_extensions/system_stats/using.mdx @@ -0,0 +1,6 @@ +--- +title: Using system_stats +navTitle: Using +--- + +For more information about using `system_stats`, see the [Github repository](https://github.com/EnterpriseDB/system_stats/blob/master/README.md). \ No newline at end of file diff --git a/advocacy_docs/pg_extensions/wal2json/configuring.mdx b/advocacy_docs/pg_extensions/wal2json/configuring.mdx new file mode 100644 index 00000000000..f0eac5fb7f3 --- /dev/null +++ b/advocacy_docs/pg_extensions/wal2json/configuring.mdx @@ -0,0 +1,33 @@ +--- +title: Configuring wal2json +navTitle: Configuring +--- + +1. Add `wal2json` to the `shared_preload_libraries` parameter: + + ```ini + shared_preload_libraries = 'wal2json' + ``` + + !!! Note + If `shared_preload_libraries` has other extensions, then you can add `wal2json` to the list. The order doesn't matter. + !!! + +1. Add these changes to `postgresql.conf`: + + ```shell + wal_level = logical + max_replication_slots = 1 # ... or add 1 to the current value. + ``` + +1. Restart Postgres. + +1. Create the `wal2json` extension in your database: + + ```shell + CREATE EXTENSION wal2json; + ``` + +!!! Note + When upgrading a database cluster with `wal2json` installed (either using `pg_dumpall`/`pg_restore` or `pg_upgrade`), make sure that the new cluster has `wal2json` in `shared_preload_libraries` before you upgrade. Otherwise the upgrade fails. + diff --git a/advocacy_docs/pg_extensions/wal2json/index.mdx b/advocacy_docs/pg_extensions/wal2json/index.mdx new file mode 100644 index 00000000000..d38e86152d6 --- /dev/null +++ b/advocacy_docs/pg_extensions/wal2json/index.mdx @@ -0,0 +1,23 @@ +--- +title: 'wal2json' +indexCards: none +navigation: + - installing + - configuring + - using +--- + +wal2json (`wal2json`) is an extension released as open source software under the PostgreSQL License. + +`wal2json` is an output plugin for logical decoding. It has access to the following: + + - Tuples produced by INSERT and UPDATE. + - UPDATE/DELETE old row versions *(depending on the configured replica identity)*. + + Changes can be consumed using the streaming protocol (logical replication slots) or by a SQL API. + +For more information about `wal2json`, see: + +- [Installing wal2json](installing.mdx) +- [Configuring wal2json](configuring.mdx) +- [Using wal2json](using.mdx) \ No newline at end of file diff --git a/advocacy_docs/pg_extensions/wal2json/installing.mdx b/advocacy_docs/pg_extensions/wal2json/installing.mdx new file mode 100644 index 00000000000..4dfb7fd59d2 --- /dev/null +++ b/advocacy_docs/pg_extensions/wal2json/installing.mdx @@ -0,0 +1,71 @@ +--- +title: Installing wal2json +navTitle: Installing +--- + +`wal2json` is supported on the same platforms as the Postgres distribution you're using. Support for `wal2json` starts with Postgres 12. For details, see: + +- [EDB Postgres Advanced Server Product Compatibility](https://www.enterprisedb.com/platform-compatibility#epas) +- [PostgreSQL Product Compatibility](https://www.enterprisedb.com/resources/platform-compatibility#pg) +- [EDB Postgres Extended Server Product Compatibility](https://www.enterprisedb.com/resources/platform-compatibility#epas_extended) + +## Installation + +Before you begin the installation process: + +- Install Postgres. See: + + - [Installing EDB Postgres Advanced Server](/epas/latest/installing/) + + - [Installing PostgreSQL](https://www.postgresql.org/download/) + + - [Installing EDB Postgres Extended Server](/pge/latest/installing/) + +- Set up the repository. + + Setting up the repository is a one-time task. If you've already set up your repository, you don't need to perform this step. + + To set up the repository, go to [EDB repositories](https://www.enterprisedb.com/repos-downloads) and follow the instructions provided there. + +## Install the package + +The syntax for the package install command is: + +```shell +# For SLES, CentOS, RHEL and its derivatives +sudo -y install edb--pg-wal2json2 + +# For Debian and Ubuntu +sudo -y install edb--pg-wal2json2 +``` + +Where: +- ``is the package manager used with your operating system: + + | Package manager | Operating system | + | --------------- | -------------------------------- | + | dnf | RHEL 8/9 and derivatives | + | yum | RHEL 7 and derivatives, CentOS 7 | + | zypper | SLES | + | apt-get | Debian and derivatives | + +- `` is the distribution of Postgres you're using: + + | Postgres distribution | Value | + | ---------------------------- | ---------- | + | PostgreSQL | pg | + | EDB Postgres Advanced Server | as | + | EDB Postgres Extended Server | postgresextended | + +- `` is the version of Postgres you're using. + +For example, to install wal2json for EDB Postgres Advanced Server 15 on a RHEL 8 platform: + +```shell +sudo dnf -y install edb-as15-pg-wal2json2 +``` + + + + + diff --git a/advocacy_docs/pg_extensions/wal2json/using.mdx b/advocacy_docs/pg_extensions/wal2json/using.mdx new file mode 100644 index 00000000000..b2b31c45740 --- /dev/null +++ b/advocacy_docs/pg_extensions/wal2json/using.mdx @@ -0,0 +1,6 @@ +--- +title: Using wal2json +navTitle: Using +--- + +For more information about using `wal2json`, see the [Github repository](https://github.com/eulerto/wal2json/blob/master/README.md). \ No newline at end of file diff --git a/src/pages/index.js b/src/pages/index.js index 28a78cb1d8a..548c9da01b2 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -174,6 +174,14 @@ const Page = () => { Language Pack + + + wal2json + + + + system_stats + Date: Fri, 17 May 2024 10:21:49 -0500 Subject: [PATCH 2/5] modify instructions, relocate to parent --- advocacy_docs/pg_extensions/index.mdx.in | 5 ++-- .../pg_extensions/system_stats/index.mdx | 2 ++ .../pg_extensions/system_stats/installing.mdx | 6 ++-- .../pg_extensions/wal2json/configuring.mdx | 28 +++++-------------- .../pg_extensions/wal2json/index.mdx | 2 ++ .../pg_extensions/wal2json/installing.mdx | 6 ++-- 6 files changed, 20 insertions(+), 29 deletions(-) diff --git a/advocacy_docs/pg_extensions/index.mdx.in b/advocacy_docs/pg_extensions/index.mdx.in index 697a41b12fb..ace2697c4b2 100644 --- a/advocacy_docs/pg_extensions/index.mdx.in +++ b/advocacy_docs/pg_extensions/index.mdx.in @@ -11,11 +11,12 @@ navigation: - wait_states - pg_failover_slots - pg_squeeze + - wal2json + - system_stats - "#EDB Postgres Advanced Server only" - spl_check - edb_job_scheduler - - wal2json - - system_stats + --- Categories of extensions: diff --git a/advocacy_docs/pg_extensions/system_stats/index.mdx b/advocacy_docs/pg_extensions/system_stats/index.mdx index 4bc03f7de73..75684999994 100644 --- a/advocacy_docs/pg_extensions/system_stats/index.mdx +++ b/advocacy_docs/pg_extensions/system_stats/index.mdx @@ -1,6 +1,8 @@ --- title: 'system_stats' indexCards: none +directoryDefaults: + product: system_stats navigation: - installing - configuring diff --git a/advocacy_docs/pg_extensions/system_stats/installing.mdx b/advocacy_docs/pg_extensions/system_stats/installing.mdx index a8094899988..27263cf917d 100644 --- a/advocacy_docs/pg_extensions/system_stats/installing.mdx +++ b/advocacy_docs/pg_extensions/system_stats/installing.mdx @@ -33,10 +33,10 @@ The syntax for the package install command is: ```shell # For SLES, CentOS, RHEL and its derivatives -sudo -y install edb--pg-system_stats2 +sudo -y install edb--system-stats2 # For Debian and Ubuntu -sudo -y install edb--pg-system_stats2 +sudo -y install edb--system-stats2 ``` Where: @@ -62,7 +62,7 @@ Where: For example, to install system_stats for EDB Postgres Advanced Server 15 on a RHEL 8 platform: ```shell -sudo dnf -y install edb-as15-pg-system_stats2 +sudo dnf -y install edb-as15-system-stats2 ``` diff --git a/advocacy_docs/pg_extensions/wal2json/configuring.mdx b/advocacy_docs/pg_extensions/wal2json/configuring.mdx index f0eac5fb7f3..2d66c1cca2f 100644 --- a/advocacy_docs/pg_extensions/wal2json/configuring.mdx +++ b/advocacy_docs/pg_extensions/wal2json/configuring.mdx @@ -2,30 +2,16 @@ title: Configuring wal2json navTitle: Configuring --- - -1. Add `wal2json` to the `shared_preload_libraries` parameter: - - ```ini - shared_preload_libraries = 'wal2json' - ``` - - !!! Note - If `shared_preload_libraries` has other extensions, then you can add `wal2json` to the list. The order doesn't matter. - !!! - 1. Add these changes to `postgresql.conf`: ```shell - wal_level = logical - max_replication_slots = 1 # ... or add 1 to the current value. - ``` - -1. Restart Postgres. - -1. Create the `wal2json` extension in your database: - - ```shell - CREATE EXTENSION wal2json; +wal_level = logical + # + # these parameters only need to set in versions 9.4, 9.5 and 9.6 + # default values are ok in version 10 or later + # +max_replication_slots = 10 +max_wal_senders = 10 ``` !!! Note diff --git a/advocacy_docs/pg_extensions/wal2json/index.mdx b/advocacy_docs/pg_extensions/wal2json/index.mdx index d38e86152d6..d3c4945c15e 100644 --- a/advocacy_docs/pg_extensions/wal2json/index.mdx +++ b/advocacy_docs/pg_extensions/wal2json/index.mdx @@ -1,6 +1,8 @@ --- title: 'wal2json' indexCards: none +directoryDefaults: + product: wal2json navigation: - installing - configuring diff --git a/advocacy_docs/pg_extensions/wal2json/installing.mdx b/advocacy_docs/pg_extensions/wal2json/installing.mdx index 4dfb7fd59d2..02885c33389 100644 --- a/advocacy_docs/pg_extensions/wal2json/installing.mdx +++ b/advocacy_docs/pg_extensions/wal2json/installing.mdx @@ -33,10 +33,10 @@ The syntax for the package install command is: ```shell # For SLES, CentOS, RHEL and its derivatives -sudo -y install edb--pg-wal2json2 +sudo -y install edb--wal2json2 # For Debian and Ubuntu -sudo -y install edb--pg-wal2json2 +sudo -y install edb--wal2json2 ``` Where: @@ -62,7 +62,7 @@ Where: For example, to install wal2json for EDB Postgres Advanced Server 15 on a RHEL 8 platform: ```shell -sudo dnf -y install edb-as15-pg-wal2json2 +sudo dnf -y install edb-as15-wal2json2 ``` From c6f2ce866226ee7b6385f3c31879aea5662bf1cc Mon Sep 17 00:00:00 2001 From: piano35-edb <160748516+piano35-edb@users.noreply.github.com> Date: Fri, 17 May 2024 10:51:15 -0500 Subject: [PATCH 3/5] location in docs --- advocacy_docs/pg_extensions/extensionrefs.json | 4 +++- advocacy_docs/pg_extensions/index.mdx.in | 1 - src/pages/index.js | 16 ++++++++-------- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/advocacy_docs/pg_extensions/extensionrefs.json b/advocacy_docs/pg_extensions/extensionrefs.json index 9ccdd30e4ce..cd044da3aa6 100644 --- a/advocacy_docs/pg_extensions/extensionrefs.json +++ b/advocacy_docs/pg_extensions/extensionrefs.json @@ -120,5 +120,7 @@ "bdr_5.x":"https://www.enterprisedb.com/docs/pgd/5/", "pg_cron":"https://github.com/citusdata/pg_cron", "sql_profiler":"https://www.enterprisedb.com/docs/pem/latest/profiling_workloads/using_sql_profiler/", - "pg_squeeze":"https://www.enterprisedb.com/docs/pg_extensions/pg_squeeze/" + "pg_squeeze":"https://www.enterprisedb.com/docs/pg_extensions/pg_squeeze/", + "wal2json":"https://www.enterprisedb.com/docs/pg_extensions/wal2json/", + "system_stats":"https://www.enterprisedb.com/docs/pg_extensions/system_stats/" } \ No newline at end of file diff --git a/advocacy_docs/pg_extensions/index.mdx.in b/advocacy_docs/pg_extensions/index.mdx.in index ace2697c4b2..4840f36cce4 100644 --- a/advocacy_docs/pg_extensions/index.mdx.in +++ b/advocacy_docs/pg_extensions/index.mdx.in @@ -16,7 +16,6 @@ navigation: - "#EDB Postgres Advanced Server only" - spl_check - edb_job_scheduler - --- Categories of extensions: diff --git a/src/pages/index.js b/src/pages/index.js index 548c9da01b2..5f56788aa16 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -155,6 +155,14 @@ const Page = () => { PG Squeeze + + wal2json + + + + system_stats + + EDB Job Scheduler @@ -174,14 +182,6 @@ const Page = () => { Language Pack - - - wal2json - - - - system_stats - Date: Fri, 17 May 2024 11:18:35 -0500 Subject: [PATCH 4/5] fix index.in issue --- advocacy_docs/pg_extensions/index.mdx | 3 +++ advocacy_docs/pg_extensions/index.mdx.in | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/advocacy_docs/pg_extensions/index.mdx b/advocacy_docs/pg_extensions/index.mdx index b73999c5e89..1903da37d64 100644 --- a/advocacy_docs/pg_extensions/index.mdx +++ b/advocacy_docs/pg_extensions/index.mdx @@ -11,6 +11,8 @@ navigation: - wait_states - pg_failover_slots - pg_squeeze + - system_stats + - wal2json - "#EDB Postgres Advanced Server only" - spl_check - edb_job_scheduler @@ -118,6 +120,7 @@ Categories of extensions:     pltcluYes✓✓✓––✓✓✓ set_user✓––––––– sslutils✓✓✓––––– +system_stats✓✓✓––––– timescaledb✓––––––– diff --git a/advocacy_docs/pg_extensions/index.mdx.in b/advocacy_docs/pg_extensions/index.mdx.in index 4840f36cce4..0b25a3cd731 100644 --- a/advocacy_docs/pg_extensions/index.mdx.in +++ b/advocacy_docs/pg_extensions/index.mdx.in @@ -11,8 +11,8 @@ navigation: - wait_states - pg_failover_slots - pg_squeeze - - wal2json - system_stats + - wal2json - "#EDB Postgres Advanced Server only" - spl_check - edb_job_scheduler From 4ceab50debc769f9db0406591448c46a499d0b48 Mon Sep 17 00:00:00 2001 From: piano35-edb <160748516+piano35-edb@users.noreply.github.com> Date: Fri, 17 May 2024 11:38:31 -0500 Subject: [PATCH 5/5] remove unnecessary config steps --- .../system_stats/configuring.mdx | 24 ++----------------- .../pg_extensions/wal2json/configuring.mdx | 9 +------ 2 files changed, 3 insertions(+), 30 deletions(-) diff --git a/advocacy_docs/pg_extensions/system_stats/configuring.mdx b/advocacy_docs/pg_extensions/system_stats/configuring.mdx index c35077c80e8..b663a27bcbe 100644 --- a/advocacy_docs/pg_extensions/system_stats/configuring.mdx +++ b/advocacy_docs/pg_extensions/system_stats/configuring.mdx @@ -2,31 +2,11 @@ title: Configuring system_stats navTitle: Configuring --- - -1. Add `system_stats` to the `shared_preload_libraries` parameter: - - ```ini - shared_preload_libraries = 'system_stats' - ``` - - !!! Note - If `shared_preload_libraries` has other extensions, then you can add `system_stats` to the list. The order doesn't matter. - !!! - -1. Add these changes to `postgresql.conf`: - - ```shell - wal_level = logical - max_replication_slots = 1 # ... or add 1 to the current value. - ``` - -1. Restart Postgres. - 1. Create the `system_stats` extension in your database: ```shell CREATE EXTENSION system_stats; ``` -!!! Note - When upgrading a database cluster with `system_stats` installed (either using `pg_dumpall`/`pg_restore` or `pg_upgrade`), make sure that the new cluster has `system_stats` in `shared_preload_libraries` before you upgrade. Otherwise the upgrade fails. + +No other configuration steps are required. diff --git a/advocacy_docs/pg_extensions/wal2json/configuring.mdx b/advocacy_docs/pg_extensions/wal2json/configuring.mdx index 2d66c1cca2f..af29b6353a6 100644 --- a/advocacy_docs/pg_extensions/wal2json/configuring.mdx +++ b/advocacy_docs/pg_extensions/wal2json/configuring.mdx @@ -6,14 +6,7 @@ navTitle: Configuring ```shell wal_level = logical - # - # these parameters only need to set in versions 9.4, 9.5 and 9.6 - # default values are ok in version 10 or later - # -max_replication_slots = 10 -max_wal_senders = 10 ``` -!!! Note - When upgrading a database cluster with `wal2json` installed (either using `pg_dumpall`/`pg_restore` or `pg_upgrade`), make sure that the new cluster has `wal2json` in `shared_preload_libraries` before you upgrade. Otherwise the upgrade fails. +No other configuration steps are required.