PostgreSQL 模块

编辑

postgresql 模块收集并解析由 PostgreSQL 生成的日志。

运行该模块时,它会在后台执行一些任务

  • 设置日志文件的默认路径(但不用担心,您可以覆盖默认值)
  • 确保每个多行日志事件都作为单个事件发送
  • 使用 Elasticsearch 摄取管道来解析和处理日志行,将数据塑造成适合在 Kibana 中可视化的结构
  • 部署用于可视化日志数据的仪表板

阅读 快速入门,了解如何配置和运行模块。

兼容性

编辑

此模块有两种类型:基于 Linux 发行版默认值的日志文件解析器,以及 CSV 日志解析器,您需要在数据库配置中启用它。

postgresql 模块使用 .log 已在 Ubuntu 上的 9.5 版、Debian 上的 9.6 版以及 Arch Linux 9.3 上的 10.11、11.4 和 12.2 版的日志中进行了测试。

postgresql 模块使用 .csv 已使用 11 版和 13 版进行了测试(此处发行版无关紧要)。

支持的日志格式

编辑

此模块可以收集来自 PostgreSQL 服务器的任何日志,但为了能够更好地分析其内容并提取更多信息,它们应以特定的方式格式化。

日志格式需要考虑一些设置。

日志行应以毫秒级时间戳、进程 ID、用户 ID 和数据库名称为前缀。这在大多数发行版中通常是默认设置,并在配置文件中转换为此设置

log_line_prefix = '%m [%p] %q%u@%d '

PostgreSQL 服务器可以配置为记录语句及其持续时间,并且此模块能够收集此信息。为了能够将每个持续时间与其语句相关联,必须在同一行中记录它们。当使用以下选项时,就会发生这种情况

log_duration = 'on'
log_statement = 'none'
log_min_duration_statement = 0

log_min_duration_statement 中设置零值将记录客户端执行的所有语句。您可能希望将其配置为更高的值,以便它仅记录较慢的语句。此值以毫秒为单位配置。

当同时使用 log_statementlog_duration 时,语句和持续时间会记录在不同的行中,Filebeat 无法关联这两个值,因此建议禁用 log_statement

Metricbeat 的 PostgreSQL 模块也能够收集有关服务器中执行的所有语句的信息。您可以选择最适合您需求的模块。一个重要的区别是 Metricbeat 模块在语句执行多次时收集聚合信息,但无法知道每个语句何时执行。此信息可以从日志中获取。

您可能考虑启用的其他日志记录选项如下

log_checkpoints = 'on';
log_connections = 'on';
log_disconnections = 'on';
log_lock_waits = 'on';

如果您没有持久连接,则 log_connectionslog_disconnections 都会导致大量事件,因此请谨慎启用。

使用 CSV 日志

编辑

由于 PostgreSQL CSV 日志文件格式明确定义,因此在 Filebeat 中几乎无需进行任何配置,只需指定文件路径即可。

另一方面,需要配置 postgresql 以发出 .csv 日志。推荐的参数为

logging_collector = 'on';
log_destination = 'csvlog';

配置模块

编辑

您可以通过在 modules.d/postgresql.yml 文件中指定 变量设置 或覆盖命令行中的设置来进一步优化 postgresql 模块的行为。

您必须在模块中启用至少一个文件集。文件集默认情况下处于禁用状态。

以下示例显示了如何在 modules.d/postgresql.yml 文件中设置路径以覆盖 PostgreSQL 日志的默认路径

- module: postgresql
  log:
    enabled: true
    var.paths: ["/path/to/log/postgres/*.log*"]

要在命令行中指定相同的设置,请使用

-M "postgresql.log.var.paths=[/path/to/log/postgres/*.log*]"

变量设置

编辑

每个文件集都有单独的变量设置来配置模块的行为。如果您未指定变量设置,则 postgresql 模块将使用默认值。

对于高级用例,您还可以覆盖输入设置。请参阅 覆盖输入设置

在命令行中指定设置时,请记住以模块名称为前缀,例如,使用 postgresql.log.var.paths 而不是 log.var.paths

log 文件集设置

编辑
var.paths
指定在何处查找日志文件的基于通配符的路径数组。此处还支持 Go Glob 支持的所有模式。例如,您可以使用通配符从预定义级别的子目录中获取所有文件:/path/to/log/*/*.log。这将获取 /path/to/log 的子文件夹中的所有 .log 文件。它不会获取 /path/to/log 文件夹本身的日志文件。如果此设置为空,则 Filebeat 将根据您的操作系统选择日志路径。

示例仪表板

编辑

此模块附带两个示例仪表板。

第一个仪表板用于常规日志。

filebeat postgresql overview

第二个仪表板显示 PostgreSQL 的慢查询日志。如果未使用 log_min_duration_statement,则此仪表板将显示不完整或无数据。

filebeat postgresql slowlog overview

字段

编辑

有关模块中每个字段的描述,请参阅 导出字段 部分。