Complemento de PostgreSQL

Resumen

Los parámetros de configuración permiten personalizar el comportamiento del plugin de PostgreSQL.

Se recomienda especificarlos en su propio archivo de configuración (por ejemplo, postgresql.conf), en lugar de hacerlo en el archivo de configuración de agent 2. Luego, use la directiva Include para incluir este archivo en la configuración de Zabbix agent 2.

El plugin de PostgreSQL es un plugin cargable y está disponible y descrito completamente en el repositorio del plugin de PostgreSQL.

Todos los parámetros son opcionales, a menos que se indique explícitamente que el parámetro es obligatorio.

Tenga en cuenta que:

  • Los valores predeterminados reflejan los valores predeterminados del proceso, no los valores de los archivos de configuración suministrados.
  • Los valores admiten variables de entorno;
  • Zabbix solo admite archivos de configuración en codificación UTF-8 sin BOM.
  • Los comentarios que comienzan con "#" solo se admiten al principio de la línea.

Parameter details

Plugins.PostgreSQL.CallTimeout

Set the maximum wait time in seconds for a request to be completed.

Default: global timeout
Range: 1-30

Plugins.PostgreSQL.CustomQueriesPath

Specify full pathname of the directory containing .sql files with custom queries.

Defaults:
/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)

Example:

/etc/zabbix/oracle/sql
Plugins.PostgreSQL.CustomQueriesEnabled

Enable execution of the postgresql.custom.query item key.
If disabled, no queries will be loaded from the custom query directory path.

Default: false
Range: true/false

Plugins.PostgreSQL.Default.CacheMode

Specify the default cache mode for the PostgreSQL connection.

Default: prepare
Range:
prepare - create prepared statements on the PostgreSQL server;
describe - 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.

Plugins.PostgreSQL.Default.Database

Specify the default database for connecting to PostgreSQL.
Used if no value is specified in an item key or named session.

Plugins.PostgreSQL.Default.Password

Specify the default password for connecting to PostgreSQL.
Used if no value is specified in an item key or named session.

Plugins.PostgreSQL.Default.TLSCAFile

Specify full pathname of the 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.

Mandatory: yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full

Plugins.PostgreSQL.Default.TLSCertFile

Specify full pathname of the 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.

Mandatory: yes, if Plugins.PostgreSQL.Default.TLSKeyFile is specified

Plugins.PostgreSQL.Default.TLSConnect

Specify the default level of encryption for communications between Zabbix agent 2 and monitored databases.
Used if no value is specified in a named session.

Range:
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.Default.TLSKeyFile

Specify full pathname of the 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.

Mandatory: yes, if Plugins.PostgreSQL.Default.TLSCertFile is specified

Plugins.PostgreSQL.Default.Uri

Specify the default URI for connecting to PostgreSQL.
Used if no value is specified in an item key or named session.
Embedded credentials 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.Default.User

Specify the default username for connecting to PostgreSQL.
Used if no value is specified in an item key or named session.

Plugins.PostgreSQL.KeepAlive

Set the maximum time of waiting (in seconds) before unused plugin connections are closed.

Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode

Specify the named session cache mode for the PostgreSQL connection.
<SessionName> - define name of a session for using in item keys.

Default: prepare
Range:
prepare - create prepared statements on the PostgreSQL server;
describe - 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.

Plugins.PostgreSQL.Sessions.<SessionName>.Database

Specify the named session database for connecting to PostgreSQL.
<SessionName> - define name of a session for using in item keys.

Plugins.PostgreSQL.Sessions.<SessionName>.Password

Specify the named session password for connecting to PostgreSQL.
<SessionName> - define name of a session for using in item keys.
Must match the password format.

Plugins.PostgreSQL.Sessions.<SessionName>.TLSCAFile

Specify full pathname of the file containing the top-level CA(s) certificate for peer certificate verification for encrypted communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.

Mandatory: yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect is set to verify_ca or verify_full

Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile

Specify full pathname of the file containing the PostgreSQL certificate or certificate chain for encrypted communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.

Mandatory: yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile is specified

Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect

Specify the named session level of encryption for communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.

