Documentation
Table of Contents
11 PostgreSQL 插件
概述
本节列出了PostgreSQL Zabbix agent 2插件配置file (postgresql.conf)中支持的参数.
PostgreSQL插件是一个可加载插件，其完整描述可在PostgreSQL plugin repository中获取.
请注意:
- 默认值反映的是进程默认值，而非随附配置文件中的值.
- Zabbix仅支持UTF-8编码的配置文件，不支持BOM.
- 以"#"开头的注释仅支持在行首使用.
选项
| 参数 | 描述 |
|---|---|
| -V --version | 打印插件version及许可证信息. |
| -h --help | 打印帮助信息(简写形式). |
参数
| 参数 | 必选 | 范围 | 默认值 | 描述 |
|---|---|---|---|---|
| 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) |
包含Top级CA证书的file完整路径，用于Zabbix agent 2与被监控数据库间加密通信的对等证书验证；当命名会话中未指定值时使用。 | ||
| Plugins.PostgreSQL.Default.TLSCertFile | no (yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full) |
包含PostgreSQL证书或证书链的file完整路径，用于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私钥的file完整路径，用于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服务器上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连接，验证证书并验证数据库身份(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配置指南