Plugin do MongoDB

Visão geral

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

É recomendável 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.

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 somente em codificação UTF-8, sem BOM.
  • Comentários que começam com "#" são suportados apenas no início da linha.

Parameter details

Plugins.MongoDB.Default.AuthMechanism

Specify the default authentication mechanism for connecting to MongoDB server.
<SessionName> - define name of a session for using in item keys.

Range: SCRAM-SHA-1, SCRAM-SHA-256, or MONGODB-X509

Plugins.MongoDB.Default.AuthSource

Specify the default database for authenticating connection to MongoDB server.
<SessionName> - define name of a session for using in item keys.

Default: admin

If MONGODB-X509 authentication mechanism is used, this parameter is automatically set to $external; modifying it to any other value will cause an error when launching.

Plugins.MongoDB.Default.Direct

Disable automatic discovery of MongoDB replica set nodes.
<SessionName> - define name of a session for using in item keys.

Default: false Range: true - connect only to the specified server, ignoring other members of the replica set, false - automatically discover all nodes in the replica set.

If the tcp:// (deprecated) scheme is used, the parameter is set to true by default.

Plugins.MongoDB.Default.Password

Specify the default password.
<SessionName> - define name of a session for using in item keys.

Plugins.MongoDB.Default.ReplicaSet

Specify the default replica set name, used for automatic discovery of MongoDB replica set nodes.
<SessionName> - define name of a session for using in item keys.
If this parameter is used with the mongodb+srv:// scheme, it will behave as if multiple URLs have been provided; a DNS server may have a TXT record that can override this (or any other) parameter.
Unavailable if the Plugins.MongoDB.Sessions.<SessionName>.Direct parameter is set to true; the agent will fail to start.

Plugins.MongoDB.Default.ReadPreference

Specify the default order for connecting to MongoDB replica set nodes or fallback.
<SessionName> - define name of a session for using in item keys.
Unavailable if the Plugins.MongoDB.Sessions.<SessionName>.Direct parameter is set to true; the agent will fail to start.

Range: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode, or NearestMode

Plugins.MongoDB.Default.TLSConnect

Specify the level of encryption required for communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.
Supported since plugin version 1.2.1.

Range: required - require TLS connection, verify_ca - verify certificates, verify_full - verify certificates and IP address

Plugins.MongoDB.Default.TLSCAFile

Specify full pathname of the file containing the top-level CA(s) certificates for peer certificate verification, used 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.MongoDB.Sessions.<SessionName>.TLSConnect is set to verify_ca or verify_full

Plugins.MongoDB.Default.TLSCertFile

Specify full pathname of the file containing the agent certificate or certificate chain, used 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.MongoDB.Sessions.<SessionName>.TLSKeyFile is specified

Plugins.MongoDB.Default.TLSKeyFile

Specify full pathname of the file containing the database private key, used 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.MongoDB.Sessions.<SessionName>.TLSCertFile is specified

Plugins.MongoDB.Default.Uri

Specify the default URI.
<SessionName> - define name of a session for using in item keys.
Must match the URI format.
Supported schemes: mongodb:// and mongodb+srv://; the tcp:// scheme is deprecated and kept for backward compatibility with existing configurations.
A port can be omitted (default=27017).
Examples: ``

Default: tcp://127.0.0.1:27017

Examples:

mongodb://127.0.0.1:27017
mongodb+srv://example.com
localhost
Plugins.MongoDB.Default.User

Specify the default username.
<SessionName> - define name of a session for using in item keys.

Plugins.MongoDB.KeepAlive

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

Default: 300 Range: 60-900

Plugins.MongoDB.Sessions.<SessionName>.AuthMechanism

Specify the named session authentication mechanism for connecting to MongoDB server.
<SessionName> - define name of a session for using in item keys.

Range: SCRAM-SHA-1, SCRAM-SHA-256, or MONGODB-X509

Plugins.MongoDB.Sessions.<SessionName>.AuthSource

Specify the named session database for authenticating connection to MongoDB server.
<SessionName> - define name of a session for using in item keys.

Default: admin

If MONGODB-X509 authentication mechanism is used, this parameter is automatically set to $external; modifying it to any other value will cause an error when launching.

Plugins.MongoDB.Sessions.<SessionName>.Direct