Range:
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

Specify full pathname of the file containing the PostgreSQL private key for encrypted communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.

Mandatory: yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile is specified.

Plugins.PostgreSQL.Sessions.<SessionName>.Uri

Specify the named session URI for connecting to PostgreSQL.
<SessionName> - define name of a session for using in item keys.
Embedded credentials 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

Specify the named session username for connecting to PostgreSQL.
<SessionName> - define name of a session for using in item keys.

Plugins.PostgreSQL.System.Path

Specify path to the PostgreSQL plugin executable.

Mandatory: yes

Example:

Plugins.PostgreSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-postgresql
Plugins.PostgreSQL.Timeout

Set the request execution timeout (the duration, in seconds, to wait for a request to complete before shutting it down).

Default: global timeout
Range: 1-30

Opciones

Parameter Description
-V --version Muestra la versión del plugin y la información de la licencia.
-h --help Muestra la información de ayuda (atajo).
-t, --test <item key> Inicia el plugin para pruebas (se ignora la configuración del plugin).

Parámetros

Parameter Mandatory Range Default Description
Plugins.PostgreSQL.Default.CacheMode no prepare Modo de caché para la conexión PostgreSQL.
Valores admitidos:
prepare (predeterminado) - creará sentencias preparadas en el server PostgreSQL;
describe - usará la sentencia preparada anónima para describir una sentencia sin crear una sentencia en el server.
Tenga en cuenta que "describe" es principalmente útil cuando el entorno no permite sentencias preparadas, como al usar un pooler de conexiones como PgBouncer.
Plugins.PostgreSQL.CallTimeout no 1-30 global timeout Tiempo máximo de espera (en segundos) para que una solicitud se complete.
Plugins.PostgreSQL.CustomQueriesPath no /usr/local/share/zabbix/custom-queries/postgreSQL para sistemas Unix

*:\Program Files\Zabbix Agent 2\Custom Queries\PostgreSQL para sistemas Windows, donde * es el nombre de la unidad de la variable de entorno ProgramFiles
Ruta completa de un directorio que contiene archivos .sql con consultas personalizadas.
Plugins.PostgreSQL.CustomQueriesEnabled no false Si se establece, habilita la ejecución de la clave de item postgresql.custom.query. Si está deshabilitado, no se cargarán consultas desde la ruta del directorio de consultas personalizadas.
Plugins.PostgreSQL.Default.Database no Base de datos predeterminada para conectarse a PostgreSQL; se usa si no se especifica ningún valor en una clave de item o sesión con nombre.
Plugins.PostgreSQL.Default.Password no Contraseña predeterminada para conectarse a PostgreSQL; se usa si no se especifica ningún valor en una clave de item o sesión con nombre.
Plugins.PostgreSQL.Default.TLSCAFile no
(yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full)
Ruta completa de un archivo que contiene el certificado de la(s) CA de nivel superior para la verificación del certificado del par en comunicaciones cifradas entre Zabbix agent 2 y las bases de datos monitorizadas; se usa si no se especifica ningún valor en una sesión con nombre.
Plugins.PostgreSQL.Default.TLSCertFile no
(yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full)
Ruta completa de un archivo que contiene el certificado de PostgreSQL o la cadena de certificados para comunicaciones cifradas entre Zabbix agent 2 y las bases de datos monitorizadas; se usa si no se especifica ningún valor en una sesión con nombre.
Plugins.PostgreSQL.Default.TLSConnect no Tipo de cifrado para las comunicaciones entre Zabbix agent 2 y las bases de datos monitorizadas; se usa si no se especifica ningún valor en una sesión con nombre.
Valores admitidos:
required - conectar usando TLS como modo de transporte sin comprobaciones de identidad;
verify_ca - conectar usando TLS y verificar el certificado;
verify_full - conectar usando TLS, verificar el certificado y verificar que la identidad de la base de datos (CN) especificada por DBHost coincida con su certificado.
Un tipo de cifrado no definido significa conexión sin cifrar.
Plugins.PostgreSQL.Default.TLSKeyFile no
(yes, if Plugins.PostgreSQL.Default.TLSConnect is set to verify_ca or verify_full)
Ruta completa de un archivo que contiene la clave privada de PostgreSQL para comunicaciones cifradas entre Zabbix agent 2 y las bases de datos monitorizadas; se usa si no se especifica ningún valor en una sesión con nombre.
Plugins.PostgreSQL.Default.Uri no URI predeterminada para conectarse a PostgreSQL; se usa si no se especifica ningún valor en una clave de item o sesión con nombre.

