Documentation
Table of Contents
11 PostgreSQL 插件
概述
本节列出了 PostgreSQL Zabbix agent 2 插件配置 file（postgresql.conf）中支持的参数。
PostgreSQL 插件是一个可加载插件，在 PostgreSQL plugin repository 中提供并有完整描述。
请注意：
- 默认值反映的是进程默认值，而不是随配置文件一起提供的值；
- Zabbix 仅支持使用 UTF-8 编码且不带 BOM 的配置文件；
- 以“#”开头的注释仅支持出现在行首。
Options
| Parameter | Description |
|---|---|
| -V --version | Print the plugin version and license information. |
| -h --help | Print help information (shorthand). |
| -t, --test <item key> | Launch plugin for testing (plugin config ignored). |
参数
| 参数 | 必填 | 范围 | 默认值 | 说明 |
|---|---|---|---|---|
| Plugins.PostgreSQL.Default.CacheMode | no | prepare | PostgreSQL 连接的缓存模式。 支持的值： prepare（默认） - 将在 PostgreSQL 服务器上使用 create 预处理语句； describe - 将使用匿名预处理语句来描述语句，而不会在服务器上创建语句。 注意："describe" 主要适用于无法使用预处理语句的环境，例如使用 PgBouncer 等连接池时。 |
|
| Plugins.PostgreSQL.CallTimeout | no | 1-30 | global timeout | 请求完成的最大等待时间（以秒为单位）。 |
| Plugins.PostgreSQL.CustomQueriesPath | no | disabled | 包含自定义 queries 的 .sql 文件的目录的完整路径名。 | |
| Plugins.PostgreSQL.Default.Database | no | 连接到 PostgreSQL 时的默认数据库；如果在 监控项 键或命名会话中未指定值，则使用该值。 | ||
| Plugins.PostgreSQL.Default.Password | no | 连接到 PostgreSQL 时的默认密码；如果在 监控项 键或命名会话中未指定值，则使用该值。 | ||
| Plugins.PostgreSQL.Default.TLSCAFile | no (yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full) |
包含用于在 Zabbix agent 2 和被监控数据库之间进行加密通信的 Top 级 CA 证书的 file 的完整路径名；如果在命名会话中未指定值，则使用该值。 | ||
| Plugins.PostgreSQL.Default.TLSCertFile | no (yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full) |
包含用于在 Zabbix agent 2 和被监控数据库之间进行加密通信的 PostgreSQL 证书或证书链的 file 的完整路径名；如果在命名会话中未指定值，则使用该值。 | ||
| Plugins.PostgreSQL.Default.TLSConnect | no | 在 Zabbix agent 2 和被监控数据库之间通信时使用的加密类型；如果在命名会话中未指定值，则使用该值。 支持的值： required - 使用 TLS 作为传输模式，不进行身份验证； verify_ca - 使用 TLS 并验证证书； verify_full - 使用 TLS，验证证书，并验证 DBHost 指定的数据库身份（CN）与其证书是否匹配。 未定义加密类型表示使用非加密连接。 |
||
| Plugins.PostgreSQL.Default.TLSKeyFile | no (yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full) |
包含用于在 Zabbix agent 2 和被监控数据库之间进行加密通信的 PostgreSQL 私钥的 file 的完整路径名；如果在命名会话中未指定值，则使用该值。 | ||
| Plugins.PostgreSQL.Default.Uri | no | 连接到 PostgreSQL 的默认 URI；如果在 监控项 键或命名会话中未指定值，则使用该值。 不应包含嵌入式凭据（将被忽略）。 必须符合 URI 格式。 支持的方案： tcp、unix。示例： tcp://127.0.0.1:5432tcp://localhostunix:/var/run/postgresql/.s.PGSQL.5432 |
||
| Plugins.PostgreSQL.Default.User | no | 连接到 PostgreSQL 的默认用户名；如果在 监控项 键或命名会话中未指定值，则使用该值。 | ||
| Plugins.PostgreSQL.KeepAlive | no | 60-900 | 300 | 在未使用的插件连接关闭之前的最大等待时间（以秒为单位）。 |
| Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode | no | prepare | PostgreSQL 连接的缓存模式。 <SessionName> - 定义用于 监控项 键的会话名称。 支持的值： prepare（默认） - 将在 PostgreSQL 服务器上使用 create 预处理语句； describe - 将使用匿名预处理语句来描述语句，而不会在服务器上创建语句。 注意："describe" 主要适用于无法使用预处理语句的环境，例如使用 PgBouncer 等连接池时。 |
|
| Plugins.PostgreSQL.Sessions.<SessionName>.Database | no | 会话连接的数据库。 <SessionName> - 定义用于 监控项 键的会话名称。 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.Password | no | Must match the password format. | 会话连接的密码。 <SessionName> - 定义用于 监控项 键的会话名称。 |
|
| Plugins.PostgreSQL.Sessions.<SessionName>.TLSCAFile | no (yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect is set to verify_ca or verify_full) |
包含用于对等证书验证的 Top-级 CA 证书的 file 的完整路径名。 <SessionName> - 定义用于 监控项 键的会话名称。 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile | yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile is specified | 包含 PostgreSQL 证书或证书链的 file 的完整路径名。 <SessionName> - 定义用于 监控项 键的会话名称。 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect | no | PostgreSQL 连接的加密类型。 <SessionName> - 定义用于 监控项 键的会话名称。 支持的值： required - 使用 TLS 作为传输模式，不进行身份验证； verify_ca - 使用 TLS 并验证证书； verify_full - 使用 TLS，验证证书，并验证 DBHost 指定的数据库身份（CN）与其证书是否匹配。 未定义加密类型表示使用非加密连接。 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile | yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile is specified | 包含 PostgreSQL 私钥的 file 的完整路径名。 <SessionName> - 定义用于 监控项 键的会话名称。 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.Uri | no | 命名会话的连接 string。 <SessionName> - 定义用于 监控项 键的会话名称。 不应包含嵌入式凭据（将被忽略）。 必须符合 URI 格式。 支持的方案： tcp、unix。示例： tcp://127.0.0.1:5432tcp://localhostunix:/var/run/postgresql/.s.PGSQL.5432 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.User | no | 命名会话的用户名。 <SessionName> - 定义用于 监控项 键的会话名称。 |
||
| Plugins.PostgreSQL.System.Path | yes | 外部插件可执行文件的路径。 | ||
| Plugins.PostgreSQL.Timeout | no | 1-30 | global timeout | 请求执行超时时间（在关闭请求之前等待请求完成的持续时间，以秒为单位）。 |
另请参阅：
- 通用 Zabbix agent 2 配置参数说明： Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
- 配置 plugins 的说明