Table of Contents
11 PostgreSQL plugin
Overview
This section lists parameters supported in the PostgreSQL Zabbix agent 2 plugin configuration file (postgresql.conf).
Since Zabbix 6.0.10, the PostgreSQL plugin is a loadable plugin and is available and fully described in the PostgreSQL plugin repository.
Pre-compiled plugin binaries for Windows are available since Zabbix 6.0.19 and are compatible with previous 6.0 versions.
Note that:
- The default values reflect process defaults, not the values in the shipped configuration files;
- Zabbix supports configuration files only in UTF-8 encoding without BOM;
- Comments starting with "#" are only supported at the beginning of the line.
Options
| Parameter | Description |
|---|---|
| -V --version | Print the plugin version and license information. |
| -h --help | Print help information (shorthand). |
Parameters
In Zabbix versions before 6.0.10, parameter names start with Plugins.Postgres.<Parameter> instead of Plugins.PostgreSQL.<Parameter>. For example, Plugins.Postgres.KeepAlive.
| Parameter | Mandatory | Range | Default | Description |
|---|---|---|---|---|
| Plugins.PostgreSQL.Default.CacheMode | no | prepare | Cache mode for the PostgreSQL connection. Supported values: prepare (default) - will create prepared statements on the PostgreSQL server; describe - will use the anonymous prepared statement to describe a statement without creating a statement on the server. Note that "describe" is primarily useful when the environment does not allow prepared statements such as when running a connection pooler like PgBouncer. Supported since version 6.0.25. |
|
| Plugins.PostgreSQL.CallTimeout | no | 1-30 | global timeout | Maximum wait time (in seconds) for a request to be completed. |
| Plugins.PostgreSQL.CustomQueriesPath | no | disabled | Full pathname of the directory containing .sql files with custom queries. | |
| Plugins.PostgreSQL.Default.Database | no | Default database for connecting to PostgreSQL; used if no value is specified in an item key or named session. Supported since version 6.0.18. |
||
| Plugins.PostgreSQL.Default.Password | no | Default password for connecting to PostgreSQL; used if no value is specified in an item key or named session. Supported since version 6.0.18. |
||
| Plugins.PostgreSQL.Default.TLSCAFile | no (yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full) |
Full pathname of a file containing the top-level CA(s) certificate for peer certificate verification for encrypted communications between Zabbix agent 2 and monitored databases; used if no value is specified in a named session. Supported since version 6.0.18. |
||
| Plugins.PostgreSQL.Default.TLSCertFile | no (yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full) |
Full pathname of a file containing the PostgreSQL certificate or certificate chain for encrypted communications between Zabbix agent 2 and monitored databases; used if no value is specified in a named session. Supported since version 6.0.18. |
||
| Plugins.PostgreSQL.Default.TLSConnect | no | Encryption type for communications between Zabbix agent 2 and monitored databases; used if no value is specified in a named session. Supported values: required - connect using TLS as transport mode without identity checks; verify_ca - connect using TLS and verify certificate; verify_full - connect using TLS, verify certificate and verify that database identity (CN) specified by DBHost matches its certificate. Undefined encryption type means unencrypted connection. Supported since version 6.0.18. |
||
| Plugins.PostgreSQL.Default.TLSKeyFile | no (yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full) |
Full pathname of a file containing the PostgreSQL private key for encrypted communications between Zabbix agent 2 and monitored databases; used if no value is specified in a named session. Supported since version 6.0.18. |
||
| Plugins.PostgreSQL.Default.Uri | no | Default URI for connecting to PostgreSQL; used if no value is specified in an item key or named session. Should not include embedded credentials (they will be ignored). Must match the URI format. Supported schemes: tcp, unix.Examples: tcp://127.0.0.1:5432tcp://localhostunix:/var/run/postgresql/.s.PGSQL.5432Supported since version 6.0.18. |
||
| Plugins.PostgreSQL.Default.User | no | Default username for connecting to PostgreSQL; used if no value is specified in an item key or named session. Supported since version 6.0.18. |
||
| Plugins.PostgreSQL.KeepAlive | no | 60-900 | 300 | Maximum time of waiting (in seconds) before unused plugin connections are closed. |
| Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode | no | prepare | Cache mode for the PostgreSQL connection. <SessionName> - define name of a session for using in item keys. Supported values: prepare (default) - will create prepared statements on the PostgreSQL server; describe - will use the anonymous prepared statement to describe a statement without creating a statement on the server. Note that "describe" is primarily useful when the environment does not allow prepared statements such as when running a connection pooler like PgBouncer. Supported since version 6.0.25. |
|
| Plugins.PostgreSQL.Sessions.<SessionName>.Database | no | Database for session connection. <SessionName> - define name of a session for using in item keys. |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.Password | no | Must match the password format. | Password for session connection. <SessionName> - define name of a session for using in item keys. |
|
| Plugins.PostgreSQL.Sessions.<SessionName>.TLSCAFile | no (yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect is set to verify_ca or verify_full) |
Full pathname of a file containing the top-level CA(s) certificate peer certificate verification. <SessionName> - define name of a session for using in item keys. |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile | yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile is specified Before version 6.0.22 always mandatory if Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect is set to verify_ca or verify_full |
Full pathname of a file containing the PostgreSQL certificate or certificate chain. <SessionName> - define name of a session for using in item keys. |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect | no | Encryption type for PostgreSQL connection. <SessionName> - define name of a session for using in item keys. Supported values: required - connect using TLS as transport mode without identity checks; verify_ca - connect using TLS and verify certificate; verify_full - connect using TLS, verify certificate and verify that database identity (CN) specified by DBHost matches its certificate. Undefined encryption type means unencrypted connection. |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile | yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile is specified Before version 6.0.22 always mandatory if Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect is set to verify_ca or verify_full |
Full pathname of a file containing the PostgreSQL private key. <SessionName> - define name of a session for using in item keys. |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.Uri | no | Connection string of a named session. <SessionName> - define name of a session for using in item keys. Should not include embedded credentials (they will be ignored). Must match the URI format. Supported schemes: tcp, unix.Examples: tcp://127.0.0.1:5432tcp://localhostunix:/var/run/postgresql/.s.PGSQL.5432 |
||
| Plugins.PostgreSQL.Sessions.<SessionName>.User | no | Named session username. <SessionName> - define name of a session for using in item keys. |
||
| Plugins.PostgreSQL.System.Path | yes | Path to external plugin executable. Supported since Zabbix 6.0.10. | ||
| Plugins.PostgreSQL.Timeout | no | 1-30 | global timeout | Request execution timeout (how long to wait for a request to complete before shutting it down). |
See also:
- Description of general Zabbix agent 2 configuration parameters: Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
- Instructions for configuring plugins