Plugin PostgreSQL

Visão geral

Os parâmetros de configuração permitem personalizar o comportamento do plugin PostgreSQL.

Recomenda-se especificá-los em seu próprio arquivo de configuração (por exemplo, postgresql.conf), em vez de no arquivo de configuração do agent 2. Em seguida, use a diretiva Include para incluir esse arquivo na configuração do Zabbix agent 2.

O plugin PostgreSQL é um plugin carregável e está disponível e totalmente descrito no repositório do plugin PostgreSQL.

Todos os parâmetros são opcionais, a menos que seja explicitamente indicado que o parâmetro é obrigatório.

Esta página está estruturada da seguinte forma:

  • Visão geral dos parâmetros (para ver os detalhes completos de um parâmetro, clique no nome dele)
  • Detalhes dos parâmetros
Parameter Description
Plugins.PostgreSQL.CallTimeout Define o tempo máximo de espera, em segundos, para a conclusão de uma solicitação.
Plugins.PostgreSQL.CustomQueriesPath Especifica o caminho completo do diretório que contém arquivos .sql com consultas personalizadas.
Plugins.PostgreSQL.CustomQueriesEnabled Habilita a execução da chave de item postgresql.custom.query.
Plugins.PostgreSQL.Default.CacheMode Especifica o modo de cache padrão para a conexão PostgreSQL.
Plugins.PostgreSQL.Default.Database Especifica o nome padrão do banco de dados.
Plugins.PostgreSQL.Default.Password Especifica a senha padrão.
Plugins.PostgreSQL.Default.TLSCAFile Especifica o caminho completo do arquivo que contém o certificado da(s) CA(s) de nível superior para verificação do certificado do par.
Plugins.PostgreSQL.Default.TLSCertFile Especifica o caminho completo do arquivo que contém o certificado PostgreSQL ou a cadeia de certificados.
Plugins.PostgreSQL.Default.TLSConnect Especifica o nível padrão de criptografia para as comunicações entre o Zabbix agent 2 e os bancos de dados monitorados.
Plugins.PostgreSQL.Default.TLSKeyFile Especifica o caminho completo do arquivo que contém a chave privada PostgreSQL.
Plugins.PostgreSQL.Default.Uri Especifica a URI padrão.
Plugins.PostgreSQL.Default.User Especifica o nome de usuário padrão.
Plugins.PostgreSQL.KeepAlive Define o tempo máximo de espera (em segundos) antes que conexões não utilizadas do plugin sejam encerradas.
Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode Especifica o modo de cache da sessão nomeada para a conexão PostgreSQL.
Plugins.PostgreSQL.Sessions.<SessionName>.Database Especifica o nome do banco de dados da sessão nomeada.
Plugins.PostgreSQL.Sessions.<SessionName>.Password Especifica a senha da sessão nomeada.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSCAFile Especifica o caminho completo do arquivo que contém o certificado da(s) CA(s) de nível superior para verificação do certificado do par.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile Especifica o caminho completo do arquivo que contém o certificado PostgreSQL ou a cadeia de certificados.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect Especifica o nível de criptografia da sessão nomeada para as comunicações entre o Zabbix agent 2 e os bancos de dados monitorados.
Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile Especifica o caminho completo do arquivo que contém a chave privada PostgreSQL.
Plugins.PostgreSQL.Sessions.<SessionName>.Uri Especifica a URI da sessão nomeada.
Plugins.PostgreSQL.Sessions.<SessionName>.User Especifica o nome de usuário da sessão nomeada.

|Plugins.PostgreSQL.System.Path|Especifica o caminho para o executável do plugin PostgreSQL.| |Plugins.PostgreSQL.Timeout|Define o tempo limite de execução da solicitação.|

Observe que:

  • Os valores padrão refletem os padrões do processo, não os valores nos arquivos de configuração fornecidos.
  • Os valores suportam variáveis de ambiente;
  • O Zabbix suporta arquivos de configuração apenas em codificação UTF-8 sem BOM.
  • Comentários que começam com "#" são suportados apenas no início da linha.

Detalhes do parâmetro

Plugins.PostgreSQL.CallTimeout

Define o tempo máximo de espera, em segundos, para que uma solicitação seja concluída.

Padrão: global timeout
Intervalo: 1-30

Plugins.PostgreSQL.CustomQueriesPath

Especifique o caminho completo do diretório que contém arquivos .sql com consultas personalizadas.

Padrões:
/usr/local/share/zabbix/custom-queries/postgreSQL - para sistemas Unix,
*:\Program Files\Zabbix Agent 2\Custom Queries\PostgreSQL - para sistemas Windows (onde * é o nome da unidade da variável de ambiente ProgramFiles)

Exemplo:

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

Ativa a execução da chave de item postgresql.custom.query.
Se desativado, nenhuma consulta será carregada do caminho do diretório de consultas personalizadas.

Padrão: false
Intervalo: true/false

Plugins.PostgreSQL.Default.CacheMode

Especifique o modo de cache padrão para a conexão PostgreSQL.

Padrão: prepare
Intervalo:
prepare - cria prepared statements no server PostgreSQL;
describe - usa o anonymous prepared statement para descrever uma statement sem criar uma statement no server.

Observe que describe é útil principalmente quando o ambiente não permite prepared statements, como ao usar um connection pooler como o PgBouncer.

Plugins.PostgreSQL.Default.Database

Especifique o banco de dados padrão para conexão com o PostgreSQL.
Usado se nenhum valor for especificado em uma chave de item ou sessão nomeada.

Plugins.PostgreSQL.Default.Password

Especifique a senha padrão para conexão com o PostgreSQL.
Usado se nenhum valor for especificado em uma chave de item ou sessão nomeada.

Plugins.PostgreSQL.Default.TLSCAFile

Especifique o caminho completo do arquivo que contém o(s) certificado(s) da CA de nível superior para a verificação do certificado do par nas comunicações criptografadas entre o Zabbix agent 2 e os bancos de dados monitorados.
Usado se nenhum valor for especificado em uma sessão nomeada.

Obrigatório: yes, se Plugins.PostgreSQL.Default.TLSConnect estiver definido como verify_ca ou verify_full

Plugins.PostgreSQL.Default.TLSCertFile

Especifique o caminho completo do arquivo que contém o certificado PostgreSQL ou a cadeia de certificados para comunicações criptografadas entre o Zabbix agent 2 e os bancos de dados monitorados.
Usado se nenhum valor for especificado em uma sessão nomeada.

Obrigatório: yes, se Plugins.PostgreSQL.Default.TLSKeyFile estiver especificado

Plugins.PostgreSQL.Default.TLSConnect

Especifique o nível padrão de criptografia para as comunicações entre o Zabbix agent 2 e os bancos de dados monitorados.
Usado se nenhum valor for especificado em uma sessão nomeada.

Intervalo:
required - conectar usando TLS como modo de transporte sem verificações de identidade;
verify_ca - conectar usando TLS e verificar o certificado;
verify_full - conectar usando TLS, verificar o certificado e verificar se a identidade do banco de dados (CN) especificada por DBHost corresponde ao certificado.

Tipo de criptografia indefinido significa conexão sem criptografia.

Plugins.PostgreSQL.Default.TLSKeyFile

Especifique o caminho completo do arquivo que contém a chave privada do PostgreSQL para comunicações criptografadas entre o agent 2 do Zabbix e os bancos de dados monitorados.
Usado se nenhum valor for especificado em uma sessão nomeada.

Obrigatório: yes, se Plugins.PostgreSQL.Default.TLSCertFile estiver especificado

Plugins.PostgreSQL.Default.Uri

Especifique a URI padrão para conexão com o PostgreSQL.
Usada se nenhum valor for especificado em uma chave de item ou sessão nomeada.
Credenciais incorporadas serão ignoradas.
Deve corresponder ao formato de URI.
Esquemas suportados: tcp, unix

Exemplos:

tcp://127.0.0.1:5432
tcp://localhost
unix:/var/run/postgresql/.s.PGSQL.5432
Plugins.PostgreSQL.Default.User

Especifique o nome de usuário padrão para conectar ao PostgreSQL.
Usado se nenhum valor for especificado em uma chave de item ou sessão nomeada.