Disable automatic discovery of MongoDB replica set nodes for named session.
<SessionName> - define name of a session for using in item keys.

Default: false Range: true - connect only to the specified server, ignoring other members of the replica set, false - automatically discover all nodes in the replica set.

If the tcp:// (deprecated) scheme is used, the parameter is set to true by default.

Plugins.MongoDB.Sessions.<SessionName>.Password

Specify the named session password.
<SessionName> - define name of a session for using in item keys.

Plugins.MongoDB.Sessions.<SessionName>.ReplicaSet

Specify the named session replica set name, used for automatic discovery of MongoDB replica set nodes.
<SessionName> - define name of a session for using in item keys.
If this parameter is used with the mongodb+srv:// scheme, it will behave as if multiple URLs have been provided; a DNS server may have a TXT record that can override this (or any other) parameter.
Unavailable if the Plugins.MongoDB.Sessions.<SessionName>.Direct parameter is set to true; the agent will fail to start.

Plugins.MongoDB.Sessions.<SessionName>.ReadPreference

Specify the named session order for connecting to MongoDB replica set nodes or fallback.
<SessionName> - define name of a session for using in item keys.
Unavailable if the Plugins.MongoDB.Sessions.<SessionName>.Direct parameter is set to true; the agent will fail to start.

Range: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode, or NearestMode

Plugins.MongoDB.Sessions.<SessionName>.TLSConnect

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

Range: required - require TLS connection, verify_ca - verify certificates, verify_full - verify certificates and IP address

Plugins.MongoDB.Sessions.<SessionName>.TLSCAFile

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

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

Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile

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

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

Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile

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

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

Plugins.MongoDB.Sessions.<SessionName>.Uri

Specify the named session URI.
<SessionName> - define name of a session for using in item keys.
Must match the URI format.
Supported schemes: mongodb:// and mongodb+srv://; the tcp:// scheme is deprecated and kept for backward compatibility with existing configurations.
A port can be omitted (default=27017).
Examples: ``

Default: tcp://127.0.0.1:27017

Examples:

mongodb://127.0.0.1:27017
mongodb+srv://example.com
localhost
Plugins.MongoDB.Sessions.<SessionName>.User

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

Plugins.MongoDB.System.Path

Specify path to the MongoDB plugin executable.

Example usage: Plugins.MongoDB.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mongodb

Plugins.MongoDB.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

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).

Parâmetros

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 de 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), então o plugin considerará que o parâmetro *.<SessionName>.AuthSource está definido como admin, mesmo que o parâmetro *.<SessionName>.AuthSource esteja definido 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 de item do Zabbix agent 2, o plugin usará o nome de usuário e a senha da chave de item, mesmo que Plugins.MongoDB.Sessions.<SessionName>.User e Plugins.MongoDB.Sessions.<SessionName>.Password estejam configurados.

Se o esquema mongodb+srv:// for usado, a URI poderá recuperar parâmetros de um registro TXT de DNS. Os parâmetros obtidos desse registro TXT substituem todas as outras configurações, incluindo parâmetros da URI, parâmetros da chave de item do Zabbix Agent 2 e parâmetros de sessão.
Apenas um registro TXT pode existir para o hostname usado na string de conexão.

Parameter Mandatory Range Default Description
Plugins.MongoDB.System.Path no 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 no 1-30 global timeout 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).
Plugins.MongoDB.KeepAlive no 60-900 300 Tempo máximo de espera (em segundos) antes que conexões do plugin não utilizadas sejam fechadas.
Plugins.MongoDB.Sessions.<SessionName>.Uri no 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 de 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: mongodb://127.0.0.1:27017, mongodb+srv://example.com, localhost.
Plugins.MongoDB.Sessions.<SessionName>.User no 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 no Senha da sessão nomeada.
<SessionName> - define o nome de uma sessão para uso em chaves de item.
Plugins.MongoDB.Sessions.<SessionName>.Direct no false Método de conexão usado para determinar se a descoberta automática dos nós do replica set do MongoDB deve ser habilitada ou desabilitada.
<SessionName> - define o nome de uma sessão para uso em chaves de item.

Valores suportados:
true - o plugin se conectará apenas ao server especificado, ignorando outros membros do replica set;
false - o plugin descobrirá automaticamente todos os nós no replica set.
Se o esquema tcp:// (obsoleto) for usado, o parâmetro será definido como true por padrão.
Plugins.MongoDB.Sessions.<SessionName>.AuthMechanism no Mecanismo de autenticação para conexão com o MongoDB server.
<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 no admin Banco de dados para autenticar a conexão com o MongoDB server.
<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á definido automaticamente como $external; alterá-lo para qualquer outro valor causará um erro na inicialização.
Plugins.MongoDB.Sessions.<SessionName>.ReplicaSet no Nome do replica set, usado para descoberta automática dos nós do replica set 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 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 no Ordem para conectar aos nós do replica set do MongoDB ou para 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 falhará ao iniciar.
Plugins.MongoDB.Sessions.<SessionName>.TLSConnect no Tipo de criptografia para comunicações entre o Zabbix agent 2 e os bancos de dados monitorados.
<SessionName> - define o nome de uma sessão para uso em chaves de item.

Valores suportados:
required - exige 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 yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSConnect is set to one of: verify_ca, verify_full Caminho completo de um arquivo contendo os certificados da 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.
<SessionName> - define o nome de uma sessão para uso em chaves de item.
Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile is specified Caminho completo de um arquivo contendo 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> - define o nome de uma sessão para uso em chaves de item.
Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile is specified Caminho completo de um arquivo contendo 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 em chaves de item.
Plugins.MongoDB.Default.Uri no tcp://127.0.0.1:27017 URI padrão para conexão com o MongoDB.

Deve corresponder ao formato de URI.
Esquemas suportados: mongodb:// e mongodb+srv://.
Esquema obsoleto: tcp:// (usado como padrão por compatibilidade com configurações existentes).
A porta pode ser omitida (padrão=27017).
Exemplos: mongodb://127.0.0.1:27017, mongodb+srv://example.com, localhost.
Plugins.MongoDB.Default.User no Nome de usuário padrão para conexão com o MongoDB.
Plugins.MongoDB.Default.Password no Senha padrão para conexão com o MongoDB.
Plugins.MongoDB.Default.Direct no false Método de conexão padrão usado para determinar se a descoberta automática dos nós do replica set do MongoDB deve ser habilitada ou desabilitada.

Valores suportados:
true - o plugin se conectará apenas ao server especificado, ignorando outros membros do replica set;
false - o plugin descobrirá automaticamente todos os nós no replica set.
Se o esquema tcp:// (obsoleto) for usado, o parâmetro será definido como true por padrão.
Plugins.MongoDB.Default.AuthMechanism no Mecanismo de autenticação padrão para conexão com o MongoDB server.

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, será usado um mecanismo baseado em SCRAM (se um nome de usuário for fornecido; caso contrário, nenhuma autenticação será usada).
Plugins.MongoDB.Default.AuthSource no admin Banco de dados padrão para autenticar a conexão com o MongoDB server.

Se o mecanismo de autenticação MONGODB-X509 for usado, este parâmetro será definido automaticamente como $external; alterá-lo para qualquer outro valor causará um erro na inicialização.
Plugins.MongoDB.Default.ReplicaSet no Nome padrão do replica set; usado para descoberta automática dos nós do replica set 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 parâmetro (ou qualquer outro).
Indisponível se o parâmetro Plugins.MongoDB.Default.Direct estiver definido como true; o agent falhará ao iniciar.
Plugins.MongoDB.Default.ReadPreference no Ordem padrão para conectar aos nós do replica set do MongoDB ou para 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 falhará ao iniciar.
Plugins.MongoDB.Default.TLSConnect no Tipo de criptografia padrão para comunicações entre o Zabbix agent 2 e os bancos de dados monitorados.

Valores suportados:
required - exige 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 no Caminho padrão de um arquivo contendo os certificados da 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.
Plugins.MongoDB.Default.TLSCertFile no Caminho padrão de um arquivo contendo o certificado do cliente MongoDB ou a cadeia de certificados. Usado para comunicações criptografadas entre o Zabbix agent 2 e os bancos de dados monitorados.
Plugins.MongoDB.Default.TLSKeyFile no Caminho padrão de um arquivo contendo a chave privada do cliente MongoDB usada para comunicações criptografadas entre o Zabbix agent 2 e os bancos de dados monitorados.

Veja também: