MongoDB spraudnis

Pārskats

Konfigurācijas parametri ļauj pielāgot MongoDB spraudņa darbību.

Ieteicams tos norādīt atsevišķā konfigurācijas failā (piem., mongodb.conf), nevis aģents 2 konfigurācijas failā. Pēc tam izmantojiet direktīvu Include, lai iekļautu šo failu Zabbix aģents 2 konfigurācijā.

MongoDB spraudnis ir ielādējams spraudnis, un tas ir pieejams un pilnībā aprakstīts MongoDB spraudņa repozitorijā.

Visi parametri ir neobligāti, ja vien nav skaidri norādīts, ka parametrs ir obligāts.

Ņemiet vērā:

  • Noklusējuma vērtības atspoguļo procesa noklusējuma iestatījumus, nevis vērtības piegādātajos konfigurācijas failos.
  • Vērtības atbalsta vides mainīgos.
  • Zabbix atbalsta konfigurācijas failus tikai UTF-8 kodējumā bez BOM.
  • Komentāri, kas sākas ar "#", tiek atbalstīti tikai rindas sākumā.

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

Opcijas

Parameter Description
-V --version Izdrukā spraudņa versiju un licences informāciju.
-h --help Izdrukā palīdzības informāciju (saīsināti).
-t, --test <item key> Palaiž spraudni testēšanai (spraudņa konfigurācija tiek ignorēta).

Parametri

Veidojot savienojumu ar MongoDB, spraudnis pārbauda savu konfigurāciju noteiktā secībā, un tas nosaka, kura vērtība tiks izmantota. Secība no augstākās līdz zemākajai prioritātei ir šāda:

  1. Parametri, kas norādīti savienojuma URI (piemēram, vaicājuma parametri, kas definēti aiz ? Plugins.MongoDB.Sessions.<session_name>.Uri ir ar visaugstāko prioritāti).
  2. Parametri Zabbix aģenta 2 vienuma atslēgā (piemēram, mongodb.collection.stats).
  3. Parametri, kas definēti nosauktā sesijā (piemēram, Plugins.MongoDB.Sessions.<SessionName>.User, Plugins.MongoDB.Sessions.<SessionName>.Password).
  4. Noklusējuma vērtības (piemēram, Plugins.MongoDB.Default.User, Plugins.MongoDB.Default.Password).

