This is a translation of the original English documentation page. Help us make it better.

9 PostgreSQL plugin

Overview

This section lists parameters supported in the PostgreSQL Zabbix agent 2 plugin configuration file (postgresql.conf).

This is a loadable plugin, which is available and fully described in the PostgreSQL plugin repository

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

Parameter Mandatory Range Default Description
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.4.3.
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.4.3.
Plugins.PostgreSQL.Default.TLSCAFile no
(yes, if Plugins.PostgreSQL.Default.TLSConnect is set to one of: verify_ca, 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.4.3.
Plugins.PostgreSQL.Default.TLSCertFile no
(yes, if Plugins.PostgreSQL.Default.TLSConnect is set to one of: verify_ca, 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.4.3.
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.4.3.
Plugins.PostgreSQL.Default.TLSKeyFile no
(yes, if Plugins.PostgreSQL.Default.TLSConnect is set to one of: verify_ca, 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.4.3.
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:5432
tcp://localhost
unix:/var/run/postgresql/.s.PGSQL.5432
Supported since version 6.4.3.
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.4.3.
Plugins.PostgreSQL.KeepAlive no 60-900 300 Maximum time of waiting (in seconds) before unused plugin connections are closed.
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 one of: verify_ca, 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 no
(yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect is set to one of: verify_ca, 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 no
(yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect is set to one of: verify_ca, 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:5432
tcp://localhost
unix:/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.
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: