Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add extension pgaudit #6232

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions advocacy_docs/pg_extensions/pgaudit/configuring.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Configuring pgaudit
navTitle: Configuring
---

1. In `postgresql.conf`, add `pgaudit` to the `shared_preload_libraries` parameter:

```ini
shared_preload_libraries = 'pgaudit'
```

If `shared_preload_libraries` has other extensions, then you can add `pgaudit` to the list. The order doesn't matter.


1. Restart Postgres.


1. Create the `pgaudit` extension in your database:

```shell
CREATE EXTENSION pgaudit;
```

For detailed information on other configuration steps, see the official [pgaudit documentation](https://github.com/pgaudit/pgaudit).
23 changes: 23 additions & 0 deletions advocacy_docs/pg_extensions/pgaudit/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: 'pgaudit'
indexCards: none
navigation:
- rel_notes
- installing
- configuring
- using
directoryDefaults:
product: pgaudit
---

`pgaudit` is an extension released as open source software under the PostgreSQL License.

`pgaudit` is used to produce session and object audit logging. You can create detailed logging for DML and DDL statements.

For more information about `pgaudit`, see:

- [Installing pgaudit](installing.mdx)
- [Configuring pgaudit](configuring.mdx)
- [Using pgaudit](using.mdx)


70 changes: 70 additions & 0 deletions advocacy_docs/pg_extensions/pgaudit/installing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: Installing pgaudit
navTitle: Installing
---

`pg_audit` is supported on the same platforms as the Postgres distribution you're using. Support for `pg_audit` starts with Postgres 12. For details, see:

- [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 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>-pg-audit1

# For Debian and Ubuntu
sudo <package-manager> -y install edb-<postgres><postgres_version>-pg-audit-1
```

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 Extended Server | postgresextended |

- `<postgres_version>` is the version of Postgres you're using.

For example, to install pg_audit for EDB Postgres 15 on a RHEL 8 platform:

```shell
sudo dnf -y install edb-pg15-pg-audit1
```
!!!Note
For Postgres 16, the pgaudit extension major version is 16.
For Postgres 15 and under, the pgaudit extension major version is 1.
!!!




10 changes: 10 additions & 0 deletions advocacy_docs/pg_extensions/pgaudit/rel_notes/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 'pgaudit release notes'
navTitle: "Release notes"
indexCards: none
---
The pgaudit documentation describes the latest version of pgaudit, including minor releases and patches. These release notes cover what was new in each release. For new functionality introduced in a minor or patch release, there are also indicators in the content about the release that introduced the feature.

| Version | Release Date |
| ----------------------------------- | ------------ |
| [17](pgaudit_17_rel_notes) | 26 May 2024 |
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Release notes for pgaudit
navTitle: "Version 17.0"
---

For `pgaudit` release notes, see the [pgaudit official release notes](https://github.com/pgaudit/pgaudit/releases/).
6 changes: 6 additions & 0 deletions advocacy_docs/pg_extensions/pgaudit/using.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Using pgaudit
navTitle: Using
---

For information on using `pgaudit`, see the official [pgaudit documentation](https://github.com/pgaudit/pgaudit).
Loading