Plugin do MongoDB

Visão geral

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

Recomenda-se especificá-los em seu próprio arquivo de configuração (por exemplo, mongodb.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 MongoDB é um plugin carregável e está disponível, com descrição completa, no repositório do plugin MongoDB.

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

Ao se conectar ao MongoDB, o plugin verifica sua configuração em uma ordem específica, que determina qual valor será usado. A ordem, da maior para a menor prioridade, é a seguinte:

1. Parâmetros especificados na URI de conexão (por exemplo, os parâmetros de consulta definidos após ? em Plugins.MongoDB.Sessions.<session_name>.Uri têm a maior prioridade).
2. Parâmetros na chave do item do Zabbix agent 2 (por exemplo, mongodb.collection.stats).
3. Parâmetros definidos em uma sessão nomeada (por exemplo, Plugins.MongoDB.Sessions.<SessionName>.User, Plugins.MongoDB.Sessions.<SessionName>.Password).
4. Valores padrão (por exemplo, Plugins.MongoDB.Default.User, Plugins.MongoDB.Default.Password).

Por exemplo:

• Se você especificar o banco de dados para autenticar uma conexão com o MongoDB server no parâmetro *.<SessionName>.Uri (por exemplo, Plugins.MongoDB.Sessions.<session_name>.Uri=mongodb://user:[email protected]:27017/?authSource=admin), o plugin considerará que o parâmetro *.<SessionName>.AuthSource está definido como admin, mesmo que o parâmetro *.<SessionName>.AuthSource esteja configurado com outro valor.
• Se você especificar a URI no parâmetro *.<SessionName>.Uri (por exemplo, Plugins.MongoDB.Sessions.<session_name>.Uri=mongodb://127.0.0.1:27017), mas fornecer o nome de usuário e a senha na chave do item do Zabbix agent 2, o plugin usará o nome de usuário e a senha da chave do item, mesmo que Plugins.MongoDB.Sessions.<SessionName>.User e Plugins.MongoDB.Sessions.<SessionName>.Password estejam configurados.

Esta página está estruturada da seguinte forma:

• Visão geral dos parâmetros (para ver os detalhes completos de um parâmetro, clique em seu nome)
• Detalhes dos parâmetros

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.MongoDB.Default.AuthMechanism

Especifique o mecanismo de autenticação padrão para conexão com o server MongoDB.
<SessionName> - define o nome de uma sessão para uso em chaves de item.

Intervalo: SCRAM-SHA-1, SCRAM-SHA-256 ou MONGODB-X509

Plugins.MongoDB.Default.AuthSource

Especifique o banco de dados padrão para autenticar a conexão com o server MongoDB.
<SessionName> - define o nome de uma sessão para uso em chaves de item.

Padrão: admin

Se o mecanismo de autenticação MONGODB-X509 for usado, este parâmetro é definido automaticamente como $external; modificá-lo para qualquer outro valor causará um erro ao iniciar.

Plugins.MongoDB.Default.Direct

Desative a descoberta automática dos nós do replica set do MongoDB.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.

Padrão: false
Intervalo: true - conecta-se apenas ao server especificado, ignorando outros membros do replica set, false - descobre automaticamente todos os nós no replica set.

Se o esquema tcp:// (obsoleto) for usado, o parâmetro é definido como true por padrão.

Plugins.MongoDB.Default.Password

Especifique a senha padrão.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.

Plugins.MongoDB.Default.ReplicaSet

Especifique o nome padrão do replica set, usado para a descoberta automática de nós do replica set do MongoDB.
<SessionName> - define o nome de uma sessão para uso em item keys.
Se este parâmetro for usado com o esquema mongodb+srv://, ele se comportará como se vários URLs tivessem sido fornecidos; um servidor DNS pode ter um registro TXT que pode substituir este parâmetro (ou qualquer outro).
Indisponível se o parâmetro Plugins.MongoDB.Sessions.<SessionName>.Direct estiver definido como true; o agent falhará ao iniciar.

Plugins.MongoDB.Default.ReadPreference

Especifique a ordem padrão para conectar-se aos nós do replica set do MongoDB ou como fallback.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.
Indisponível se o parâmetro Plugins.MongoDB.Sessions.<SessionName>.Direct estiver definido como true; o agent falhará ao iniciar.

Intervalo: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode ou NearestMode

Plugins.MongoDB.Default.TLSConnect

Especifique o nível de criptografia exigido para as comunicações entre o Zabbix agent 2 e os bancos de dados monitorados.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.
Compatível desde a versão 1.2.1 do plugin.

Intervalo: required - exige conexão TLS, verify_ca - verifica certificados, verify_full - verifica certificados e endereço IP

Plugins.MongoDB.Default.TLSCAFile

Especifique o caminho completo do arquivo que contém os certificados da(s) CA(s) de nível superior para verificação do certificado do par, usados 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 em item keys.

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

Plugins.MongoDB.Default.TLSCertFile

Especifique o caminho completo do arquivo que contém o certificado do agent ou a cadeia de certificados, usado 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.MongoDB.Sessions.<SessionName>.TLSKeyFile estiver especificado

Plugins.MongoDB.Default.TLSKeyFile

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

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

Plugins.MongoDB.Default.Uri

Especifique a URI padrão.
<SessionName> - define o nome de uma sessão para uso em item keys.
Deve corresponder ao formato da URI.
Esquemas suportados: mongodb:// e mongodb+srv://; o esquema tcp:// está obsoleto e é mantido por compatibilidade com configurações existentes.
Uma porta pode ser omitida (padrão=27017).
Exemplos: ``

Padrão: tcp://127.0.0.1:27017

Exemplos:

mongodb://127.0.0.1:27017
mongodb+srv://example.com
localhost

Plugins.MongoDB.Default.User

Especifique o nome de usuário padrão.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.

Plugins.MongoDB.KeepAlive

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

Padrão: 300
Intervalo: 60-900

Plugins.MongoDB.Sessions.<SessionName>.AuthMechanism

Especifique o mecanismo de autenticação da sessão nomeada para conectar ao server MongoDB.
<SessionName> - defina o nome de uma sessão para uso nas chaves de item.

Intervalo: SCRAM-SHA-1, SCRAM-SHA-256 ou MONGODB-X509

Plugins.MongoDB.Sessions.<SessionName>.AuthSource

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

Padrão: admin

Se o mecanismo de autenticação MONGODB-X509 for usado, este parâmetro é definido automaticamente como $external; modificá-lo para qualquer outro valor causará um erro ao iniciar.

Plugins.MongoDB.Sessions.<SessionName>.Direct

Desative a descoberta automática de nós do replica set do MongoDB para a sessão nomeada.
<SessionName> - define o nome de uma sessão para uso em item keys.

Padrão: false
Intervalo: true - conecta-se apenas ao server especificado, ignorando outros membros do replica set, false - descobre automaticamente todos os nós no replica set.

Se o esquema tcp:// (obsoleto) for usado, o parâmetro é definido como true por padrão.

Plugins.MongoDB.Sessions.<SessionName>.Password

Especifique a senha da sessão nomeada.
<SessionName> - defina o nome de uma sessão para uso nas chaves de item.

Plugins.MongoDB.Sessions.<SessionName>.ReplicaSet

Especifique o nome do replica set da sessão nomeada, usado para a descoberta automática dos nós do replica set do MongoDB.
<SessionName> - defina o nome de uma sessão para uso nas chaves de item.
Se este parâmetro for usado com o esquema mongodb+srv://, ele se comportará como se vários URLs tivessem sido fornecidos; um servidor DNS pode ter um registro TXT que pode substituir este parâmetro (ou qualquer outro).
Indisponível se o parâmetro Plugins.MongoDB.Sessions.<SessionName>.Direct estiver definido como true; o agent falhará ao iniciar.

Plugins.MongoDB.Sessions.<SessionName>.ReadPreference

Especifique a ordem da sessão nomeada para conectar-se aos nós do replica set do MongoDB ou como fallback.
<SessionName> - define o nome de uma sessão para uso em chaves de item.
Indisponível se o parâmetro Plugins.MongoDB.Sessions.<SessionName>.Direct estiver definido como true; o agent falhará ao iniciar.

Intervalo: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode ou NearestMode

Plugins.MongoDB.Sessions.<SessionName>.TLSConnect

Especifique o nível de criptografia exigido para as comunicações entre o Zabbix agent 2 e os bancos de dados monitorados para a sessão nomeada.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.
Compatível desde a versão 1.2.1 do plugin.

Intervalo: required - exige conexão TLS, verify_ca - verifica certificados, verify_full - verifica certificados e endereço IP

Plugins.MongoDB.Sessions.<SessionName>.TLSCAFile

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

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

Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile

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

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

Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile

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

Obrigatório: yes, se Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile for especificado

Plugins.MongoDB.Sessions.<SessionName>.Uri

Especifique a URI da sessão nomeada.
<SessionName> - define o nome de uma sessão para uso nas chaves de item.
Deve corresponder ao formato da URI.
Esquemas suportados: mongodb:// e mongodb+srv://; o esquema tcp:// está obsoleto e é mantido por compatibilidade com configurações existentes.
A porta pode ser omitida (padrão=27017).
Exemplos: ``

Padrão: tcp://127.0.0.1:27017

Exemplos:

mongodb://127.0.0.1:27017
mongodb+srv://example.com
localhost

Plugins.MongoDB.Sessions.<SessionName>.User

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

Plugins.MongoDB.System.Path

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

Exemplo de uso: Plugins.MongoDB.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mongodb

Plugins.MongoDB.Timeout

Define 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

Veja também

• Descrição dos parâmetros gerais de configuração do Zabbix agent 2: Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
• Instruções para configurar plugins