Piemēram:

  • Ja autentificēšanās savienojumam ar MongoDB serveri datubāzi norādāt *.<SessionName>.Uri parametrā (piemēram, Plugins.MongoDB.Sessions.<session_name>.Uri=mongodb://user:[email protected]:27017/?authSource=admin), tad spraudnis uzskatīs, ka *.<SessionName>.AuthSource parametrs ir iestatīts uz admin, pat ja *.<SessionName>.AuthSource parametrā ir norādīta cita vērtība.
  • Ja URI norādāt *.<SessionName>.Uri parametrā (piemēram, Plugins.MongoDB.Sessions.<session_name>.Uri=mongodb://127.0.0.1:27017), bet lietotājvārdu un paroli norādāt Zabbix aģenta 2 vienuma atslēgā, spraudnis izmantos lietotājvārdu un paroli no vienuma atslēgas, pat ja ir konfigurēti Plugins.MongoDB.Sessions.<SessionName>.User un Plugins.MongoDB.Sessions.<SessionName>.Password.

Ja tiek izmantota shēma mongodb+srv://, URI var izgūt parametrus no DNS TXT ieraksta. No šī TXT ieraksta iegūtie parametri pārraksta visas pārējās konfigurācijas, tostarp URI parametrus, Zabbix Agent 2 vienuma atslēgas parametrus un sesijas parametrus.
Savienojuma virknē izmantotajam resursdatora nosaukumam var pastāvēt tikai viens TXT ieraksts.

Parameter Mandatory Range Default Description
Plugins.MongoDB.System.Path no MongoDB spraudņa izpildāmā faila ceļš.
Lietošanas piemērs: Plugins.MongoDB.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mongodb
Plugins.MongoDB.Timeout no 1-30 global timeout Pieprasījuma izpildes noildze (ilgums sekundēs, cik ilgi gaidīt, līdz pieprasījums tiks pabeigts, pirms to pārtrauc).
Plugins.MongoDB.KeepAlive no 60-900 300 Maksimālais gaidīšanas laiks sekundēs, pirms neizmantotie spraudņa savienojumi tiek slēgti.
Plugins.MongoDB.Sessions.<SessionName>.Uri no tcp://127.0.0.1:27017 Nosauktas sesijas savienojuma virkne.
<SessionName> - definē sesijas nosaukumu izmantošanai vienuma atslēgās.

Jāatbilst URI formātam.
Atbalstītās shēmas: mongodb:// un mongodb+srv://; shēma tcp:// ir novecojusi un saglabāta atpakaļsavietojamībai ar esošajām konfigurācijām.
Portu var nenorādīt (noklusējums=27017).
Piemēri: mongodb://127.0.0.1:27017, mongodb+srv://example.com, localhost.
Plugins.MongoDB.Sessions.<SessionName>.User no Nosauktās sesijas lietotājvārds.
<SessionName> - definē sesijas nosaukumu izmantošanai vienuma atslēgās.
Plugins.MongoDB.Sessions.<SessionName>.Password no Nosauktās sesijas parole.
<SessionName> - definē sesijas nosaukumu izmantošanai vienuma atslēgās.
Plugins.MongoDB.Sessions.<SessionName>.Direct no false Savienojuma metode, ko izmanto, lai noteiktu, vai MongoDB repliku kopas mezglu automātiskā noteikšana ir jāiespējo vai jāatspējo.
<SessionName> - definē sesijas nosaukumu izmantošanai vienuma atslēgās.

Atbalstītās vērtības:
true - spraudnis savienosies tikai ar norādīto serveri, ignorējot citus repliku kopas dalībniekus;
false - spraudnis automātiski noteiks visus repliku kopas mezglus.
Ja tiek izmantota shēma tcp:// (novecojusi), parametrs pēc noklusējuma tiek iestatīts uz true.
Plugins.MongoDB.Sessions.<SessionName>.AuthMechanism no Autentifikācijas mehānisms savienojumam ar MongoDB serveri.
<SessionName> - definē sesijas nosaukumu izmantošanai vienuma atslēgās.

Atbalstītās vērtības: SCRAM-SHA-1, SCRAM-SHA-256 un MONGODB-X509.
Plugins.MongoDB.Sessions.<SessionName>.AuthSource no admin Datubāze autentificēšanai savienojumam ar MongoDB serveri.
<SessionName> - definē sesijas nosaukumu izmantošanai vienuma atslēgās.

Ja tiek izmantots autentifikācijas mehānisms MONGODB-X509, šis parametrs automātiski tiek iestatīts uz $external; tā modificēšana uz jebkuru citu vērtību izraisīs kļūdu palaišanas laikā.
Plugins.MongoDB.Sessions.<SessionName>.ReplicaSet no Repliku kopas nosaukums, ko izmanto MongoDB repliku kopas mezglu automātiskai noteikšanai.
<SessionName> - definē sesijas nosaukumu izmantošanai vienuma atslēgās.

Ja šis parametrs tiek izmantots kopā ar shēmu mongodb+srv://, tas darbosies tā, it kā būtu norādīti vairāki URL; DNS serverim var būt TXT ieraksts, kas var pārrakstīt šo (vai jebkuru citu) parametru.

Nav pieejams, ja parametrs Plugins.MongoDB.Sessions.<SessionName>.Direct ir iestatīts uz true, aģents neizdosies startēties.
Plugins.MongoDB.Sessions.<SessionName>.ReadPreference no Secība savienojumam ar MongoDB repliku kopas mezgliem vai atkāpšanās gadījumā.
<SessionName> - definē sesijas nosaukumu izmantošanai vienuma atslēgās.

Atbalstītās vērtības: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode un NearestMode.
Nav pieejams, ja parametrs Plugins.MongoDB.Sessions.<SessionName>.Direct ir iestatīts uz true, aģents neizdosies startēties.
Plugins.MongoDB.Sessions.<SessionName>.TLSConnect no Šifrēšanas veids saziņai starp Zabbix aģentu 2 un uzraudzītajām datubāzēm.
<SessionName> - definē sesijas nosaukumu izmantošanai vienuma atslēgās.

Atbalstītās vērtības:
required - pieprasa TLS savienojumu;
verify\_ca - pārbauda sertifikātus;
verify\_full - pārbauda sertifikātus un IP adresi.

Atbalstīts kopš spraudņa versijas 1.2.1.
Plugins.MongoDB.Sessions.<SessionName>.TLSCAFile yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSConnect is set to one of: verify_ca, verify_full Pilns faila ceļš uz failu, kas satur augstākā līmeņa CA sertifikātus vienaudža sertifikāta pārbaudei, ko izmanto šifrētai saziņai starp Zabbix aģentu 2 un uzraudzītajām datubāzēm.
<SessionName> - definē sesijas nosaukumu izmantošanai vienuma atslēgās.
Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile is specified Pilns faila ceļš uz failu, kas satur aģenta sertifikātu vai sertifikātu ķēdi, ko izmanto šifrētai saziņai starp Zabbix aģentu 2 un uzraudzītajām datubāzēm.
<SessionName> - definē sesijas nosaukumu izmantošanai vienuma atslēgās.
Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile is specified Pilns faila ceļš uz failu, kas satur datubāzes privāto atslēgu, ko izmanto šifrētai saziņai starp Zabbix aģentu 2 un uzraudzītajām datubāzēm.
<SessionName> - definē sesijas nosaukumu izmantošanai vienuma atslēgās.
Plugins.MongoDB.Default.Uri no tcp://127.0.0.1:27017 Noklusējuma URI savienojumam ar MongoDB.

Jāatbilst URI formātam.
Atbalstītās shēmas: mongodb:// un mongodb+srv://.
Novecojusi shēma: tcp:// (tiek izmantota kā noklusējums atpakaļsavietojamībai ar esošajām konfigurācijām).
Portu var nenorādīt (noklusējums=27017).
Piemēri: mongodb://127.0.0.1:27017, mongodb+srv://example.com, localhost.
Plugins.MongoDB.Default.User no Noklusējuma lietotājvārds savienojumam ar MongoDB.
Plugins.MongoDB.Default.Password no Noklusējuma parole savienojumam ar MongoDB.
Plugins.MongoDB.Default.Direct no false Noklusējuma savienojuma metode, ko izmanto, lai noteiktu, vai MongoDB repliku kopas mezglu automātiskā noteikšana ir jāiespējo vai jāatspējo.

Atbalstītās vērtības:
true - spraudnis savienosies tikai ar norādīto serveri, ignorējot citus repliku kopas dalībniekus;
false - spraudnis automātiski noteiks visus repliku kopas mezglus.
Ja tiek izmantota shēma tcp:// (novecojusi), parametrs pēc noklusējuma tiek iestatīts uz true.
Plugins.MongoDB.Default.AuthMechanism no Noklusējuma autentifikācijas mehānisms savienojumam ar MongoDB serveri.

Atbalstītās vērtības: SCRAM-SHA-1, SCRAM-SHA-256 un MONGODB-X509.
Ja šeit, vienuma atslēgā, nosauktā sesijā vai URI nav norādīta neviena vērtība, tiks izmantots uz SCRAM balstīts mehānisms (ja ir norādīts lietotājvārds; pretējā gadījumā autentifikācija netiks izmantota).
Plugins.MongoDB.Default.AuthSource no admin Noklusējuma datubāze savienojuma ar MongoDB serveri autentificēšanai.

Ja tiek izmantots autentifikācijas mehānisms MONGODB-X509, šis parametrs automātiski tiek iestatīts uz $external; tā modificēšana uz jebkuru citu vērtību izraisīs kļūdu palaišanas laikā.
Plugins.MongoDB.Default.ReplicaSet no Noklusējuma repliku kopas nosaukums; tiek izmantots MongoDB repliku kopas mezglu automātiskai noteikšanai.

Ja šis parametrs tiek izmantots kopā ar shēmu mongodb+srv://, tas darbosies tā, it kā būtu norādīti vairāki URL; DNS serverim var būt TXT ieraksts, kas var pārrakstīt šo (vai jebkuru citu) parametru.
Nav pieejams, ja parametrs Plugins.MongoDB.Default.Direct ir iestatīts uz true, aģents neizdosies startēties.
Plugins.MongoDB.Default.ReadPreference no Noklusējuma secība savienojumam ar MongoDB repliku kopas mezgliem vai atkāpšanās gadījumā.

Atbalstītās vērtības: PrimaryMode, PrimaryPreferredMode, SecondaryMode, SecondaryPreferredMode un NearestMode.
Nav pieejams, ja parametrs Plugins.MongoDB.Default.Direct ir iestatīts uz true, aģents neizdosies startēties.
Plugins.MongoDB.Default.TLSConnect no Noklusējuma šifrēšanas veids saziņai starp Zabbix aģentu 2 un uzraudzītajām datubāzēm.

Atbalstītās vērtības:
required - pieprasa TLS savienojumu.
verify\_ca - pārbauda sertifikātus.
verify\_full - pārbauda sertifikātus un IP adresi.
Ja šeit, vienuma atslēgā, nosauktā sesijā vai URI nav norādīta neviena vērtība, TLS savienojums netiks izveidots.
Plugins.MongoDB.Default.TLSCAFile no Noklusējuma faila ceļš uz failu, kas satur augstākā līmeņa CA sertifikātus vienaudža sertifikāta pārbaudei. Izmanto šifrētai saziņai starp Zabbix aģentu 2 un uzraudzītajām datubāzēm.
Plugins.MongoDB.Default.TLSCertFile no Noklusējuma faila ceļš uz failu, kas satur MongoDB klienta sertifikātu vai sertifikātu ķēdi. Izmanto šifrētai saziņai starp Zabbix aģentu 2 un uzraudzītajām datubāzēm.
Plugins.MongoDB.Default.TLSKeyFile no Noklusējuma faila ceļš uz failu, kas satur MongoDB klienta privāto atslēgu, ko izmanto šifrētai saziņai starp Zabbix aģentu 2 un uzraudzītajām datubāzēm.

Skatiet arī: