-
Notifications
You must be signed in to change notification settings - Fork 249
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5630 from EnterpriseDB/extensions-wal2json-system…
…stats-051624 add extensions: wal2json, system_stats
- Loading branch information
Showing
12 changed files
with
236 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| title: Configuring system_stats | ||
| navTitle: Configuring | ||
| --- | ||
| 1. Create the `system_stats` extension in your database: | ||
|
|
||
| ```shell | ||
| CREATE EXTENSION system_stats; | ||
| ``` | ||
|
|
||
| No other configuration steps are required. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| title: 'system_stats' | ||
| indexCards: none | ||
| directoryDefaults: | ||
| product: system_stats | ||
| 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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 <package-manager> -y install edb-<postgres><postgres_version>-system-stats2 | ||
|
|
||
| # For Debian and Ubuntu | ||
| sudo <package-manager> -y install edb-<postgres><postgres_version>-system-stats2 | ||
| ``` | ||
|
|
||
| Where: | ||
| - `<package-manager>`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 | | ||
|
|
||
| - `<postgres>` is the distribution of Postgres you're using: | ||
|
|
||
| | Postgres distribution | Value | | ||
| | ---------------------------- | ---------- | | ||
| | PostgreSQL | pg | | ||
| | EDB Postgres Advanced Server | as | | ||
| | EDB Postgres Extended Server | postgresextended | | ||
|
|
||
| - `<postgres_version>` 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-system-stats2 | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| title: Configuring wal2json | ||
| navTitle: Configuring | ||
| --- | ||
| 1. Add these changes to `postgresql.conf`: | ||
|
|
||
| ```shell | ||
| wal_level = logical | ||
| ``` | ||
|
|
||
| No other configuration steps are required. | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| title: 'wal2json' | ||
| indexCards: none | ||
| directoryDefaults: | ||
| product: wal2json | ||
| 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) |
Oops, something went wrong.
477e19dThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉 Published on https://edb-docs-staging.netlify.app as production
🚀 Deployed on https://6647a6f88c65b113f04cdc45--edb-docs-staging.netlify.app