Plugins.PostgreSQL.KeepAlive

Defina o tempo máximo de espera (em segundos) antes que conexões de plugin não utilizadas sejam fechadas.

Plugins.PostgreSQL.Sessions.<SessionName>.CacheMode

Especifique o modo de cache da sessão nomeada para a conexão PostgreSQL.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.

Padrão: prepare
Intervalo:
prepare - cria prepared statements no server PostgreSQL;
describe - usa o prepared statement anônimo para descrever uma instrução sem criar uma instrução no server.

Observe que describe é útil principalmente quando o ambiente não permite prepared statements, como ao executar um pooler de conexão como o PgBouncer.

Plugins.PostgreSQL.Sessions.<SessionName>.Database

Especifique o banco de dados da sessão nomeada para conexão com o PostgreSQL.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.

Plugins.PostgreSQL.Sessions.<SessionName>.Password

Especifique a senha da sessão nomeada para conexão com o PostgreSQL.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.
Deve corresponder ao formato da senha.

Plugins.PostgreSQL.Sessions.<SessionName>.TLSCAFile

Especifique o caminho completo do arquivo que contém o certificado da CA de nível superior para verificação do certificado do par em comunicações criptografadas entre o agent 2 do Zabbix e os bancos de dados monitorados.
<SessionName> - defina o nome de uma sessão para uso nas chaves de item.

Obrigatório: yes, se Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect estiver definido como verify_ca ou verify_full

Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile

Especifique o caminho completo do arquivo que contém o certificado PostgreSQL ou a cadeia de certificados para comunicações criptografadas entre o Zabbix agent 2 e os bancos de dados monitorados.
<SessionName> - defina o nome de uma sessão para uso nas chaves de item.

Obrigatório: yes, se Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile estiver especificado

Plugins.PostgreSQL.Sessions.<SessionName>.TLSConnect

Especifique o nível nomeado de criptografia da sessão para comunicações entre o agent 2 do Zabbix e os bancos de dados monitorados.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.

Intervalo:
required - conecta usando TLS como modo de transporte sem verificações de identidade;
verify_ca - conecta usando TLS e verifica o certificado;
verify_full - conecta usando TLS, verifica o certificado e verifica se a identidade do banco de dados (CN) especificada por DBHost corresponde ao certificado.

Um tipo de criptografia indefinido significa uma conexão sem criptografia.

Plugins.PostgreSQL.Sessions.<SessionName>.TLSKeyFile

Especifique o caminho completo do arquivo que contém a chave privada do PostgreSQL para comunicações criptografadas entre o agent 2 do Zabbix e os bancos de dados monitorados.
<SessionName> - defina o nome de uma sessão para uso nas chaves de item.

Obrigatório: yes, se Plugins.PostgreSQL.Sessions.<SessionName>.TLSCertFile estiver especificado.

Plugins.PostgreSQL.Sessions.<SessionName>.Uri

Especifique a URI da sessão nomeada para conexão com o PostgreSQL.
<SessionName> - define o nome de uma sessão para uso em item keys.
As credenciais incorporadas serão ignoradas.
Deve corresponder ao formato de URI.
Esquemas suportados: tcp, unix

Exemplos:

tcp://127.0.0.1:5432
tcp://localhost
unix:/var/run/postgresql/.s.PGSQL.5432
Plugins.PostgreSQL.Sessions.<SessionName>.User

Especifique o nome de usuário da sessão nomeada para conexão com o PostgreSQL.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.

Plugins.PostgreSQL.System.Path

Especifique o caminho para o executável do plugin PostgreSQL.

Obrigatório: yes

Exemplo:

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

Defina o tempo limite de execução da solicitação (a duração, em segundos, para aguardar a conclusão de uma solicitação antes de encerrá-la).

Padrão: global timeout
Intervalo: 1-30

Opções

Parameter Description
-V --version Exibe a versão do plugin e as informações de licença.
-h --help Exibe as informações de ajuda (atalho).
-t, --test <item key> Inicia o plugin para teste (a configuração do plugin é ignorada).

Veja também