On this page
12 PostgreSQL 插件
概述
Zabbix agent 2 的配置文件用于配置插件。运行 PostgreSQL 插件时支持以下 Zabbix agent 2 配置参数。
建议将它们指定在各自的配置文件中（例如 postgresql.conf），然后使用 Include 指令将该文件添加到 Zabbix agent 2 配置中。
PostgreSQL 插件是一个可加载插件，可在 PostgreSQL plugin repository 中获取并查看完整说明。
请注意：
选项
| Parameter | Description |
|---|---|
| -V --version | 打印插件版本和许可证信息。 |
| -h --help | 打印帮助信息（简写）。 |
| -t, --test <item key> | 启动插件进行测试（忽略插件配置）。 |
参数
| Parameter | Mandatory | Range | Default | Description |
|---|---|---|---|---|
| Plugins.PostgreSQL.Default.CacheMode | no | prepare | PostgreSQL 连接的缓存模式。 支持的值： prepare（默认）- 会在 PostgreSQL 服务器上创建预处理语句； describe - 将使用匿名预处理语句来描述语句，而不在服务器上创建语句。 请注意，"describe" 主要适用于环境不允许使用预处理语句的情况，例如运行 PgBouncer 之类的连接池时。 |
|
| Plugins.PostgreSQL.CallTimeout | no | 1-30 | global timeout | 请求完成的最大等待时间（秒）。 |
| Plugins.PostgreSQL.CustomQueriesPath | no | /usr/local/share/zabbix/custom-queries/postgreSQL for Unix systems*:\Program Files\Zabbix Agent 2\Custom Queries\PostgreSQL for Windows systems, where * is the drive name from the ProgramFiles environment variable |
包含自定义查询 .sql 文件的目录完整路径。 |
|
| Plugins.PostgreSQL.CustomQueriesEnabled | no | false | 如果设置，则启用 postgresql.custom.query 监控项键的执行。若禁用，则不会从自定义查询目录路径加载任何查询。 |
|
| 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) |
包含用于对等证书验证的顶级 CA 证书的文件完整路径，用于 Zabbix agent 2 与受监控数据库之间的加密通信；如果命名会话中未指定值，则使用该项。 | ||
| Plugins.PostgreSQL.Default.TLSCertFile | no (yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full) |
包含 PostgreSQL 证书或证书链的文件完整路径，用于 Zabbix agent 2 与受监控数据库之间的加密通信；如果命名会话中未指定值，则使用该项。 | ||
| 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) |
包含 PostgreSQL 私钥的文件完整路径，用于 Zabbix agent 2 与受监控数据库之间的加密通信；如果命名会话中未指定值，则使用该项。 | ||
| 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 服务器上创建预处理语句； 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) |
包含顶级 CA 证书用于对等证书验证的文件完整路径。 <SessionName> - 定义用于监控项键中的会话名称。 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile | yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile is specified | 包含 PostgreSQL 证书或证书链的文件完整路径。 <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 私钥的文件完整路径。 <SessionName> - 定义用于监控项键中的会话名称。 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.Uri | no | 命名会话的连接字符串。 <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 | PostgreSQL 插件可执行文件的路径。 示例用法： Plugins.PostgreSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-postgresql |
||
| Plugins.PostgreSQL.Timeout | no | 1-30 | global timeout | 请求执行超时（即在关闭请求之前等待其完成的时长，单位为秒）。 |
另请参见：
- Zabbix agent 2 常规配置参数说明：Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
- 配置 plugins 的说明