5 MongoDB plugin

Overview

This section lists parameters supported in the MongoDB Zabbix agent 2 plugin configuration file (mongo.conf).

This is a loadable plugin, which is available and fully described in the MongoDB plugin repository.

Note that:

  • The default values reflect process defaults, not the values in the shipped configuration files;
  • Zabbix supports configuration files only in UTF-8 encoding without BOM;
  • Comments starting with “#” are only supported at the beginning of the line.

Options

ParameterDescription
-V —versionPrint the plugin version and license information.
-h —helpPrint help information (shorthand).

Parameters

ParameterMandatoryRangeDefaultDescription
Plugins.MongoDB.KeepAliveno60-900300The maximum time of waiting (in seconds) before unused plugin connections are closed.
Plugins.MongoDB.Sessions.<SessionName>.PasswordnoNamed session password.
<SessionName> - define name of a session for using in item keys.
Plugins.MongoDB.Sessions.<SessionName>.TLSCAFileno
(yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSConnect is set to one of: verify_ca, verify_full)		Full pathname of a 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.
Plugins.MongoDB.Sessions.<SessionName>.TLSCertFileno
(yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSConnect is set to one of: verify_ca, verify_full)		Full pathname of a 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.
Plugins.MongoDB.Sessions.<SessionName>.TLSConnectnoEncryption type for communications between Zabbix agent 2 and monitored databases.
<SessionName> - define name of a session for using in item keys.

Accepted values:
required - require TLS connection;
verify_ca - verify certificates;
verify_full - verify certificates and IP address.

Supported since plugin version 1.2.1
Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFileno
(yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSConnect is set to one of: verify_ca, verify_full)		Full pathname of a 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.
Plugins.MongoDB.Sessions.<SessionName>.UrinoConnection string of a named session.
<SessionName> - define name of a session for using in item keys.

Should not include embedded credentials (they will be ignored).
Must match the URI format.
Only tcp scheme is supported; a scheme can be omitted.
A port can be omitted (default=27017).
Examples: tcp://127.0.0.1:27017, tcp:localhost, localhost
Plugins.MongoDB.Sessions.<SessionName>.UsernoNamed session username.
<SessionName> - define name of a session for using in item keys.
Plugins.MongoDB.System.PathnoPath to plugin executable.
Plugins.MongoDB.Timeoutno1-30global timeoutRequest execution timeout (how long to wait for a request to complete before shutting it down).

See also: