Table of Contents
6 Plugin MongoDB
Visão geral
O arquivo de configuração do Zabbix agent 2 é usado para configurar plugins. Estes parâmetros de configuração do Zabbix agent 2 são suportados para operar o plugin MongoDB.
Recomenda-se especificá-los em seu próprio arquivo de configuração (por exemplo, mongo.conf) e, em seguida, usar a diretiva Include para adicionar este arquivo à configuração do Zabbix agent 2.
O plugin MongoDB é um plugin carregável e está disponível e totalmente descrito no repositório do plugin MongoDB.
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 iniciados com "#" são suportados apenas no início da linha.
Opções
| Parâmetro | Descrição |
|---|---|
| -V --version | Imprime a versão do plugin e informações de licença. |
| -h --help | Imprime informações de ajuda (abreviação). |
| -t, --test <item key> | Executa o plugin para teste (configuração do plugin ignorada). |
Parâmetros
Ao conectar-se ao MongoDB, o plugin verifica sua configuração em uma ordem específica, que determina qual valor usar. A ordem, da maior para a menor prioridade, é a seguinte:
- Parâmetros especificados na URI de conexão (por exemplo, parâmetros de consulta definidos após
?emPlugins.MongoDB.Sessions.<session_name>.Uritêm a maior prioridade). - Parâmetros na chave do item do agent Zabbix 2 (por exemplo, mongodb.collection.stats).
- Parâmetros definidos em uma sessão nomeada (por exemplo,
Plugins.MongoDB.Sessions.<SessionName>.User,Plugins.MongoDB.Sessions.<SessionName>.Password). - Valores padrão (por exemplo,
Plugins.MongoDB.Default.User,Plugins.MongoDB.Default.Password).
Por exemplo:
- Se você especificar o banco de dados para autenticação de uma conexão com o servidor MongoDB no parâmetro
*.<SessionName>.Uri(por exemplo,Plugins.MongoDB.Sessions.<session_name>.Uri=mongodb://user:[email protected]:27017/?authSource=admin), então o plugin considerará que o parâmetro*.<SessionName>.AuthSourceestá definido comoadmin, mesmo que o parâmetro*.<SessionName>.AuthSourceesteja definido com um valor diferente. - 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 agent Zabbix 2, o plugin usará o nome de usuário e a senha da chave do item, mesmo quePlugins.MongoDB.Sessions.<SessionName>.UserePlugins.MongoDB.Sessions.<SessionName>.Passwordestejam configurados.
Se o esquema mongodb+srv:// for usado, a URI pode recuperar parâmetros de um registro DNS TXT. Os parâmetros obtidos deste registro TXT substituem todas as outras configurações, incluindo parâmetros da URI, parâmetros da chave do item do agent Zabbix 2 e parâmetros de sessão.
Apenas um registro TXT pode existir para o nome do host usado na string de conexão.
| Parâmetro | Obrigatório | Intervalo | Padrão | Descrição |
|---|---|---|---|---|
| Plugins.MongoDB.System.Path | não | Caminho para o executável do plugin MongoDB. Exemplo de uso: Plugins.MongoDB.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mongodb |
||
| Plugins.MongoDB.Timeout | não | 1-30 | timeout global | Tempo limite de execução da requisição (duração, em segundos, para aguardar a conclusão de uma requisição antes de encerrá-la). |
| Plugins.MongoDB.KeepAlive | não | 60-900 | 300 | Tempo máximo de espera (em segundos) antes que conexões de plugin não utilizadas sejam fechadas. |
| Plugins.MongoDB.Sessions.<SessionName>.Uri | não | tcp://127.0.0.1:27017 |
String de conexão de uma sessão nomeada. <SessionName> - define o nome de uma sessão para uso em chaves de item. Deve corresponder ao formato URI. Esquemas suportados: mongodb:// e mongodb+srv://; o esquema tcp:// está obsoleto e mantido para compatibilidade com configurações existentes.Uma porta pode ser omitida (padrão=27017). Exemplos: mongodb://127.0.0.1:27017, mongodb+srv://example.com, localhost. |
|
| Plugins.MongoDB.Sessions.<SessionName>.User | não | Nome de usuário da sessão nomeada. <SessionName> - define o nome de uma sessão para uso em chaves de item. |
||
| Plugins.MongoDB.Sessions.<SessionName>.Password | não | Senha da sessão nomeada. <SessionName> - define o nome de uma sessão para uso em chaves de item. |
||
| Plugins.MongoDB.Sessions.<SessionName>.Direct | não | false |
Método de conexão usado para determinar se a descoberta automática de nós do conjunto de réplicas do MongoDB deve ser ativada ou desativada. <SessionName> - define o nome de uma sessão para uso em chaves de item. Valores suportados: true - o plugin se conectará apenas ao servidor especificado, ignorando outros membros do conjunto de réplicas;false - o plugin descobrirá automaticamente todos os nós no conjunto de réplicas.Se o esquema tcp:// (obsoleto) for usado, o parâmetro será definido como true por padrão. |
|
| Plugins.MongoDB.Sessions.<SessionName>.AuthMechanism | não | Mecanismo de autenticação para conexão ao servidor MongoDB. <SessionName> - define o nome de uma sessão para uso em chaves de item. Valores suportados: SCRAM-SHA-1, SCRAM-SHA-256 e MONGODB-X509. |
||
| Plugins.MongoDB.Sessions.<SessionName>.AuthSource | não | admin |
Banco de dados para autenticação de conexão ao servidor MongoDB. <SessionName> - define o nome de uma sessão para uso em chaves de item. Se o mecanismo de autenticação MONGODB-X509 for usado, este parâmetro será automaticamente definido como $external; modificá-lo para qualquer outro valor causará um erro ao iniciar. |
|
| Plugins.MongoDB.Sessions.<SessionName>.ReplicaSet | não | Nome do conjunto de réplicas, usado para descoberta automática de nós do conjunto de réplicas do MongoDB. <SessionName> - define o nome de uma sessão para uso em chaves de item. Se este parâmetro for usado com o esquema mongodb+srv://, ele se comportará como se várias URLs tivessem sido fornecidas; um servidor DNS pode ter um registro TXT que pode substituir este (ou qualquer outro) parâmetro.Indisponível se o parâmetro Plugins.MongoDB.Sessions.<SessionName>.Direct estiver definido como true, o agent não iniciará. |
||
| Plugins.MongoDB.Sessions.<SessionName>.ReadPreference | não | Ordem para conexão com nós do conjunto de réplicas do MongoDB ou fallback. <SessionName> - define o nome de uma sessão para uso em chaves de item. Valores suportados: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode e NearestMode.Indisponível se o parâmetro Plugins.MongoDB.Sessions.<SessionName>.Direct estiver definido como true, o agent não iniciará. |
||
| Plugins.MongoDB.Sessions.<SessionName>.TLSConnect | não | Tipo de criptografia para comunicações entre o agent Zabbix 2 e bancos de dados monitorados. <SessionName> - define o nome de uma sessão para uso em chaves de item. Valores suportados: required - requer conexão TLS;verify\_ca - verifica certificados;verify\_full - verifica certificados e endereço IP.Suportado desde a versão 1.2.1 do plugin. |
||
| Plugins.MongoDB.Sessions.<SessionName>.TLSCAFile | sim, se Plugins.MongoDB.Sessions.<SessionName>.TLSConnect estiver definido como um dos valores: verify_ca, verify_full | Caminho completo para um arquivo contendo os certificados da(s) CA(s) de nível superior para verificação do certificado do peer, usado para comunicações criptografadas entre o agent Zabbix 2 e bancos de dados monitorados. <SessionName> - define o nome de uma sessão para uso em chaves de item. |
||
| Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile | sim, se Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile for especificado | Caminho completo para um arquivo contendo o certificado do agent ou cadeia de certificados, usado para comunicações criptografadas entre o agent Zabbix 2 e bancos de dados monitorados. <SessionName> - define o nome de uma sessão para uso em chaves de item. |
||
| Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile | sim, se Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile for especificado | Caminho completo para um arquivo contendo a chave privada do banco de dados usada para comunicações criptografadas entre o agent Zabbix 2 e bancos de dados monitorados. <SessionName> - define o nome de uma sessão para uso em chaves de item. |
||
| Plugins.MongoDB.Default.Uri | não | tcp://127.0.0.1:27017 |
URI padrão para conexão ao MongoDB. Deve corresponder ao formato URI. Esquemas suportados: mongodb:// e mongodb+srv://.Esquema obsoleto: tcp:// (usado como padrão para compatibilidade com configurações existentes).Uma porta pode ser omitida (padrão=27017). Exemplos: mongodb://127.0.0.1:27017, mongodb+srv://example.com, localhost. |
|
| Plugins.MongoDB.Default.User | não | Nome de usuário padrão para conexão ao MongoDB. | ||
| Plugins.MongoDB.Default.Password | não | Senha padrão para conexão ao MongoDB. | ||
| Plugins.MongoDB.Default.Direct | não | false |
Método de conexão padrão usado para determinar se a descoberta automática de nós do conjunto de réplicas do MongoDB deve ser ativada ou desativada. Valores suportados: true - o plugin se conectará apenas ao servidor especificado, ignorando outros membros do conjunto de réplicas;false - o plugin descobrirá automaticamente todos os nós no conjunto de réplicas.Se o esquema tcp:// (obsoleto) for usado, o parâmetro será definido como true por padrão. |
|
| Plugins.MongoDB.Default.AuthMechanism | não | Mecanismo de autenticação padrão para conexão ao servidor MongoDB. Valores suportados: SCRAM-SHA-1, SCRAM-SHA-256 e MONGODB-X509.Se nenhum valor for especificado aqui, em uma chave de item, em uma sessão nomeada ou na URI, um mecanismo baseado em SCRAM será usado (se um nome de usuário for fornecido; caso contrário, nenhuma autenticação será usada). |
||
| Plugins.MongoDB.Default.AuthSource | não | admin |
Banco de dados padrão para autenticação de conexão ao servidor MongoDB. Se o mecanismo de autenticação MONGODB-X509 for usado, este parâmetro será automaticamente definido como $external; modificá-lo para qualquer outro valor causará um erro ao iniciar. |
|
| Plugins.MongoDB.Default.ReplicaSet | não | Nome padrão do conjunto de réplicas; usado para descoberta automática de nós do conjunto de réplicas do MongoDB. Se este parâmetro for usado com o esquema mongodb+srv://, ele se comportará como se várias URLs tivessem sido fornecidas; um servidor DNS pode ter um registro TXT que pode substituir este (ou qualquer outro) parâmetro.Indisponível se o parâmetro Plugins.MongoDB.Default.Direct estiver definido como true, o agent não iniciará. |
||
| Plugins.MongoDB.Default.ReadPreference | não | Ordem padrão para conexão com nós do conjunto de réplicas do MongoDB ou fallback. Valores suportados: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode e NearestMode.Indisponível se o parâmetro Plugins.MongoDB.Default.Direct estiver definido como true, o agent não iniciará. |
||
| Plugins.MongoDB.Default.TLSConnect | não | Tipo de criptografia padrão para comunicações entre o agent Zabbix 2 e bancos de dados monitorados. Valores suportados: required - requer conexão TLS.verify\_ca - verifica certificados.verify\_full - verifica certificados e endereço IP.Se nenhum valor for especificado aqui, em uma chave de item, em uma sessão nomeada ou na URI, uma conexão TLS não será estabelecida. |
||
| Plugins.MongoDB.Default.TLSCAFile | não | Caminho padrão para um arquivo contendo os certificados da(s) CA(s) de nível superior para verificação do certificado do peer. Usado para comunicações criptografadas entre o agent Zabbix 2 e bancos de dados monitorados. | ||
| Plugins.MongoDB.Default.TLSCertFile | não | Caminho padrão para um arquivo contendo o certificado do cliente MongoDB ou cadeia de certificados. Usado para comunicações criptografadas entre o agent Zabbix 2 e bancos de dados monitorados. | ||
| Plugins.MongoDB.Default.TLSKeyFile | não | Caminho padrão para um arquivo contendo a chave privada do cliente MongoDB usada para comunicações criptografadas entre o agent Zabbix 2 e bancos de dados monitorados. |
Veja também:
- Descrição dos parâmetros gerais de configuração do agent Zabbix 2: Zabbix agent 2 (UNIX) / Zabbix agent 2 (Windows)
- Instruções para configuração de plugins