pgAudit 开源项目教程

pgAudit 开源项目教程

pgaudit PostgreSQL Audit Extension 项目地址: https://gitcode.com/gh_mirrors/pg/pgaudit

1. 项目介绍

pgAudit 是一个开源的 PostgreSQL 审计扩展，旨在通过标准 PostgreSQL 日志记录设施提供详细的会话和/或对象审计日志。pgAudit 的目标是为 PostgreSQL 用户提供生成审计日志的能力，这些日志通常是满足政府、金融或 ISO 认证要求所必需的。

审计是对个人或组织账户的官方检查，通常由独立机构进行。pgAudit 收集的信息通常称为审计跟踪或审计日志。在本文档中，我们使用术语“审计日志”。

为什么选择 pgAudit？

基本的语句日志可以通过标准日志记录设施（如 log_statement = all）提供。这对于监控和其他用途是可以接受的，但不足以提供审计通常所需的详细级别。审计不仅需要列出所有针对数据库执行的操作，还需要能够找到审计员感兴趣的特定语句。

pgAudit 专注于在数据库满足用户请求时发生的详细信息，而不仅仅是用户请求的内容。例如，审计员可能希望验证某个表是否在记录的维护窗口内创建。pgAudit 不仅记录 DO 块，还记录包含完整 CREATE TABLE 语句的子语句，包括语句类型、对象类型和完全限定名称，以便于搜索。

2. 项目快速启动

2.1 环境准备

确保你已经安装了 PostgreSQL 12 或更高版本，并且安装了开发包。

2.2 克隆项目

首先，克隆 pgAudit 项目到本地：

git clone https://github.com/pgaudit/pgaudit.git

2.3 切换到稳定分支

进入项目目录并切换到 REL_17_STABLE 分支（注意，稳定分支可能不存在于未发布的 PostgreSQL 版本中）：

cd pgaudit
git checkout REL_17_STABLE

2.4 编译和安装

使用 PGXS 编译并安装 pgAudit：

make install USE_PGXS=1 PG_CONFIG=/usr/pgsql-17/bin/pg_config

2.5 配置 PostgreSQL

在 postgresql.conf 中添加以下配置：

shared_preload_libraries = 'pgaudit'

然后重启 PostgreSQL 服务。

2.6 创建扩展

在 PostgreSQL 数据库中创建 pgAudit 扩展：

CREATE EXTENSION pgaudit;

2.7 配置审计日志

在 postgresql.conf 中配置审计日志级别：

pgaudit.log = 'READ, WRITE, FUNCTION, ROLE, DDL, MISC'

3. 应用案例和最佳实践

3.1 合规性审计

pgAudit 广泛用于需要满足政府、金融或 ISO 认证的环境中。通过详细的审计日志，组织可以轻松追踪和验证数据库操作，确保符合相关法规和标准。

3.2 安全监控

在安全敏感的环境中，pgAudit 可以帮助监控和记录所有数据库活动，及时发现和响应潜在的安全威胁。

3.3 性能优化

虽然 pgAudit 可以生成大量日志，但通过合理配置（如仅审计特定表或操作），可以有效减少日志量，避免对数据库性能产生过大影响。

4. 典型生态项目

4.1 PostgreSQL

pgAudit 是 PostgreSQL 的一个扩展，因此与 PostgreSQL 紧密集成。它利用 PostgreSQL 的标准日志记录设施，提供详细的审计日志。

4.2 pgAdmin

pgAdmin 是一个用于管理 PostgreSQL 数据库的图形化工具。通过 pgAdmin，用户可以方便地查看和管理 pgAudit 生成的审计日志。

4.3 Logstash

Logstash 是一个开源的数据收集引擎，可以与 pgAudit 结合使用，将审计日志收集并转发到其他系统（如 Elasticsearch）进行进一步分析和存储。

通过以上步骤，您可以快速启动并使用 pgAudit 进行数据库审计。希望本教程对您有所帮助！

pgaudit PostgreSQL Audit Extension 项目地址: https://gitcode.com/gh_mirrors/pg/pgaudit