No debe incluir credenciales incrustadas (se ignorarán).
Debe coincidir con el formato URI.
Esquemas admitidos: tcp, unix.
Ejemplos: tcp://127.0.0.1:5432
tcp://localhost
unix:/var/run/postgresql/.s.PGSQL.5432
Plugins.PostgreSQL.Default.User no Nombre de usuario predeterminado para conectarse a PostgreSQL; se usa si no se especifica ningún valor en una clave de item o sesión con nombre.
Plugins.PostgreSQL.KeepAlive no 60-900 300 Tiempo máximo de espera (en segundos) antes de cerrar las conexiones del plugin no utilizadas.
Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode no prepare Modo de caché para la conexión PostgreSQL.
<SessionName> - define el nombre de una sesión para usar en las claves de item.
Valores admitidos:
prepare (predeterminado) - creará sentencias preparadas en el server PostgreSQL;
describe - usará la sentencia preparada anónima para describir una sentencia sin crear una sentencia en el server.
Tenga en cuenta que "describe" es principalmente útil cuando el entorno no permite sentencias preparadas, como al usar un pooler de conexiones como PgBouncer.
Plugins.PostgreSQL.Sessions.<SessionName>.Database no Base de datos para la conexión de la sesión.
<SessionName> - define el nombre de una sesión para usar en las claves de item.
Plugins.PostgreSQL.Sessions.<SessionName>.Password no Must match the password format. Contraseña para la conexión de la sesión.
<SessionName> - define el nombre de una sesión para usar en las claves de item.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSCAFile no
(yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect is set to verify_ca or verify_full)
Ruta completa de un archivo que contiene el certificado de la(s) CA de nivel superior para la verificación del certificado del par.
<SessionName> - define el nombre de una sesión para usar en las claves de item.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile is specified Ruta completa de un archivo que contiene el certificado de PostgreSQL o la cadena de certificados.
<SessionName> - define el nombre de una sesión para usar en las claves de item.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect no Tipo de cifrado para la conexión PostgreSQL.
<SessionName> - define el nombre de una sesión para usar en las claves de item.

Valores admitidos:
required - conectar usando TLS como modo de transporte sin comprobaciones de identidad;
verify_ca - conectar usando TLS y verificar el certificado;
verify_full - conectar usando TLS, verificar el certificado y verificar que la identidad de la base de datos (CN) especificada por DBHost coincida con su certificado.
Un tipo de cifrado no definido significa conexión sin cifrar.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile yes, if Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile is specified Ruta completa de un archivo que contiene la clave privada de PostgreSQL.
<SessionName> - define el nombre de una sesión para usar en las claves de item.
Plugins.PostgreSQL.Sessions.<SessionName>.Uri no Cadena de conexión de una sesión con nombre.
<SessionName> - define el nombre de una sesión para usar en las claves de item.

No debe incluir credenciales incrustadas (se ignorarán).
Debe coincidir con el formato URI.
Esquemas admitidos: tcp, unix.
Ejemplos: tcp://127.0.0.1:5432
tcp://localhost
unix:/var/run/postgresql/.s.PGSQL.5432
Plugins.PostgreSQL.Sessions.<SessionName>.User no Nombre de usuario de la sesión con nombre.
<SessionName> - define el nombre de una sesión para usar en las claves de item.
Plugins.PostgreSQL.System.Path yes Ruta al ejecutable del plugin PostgreSQL.
Ejemplo de uso: Plugins.PostgreSQL.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-postgresql
Plugins.PostgreSQL.Timeout no 1-30 global timeout Tiempo de espera de ejecución de la solicitud (la duración, en segundos, que se espera a que una solicitud se complete antes de detenerla).

Véase también: