MongoDB-Plugin

Übersicht

Konfigurationsparameter ermöglichen die Anpassung des Verhaltens des MongoDB-Plugins.

Es wird empfohlen, sie in einer eigenen Konfigurationsdatei anzugeben (z. B. mongodb.conf) und nicht in der Konfigurationsdatei von Agent 2. Verwenden Sie dann die Direktive Include, um diese Datei in die Konfiguration von Zabbix Agent 2 einzubinden.

Das MongoDB-Plugin ist ein ladbares Plugin und ist im MongoDB-Plugin-Repository verfügbar und dort vollständig beschrieben.

Alle Parameter sind optional, sofern nicht ausdrücklich angegeben ist, dass der Parameter obligatorisch ist.

Beachten Sie:

  • Die Standardwerte spiegeln die Prozess-Standardeinstellungen wider, nicht die Werte in den mitgelieferten Konfigurationsdateien.
  • Werte unterstützen Umgebungsvariablen.
  • Zabbix unterstützt Konfigurationsdateien nur in UTF-8-Kodierung ohne BOM.
  • Kommentare, die mit "#" beginnen, werden nur am Anfang der Zeile unterstützt.

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

Optionen

Parameter Beschreibung
-V --version Gibt die Plugin-Version und Lizenzinformationen aus.
-h --help Gibt Hilfsinformationen aus (Kurzform).
-t, --test <item key> Startet das Plugin zum Testen (Plugin-Konfiguration wird ignoriert).

Parameter

Beim Verbinden mit MongoDB prüft das Plugin seine Konfiguration in einer bestimmten Reihenfolge, die bestimmt, welcher Wert verwendet wird. Die Reihenfolge von der höchsten zur niedrigsten Priorität lautet:

  1. Parameter, die in der Verbindungs-URI angegeben sind (z. B. haben Abfrageparameter, die nach ? in Plugins.MongoDB.Sessions.<session_name>.Uri definiert sind, die höchste Priorität).
  2. Parameter im Zabbix Agent 2 Item-Schlüssel (z. B. mongodb.collection.stats).
  3. Parameter, die in einer benannten Sitzung definiert sind (z. B. Plugins.MongoDB.Sessions.<SessionName>.User, Plugins.MongoDB.Sessions.<SessionName>.Password).
  4. Standardwerte (z. B. Plugins.MongoDB.Default.User, Plugins.MongoDB.Default.Password).

Beispiel:

  • Wenn Sie die Datenbank für die Authentifizierung einer Verbindung zum MongoDB Server im Parameter *.<SessionName>.Uri angeben (z. B. Plugins.MongoDB.Sessions.<session_name>.Uri=mongodb://user:[email protected]:27017/?authSource=admin), dann betrachtet das Plugin den Parameter *.<SessionName>.AuthSource als auf admin gesetzt, auch wenn der Parameter *.<SessionName>.AuthSource auf einen anderen Wert gesetzt ist.
  • Wenn Sie die URI im Parameter *.<SessionName>.Uri angeben (z. B. Plugins.MongoDB.Sessions.<session_name>.Uri=mongodb://127.0.0.1:27017), aber Benutzername und Passwort im Zabbix Agent 2 Item-Schlüssel bereitstellen, verwendet das Plugin den Benutzernamen und das Passwort aus dem Item-Schlüssel, auch wenn Plugins.MongoDB.Sessions.<SessionName>.User und Plugins.MongoDB.Sessions.<SessionName>.Password konfiguriert sind.

Wenn das Schema mongodb+srv:// verwendet wird, kann die URI Parameter aus einem DNS-TXT-Eintrag abrufen. Parameter aus diesem TXT-Eintrag überschreiben alle anderen Konfigurationen, einschließlich URI-Parametern, Zabbix Agent 2 Item-Schlüssel-Parametern und Sitzungsparametern.
Für den in der Verbindungszeichenfolge verwendeten Hostnamen darf nur ein TXT-Eintrag vorhanden sein.

Parameter Mandatory Range Default Description
Plugins.MongoDB.System.Path no Pfad zur ausführbaren Datei des MongoDB-Plugins.
Beispiel: Plugins.MongoDB.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mongodb
Plugins.MongoDB.Timeout no 1-30 global timeout Zeitlimit für die Ausführung einer Anfrage (die Dauer in Sekunden, die auf den Abschluss einer Anfrage gewartet wird, bevor sie beendet wird).
Plugins.MongoDB.KeepAlive no 60-900 300 Maximale Wartezeit in Sekunden, bevor ungenutzte Plugin-Verbindungen geschlossen werden.
Plugins.MongoDB.Sessions.<SessionName>.Uri no tcp://127.0.0.1:27017 Verbindungszeichenfolge einer benannten Sitzung.
<SessionName> - Name einer Sitzung für die Verwendung in Item-Schlüsseln definieren.

Muss dem URI-Format entsprechen.
Unterstützte Schemas: mongodb:// und mongodb+srv://; das Schema tcp:// ist veraltet und wird aus Gründen der Abwärtskompatibilität mit vorhandenen Konfigurationen beibehalten.
Ein Port kann weggelassen werden (Standard=27017).
Beispiele: mongodb://127.0.0.1:27017, mongodb+srv://example.com, localhost.
Plugins.MongoDB.Sessions.<SessionName>.User no Benutzername der benannten Sitzung.
<SessionName> - Name einer Sitzung für die Verwendung in Item-Schlüsseln definieren.
Plugins.MongoDB.Sessions.<SessionName>.Password no Passwort der benannten Sitzung.
<SessionName> - Name einer Sitzung für die Verwendung in Item-Schlüsseln definieren.
Plugins.MongoDB.Sessions.<SessionName>.Direct no false Verbindungsmethode, mit der festgelegt wird, ob die automatische Erkennung von Knoten eines MongoDB-Replikatsatzes aktiviert oder deaktiviert werden soll.
<SessionName> - Name einer Sitzung für die Verwendung in Item-Schlüsseln definieren.

Unterstützte Werte:
true - das Plugin verbindet sich nur mit dem angegebenen Server und ignoriert andere Mitglieder des Replikatsatzes;
false - das Plugin erkennt automatisch alle Knoten im Replikatsatz.
Wenn das Schema tcp:// (veraltet) verwendet wird, ist der Parameter standardmäßig auf true gesetzt.
Plugins.MongoDB.Sessions.<SessionName>.AuthMechanism no Authentifizierungsmechanismus für die Verbindung zum MongoDB Server.
<SessionName> - Name einer Sitzung für die Verwendung in Item-Schlüsseln definieren.

Unterstützte Werte: SCRAM-SHA-1, SCRAM-SHA-256 und MONGODB-X509.
Plugins.MongoDB.Sessions.<SessionName>.AuthSource no admin Datenbank zur Authentifizierung der Verbindung zum MongoDB Server.
<SessionName> - Name einer Sitzung für die Verwendung in Item-Schlüsseln definieren.

Wenn der Authentifizierungsmechanismus MONGODB-X509 verwendet wird, wird dieser Parameter automatisch auf $external gesetzt; eine Änderung auf einen anderen Wert führt beim Start zu einem Fehler.
Plugins.MongoDB.Sessions.<SessionName>.ReplicaSet no Name des Replikatsatzes, verwendet für die automatische Erkennung von Knoten des MongoDB-Replikatsatzes.
<SessionName> - Name einer Sitzung für die Verwendung in Item-Schlüsseln definieren.

Wenn dieser Parameter mit dem Schema mongodb+srv:// verwendet wird, verhält er sich so, als wären mehrere URLs angegeben worden; ein DNS-Server kann einen TXT-Eintrag haben, der diesen (oder einen anderen) Parameter überschreibt.

Nicht verfügbar, wenn der Parameter Plugins.MongoDB.Sessions.<SessionName>.Direct auf true gesetzt ist, der Agent kann dann nicht gestartet werden.
Plugins.MongoDB.Sessions.<SessionName>.ReadPreference no Reihenfolge für die Verbindung zu Knoten des MongoDB-Replikatsatzes oder für den Fallback.
<SessionName> - Name einer Sitzung für die Verwendung in Item-Schlüsseln definieren.

Unterstützte Werte: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode und NearestMode.
Nicht verfügbar, wenn der Parameter Plugins.MongoDB.Sessions.<SessionName>.Direct auf true gesetzt ist, der Agent kann dann nicht gestartet werden.
Plugins.MongoDB.Sessions.<SessionName>.TLSConnect no Verschlüsselungstyp für die Kommunikation zwischen Zabbix Agent 2 und überwachten Datenbanken.
<SessionName> - Name einer Sitzung für die Verwendung in Item-Schlüsseln definieren.

Unterstützte Werte:
required - TLS-Verbindung erforderlich;
verify\_ca - Zertifikate prüfen;
verify\_full - Zertifikate und IP-Adresse prüfen.

Unterstützt seit Plugin-Version 1.2.1.
Plugins.MongoDB.Sessions.<SessionName>.TLSCAFile yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSConnect is set to one of: verify_ca, verify_full Vollständiger Pfad zu einer Datei mit den Zertifikaten der obersten CA(s) zur Überprüfung des Peer-Zertifikats, verwendet für verschlüsselte Kommunikation zwischen Zabbix Agent 2 und überwachten Datenbanken.
<SessionName> - Name einer Sitzung für die Verwendung in Item-Schlüsseln definieren.
Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile is specified Vollständiger Pfad zu einer Datei mit dem Agent-Zertifikat oder der Zertifikatskette, verwendet für verschlüsselte Kommunikation zwischen Zabbix Agent 2 und überwachten Datenbanken.
<SessionName> - Name einer Sitzung für die Verwendung in Item-Schlüsseln definieren.
Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile is specified Vollständiger Pfad zu einer Datei mit dem privaten Schlüssel der Datenbank, verwendet für verschlüsselte Kommunikation zwischen Zabbix Agent 2 und überwachten Datenbanken.
<SessionName> - Name einer Sitzung für die Verwendung in Item-Schlüsseln definieren.
Plugins.MongoDB.Default.Uri no tcp://127.0.0.1:27017 Standard-URI für die Verbindung zu MongoDB.

Muss dem URI-Format entsprechen.
Unterstützte Schemas: mongodb:// und mongodb+srv://.
Veraltetes Schema: tcp:// (wird standardmäßig aus Gründen der Abwärtskompatibilität mit vorhandenen Konfigurationen verwendet).
Ein Port kann weggelassen werden (Standard=27017).
Beispiele: mongodb://127.0.0.1:27017, mongodb+srv://example.com, localhost.
Plugins.MongoDB.Default.User no Standard-Benutzername für die Verbindung zu MongoDB.
Plugins.MongoDB.Default.Password no Standard-Passwort für die Verbindung zu MongoDB.
Plugins.MongoDB.Default.Direct no false Standard-Verbindungsmethode, mit der festgelegt wird, ob die automatische Erkennung von Knoten eines MongoDB-Replikatsatzes aktiviert oder deaktiviert werden soll.

Unterstützte Werte:
true - das Plugin verbindet sich nur mit dem angegebenen Server und ignoriert andere Mitglieder des Replikatsatzes;
false - das Plugin erkennt automatisch alle Knoten im Replikatsatz.
Wenn das Schema tcp:// (veraltet) verwendet wird, ist der Parameter standardmäßig auf true gesetzt.
Plugins.MongoDB.Default.AuthMechanism no Standard-Authentifizierungsmechanismus für die Verbindung zum MongoDB Server.

Unterstützte Werte: SCRAM-SHA-1, SCRAM-SHA-256 und MONGODB-X509.
Wenn hier, in einem Item-Schlüssel, in einer benannten Sitzung oder in der URI kein Wert angegeben ist, wird ein auf SCRAM basierender Mechanismus verwendet (wenn ein Benutzername angegeben ist; andernfalls wird keine Authentifizierung verwendet).
Plugins.MongoDB.Default.AuthSource no admin Standard-Datenbank zur Authentifizierung der Verbindung zum MongoDB Server.

Wenn der Authentifizierungsmechanismus MONGODB-X509 verwendet wird, wird dieser Parameter automatisch auf $external gesetzt; eine Änderung auf einen anderen Wert führt beim Start zu einem Fehler.
Plugins.MongoDB.Default.ReplicaSet no Standardname des Replikatsatzes; verwendet für die automatische Erkennung von Knoten des MongoDB-Replikatsatzes.

Wenn dieser Parameter mit dem Schema mongodb+srv:// verwendet wird, verhält er sich so, als wären mehrere URLs angegeben worden; ein DNS-Server kann einen TXT-Eintrag haben, der diesen (oder einen anderen) Parameter überschreibt.
Nicht verfügbar, wenn der Parameter Plugins.MongoDB.Default.Direct auf true gesetzt ist, der Agent kann dann nicht gestartet werden.
Plugins.MongoDB.Default.ReadPreference no Standardreihenfolge für die Verbindung zu Knoten des MongoDB-Replikatsatzes oder für den Fallback.

Unterstützte Werte: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode und NearestMode.
Nicht verfügbar, wenn der Parameter Plugins.MongoDB.Default.Direct auf true gesetzt ist, der Agent kann dann nicht gestartet werden.
Plugins.MongoDB.Default.TLSConnect no Standard-Verschlüsselungstyp für die Kommunikation zwischen Zabbix Agent 2 und überwachten Datenbanken.

Unterstützte Werte:
required - erfordert eine TLS-Verbindung.
verify\_ca - prüft Zertifikate.
verify\_full - prüft Zertifikate und IP-Adresse.
Wenn hier, in einem Item-Schlüssel, in einer benannten Sitzung oder in der URI kein Wert angegeben ist, wird keine TLS-Verbindung hergestellt.
Plugins.MongoDB.Default.TLSCAFile no Standard-Pfad zu einer Datei mit den Zertifikaten der obersten CA(s) zur Überprüfung des Peer-Zertifikats. Wird für verschlüsselte Kommunikation zwischen Zabbix Agent 2 und überwachten Datenbanken verwendet.
Plugins.MongoDB.Default.TLSCertFile no Standard-Pfad zu einer Datei mit dem MongoDB-Clientzertifikat oder der Zertifikatskette. Wird für verschlüsselte Kommunikation zwischen Zabbix Agent 2 und überwachten Datenbanken verwendet.
Plugins.MongoDB.Default.TLSKeyFile no Standard-Pfad zu einer Datei mit dem privaten Schlüssel des MongoDB-Clients, verwendet für verschlüsselte Kommunikation zwischen Zabbix Agent 2 und überwachten Datenbanken.

Siehe auch: