6 MongoDB spraudnis

Pārskats

Zabbix aģenta 2 konfigurācijas fails tiek izmantots spraudņu konfigurēšanai. Šie Zabbix aģenta 2 konfigurācijas parametri tiek atbalstīti MongoDB spraudņa darbināšanai.

Ieteicams tos norādīt atsevišķā konfigurācijas failā (piemēram, mongo.conf) un pēc tam izmantot Include direktīvu, lai pievienotu šo failu Zabbix aģenta 2 konfigurācijai.

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

Ņemiet vērā:

  • Noklusējuma vērtības atspoguļo procesa noklusējuma vērtības, nevis piegādātajos konfigurācijas failos norādītās vērtības.
  • 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ā.

Opcijas

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

Parametri

Pieslēdzoties MongoDB, spraudnis pārbauda savu konfigurāciju noteiktā secībā, kas nosaka, kuru vērtību izmantot. 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 ? parametrā 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 nosauktajā 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 savienojuma autentificēšanai ar MongoDB serveri norādāt datubāzi parametrā *.<SessionName>.Uri (piemēram, Plugins.MongoDB.Sessions.<session_name>.Uri=mongodb://user:[email protected]:27017/?authSource=admin), tad spraudnis uzskatīs, ka parametrs *.<SessionName>.AuthSource ir iestatīts uz admin, pat ja parametrs *.<SessionName>.AuthSource ir iestatīts uz citu vērtību.
  • Ja norādāt URI parametrā *.<SessionName>.Uri (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 Plugins.MongoDB.Sessions.<SessionName>.User un Plugins.MongoDB.Sessions.<SessionName>.Password ir konfigurēti.

Ja tiek izmantota shēma mongodb+srv://, URI var iegūt parametrus no DNS TXT ieraksta. Parametri, kas iegūti no šī TXT ieraksta, ignorē visas pārējās konfigurācijas, tostarp URI parametrus, Zabbix aģenta 2 vienuma atslēgas parametrus un sesijas parametrus.
Savienojuma virknē izmantotajam resursdatora nosaukumam drīkst pastāvēt tikai viens TXT ieraksts.

Parameter Mandatory Range Default Description
Plugins.MongoDB.System.Path no Ceļš uz MongoDB spraudņa izpildāmo failu.
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 pieprasījuma pabeigšanu pirms tā pārtraukšanas).
Plugins.MongoDB.KeepAlive no 60-900 300 Maksimālais gaidīšanas laiks (sekundēs), pēc kura neizmantotie spraudņa savienojumi tiek aizvērti.
Plugins.MongoDB.Sessions.<SessionName>.Uri no tcp://127.0.0.1:27017 Nosauktās sesijas savienojuma virkne.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu atslēgās.

Jāatbilst URI formātam.
Atbalstītās shēmas: mongodb:// un mongodb+srv://; shēma tcp:// ir novecojusi un tiek saglabāta atpakaļsaderī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 vienumu atslēgās.
Plugins.MongoDB.Sessions.<SessionName>.Password no Nosauktās sesijas parole.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu atslēgās.
Plugins.MongoDB.Sessions.<SessionName>.Direct no false Savienojuma metode, ko izmanto, lai noteiktu, vai automātiskā MongoDB repliku kopas mezglu atklāšana ir jāiespējo vai jāatspējo.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu atslēgās.

Atbalstītās vērtības:
true - spraudnis pieslēgsies tikai norādītajam serverim, ignorējot citus repliku kopas dalībniekus;
false - spraudnis automātiski atklās 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 pieslēgšanai MongoDB serverim.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu 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 savienojuma autentificēšanai ar MongoDB serveri.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu atslēgās.

Ja tiek izmantots autentifikācijas mehānisms MONGODB-X509, šis parametrs tiek automātiski iestatīts uz $external; tā mainīš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 atklāšanai.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu atslēgās.

Ja šis parametrs tiek izmantots 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 ignorēt šo (vai jebkuru citu) parametru.

Nav pieejams, ja parametrs Plugins.MongoDB.Sessions.<SessionName>.Direct ir iestatīts uz true; aģentu neizdosies palaist.
Plugins.MongoDB.Sessions.<SessionName>.ReadPreference no Secība pieslēgšanai MongoDB repliku kopas mezgliem vai atkāpšanās variants.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu 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ģentu neizdosies palaist.
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 vienumu 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 ceļš uz failu, kas satur augstākā līmeņa CA sertifikātu(-us) otras puses sertifikāta pārbaudei un tiek izmantots šifrētai saziņai starp Zabbix aģentu 2 un uzraudzītajām datubāzēm.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu atslēgās.
Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile is specified Pilns ceļš uz failu, kas satur aģenta sertifikātu vai sertifikātu ķēdi un tiek izmantots šifrētai saziņai starp Zabbix aģentu 2 un uzraudzītajām datubāzēm.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu atslēgās.
Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile yes, if Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile is specified Pilns 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 vienumu atslēgās.
Plugins.MongoDB.Default.Uri no tcp://127.0.0.1:27017 Noklusējuma URI pieslēgšanai MongoDB.

Jāatbilst URI formātam.
Atbalstītās shēmas: mongodb:// un mongodb+srv://.
Novecojusi shēma: tcp:// (izmantota kā noklusējuma vērtība atpakaļsaderī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 pieslēgšanai MongoDB.
Plugins.MongoDB.Default.Password no Noklusējuma parole pieslēgšanai MongoDB.
Plugins.MongoDB.Default.Direct no false Noklusējuma savienojuma metode, ko izmanto, lai noteiktu, vai automātiskā MongoDB repliku kopas mezglu atklāšana ir jāiespējo vai jāatspējo.

Atbalstītās vērtības:
true - spraudnis pieslēgsies tikai norādītajam serverim, ignorējot citus repliku kopas dalībniekus;
false - spraudnis automātiski atklās 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 pieslēgšanai MongoDB serverim.

Atbalstītās vērtības: SCRAM-SHA-1, SCRAM-SHA-256 un MONGODB-X509.
Ja vērtība nav norādīta ne šeit, ne vienuma atslēgā, ne nosauktajā sesijā, ne URI, 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 autentificēšanai ar MongoDB serveri.

Ja tiek izmantots autentifikācijas mehānisms MONGODB-X509, šis parametrs tiek automātiski iestatīts uz $external; tā mainīš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 atklāšanai.

Ja šis parametrs tiek izmantots 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 ignorēt šo (vai jebkuru citu) parametru.
Nav pieejams, ja parametrs Plugins.MongoDB.Default.Direct ir iestatīts uz true; aģentu neizdosies palaist.
Plugins.MongoDB.Default.ReadPreference no Noklusējuma secība pieslēgšanai MongoDB repliku kopas mezgliem vai atkāpšanās variants.

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ģentu neizdosies palaist.
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 vērtība nav norādīta ne šeit, ne vienuma atslēgā, ne nosauktajā sesijā, ne URI, TLS savienojums netiks izveidots.
Plugins.MongoDB.Default.TLSCAFile no Noklusējuma ceļš uz failu, kas satur augstākā līmeņa CA sertifikātu(-us) otras puses sertifikāta pārbaudei. Tiek izmantots šifrētai saziņai starp Zabbix aģentu 2 un uzraudzītajām datubāzēm.
Plugins.MongoDB.Default.TLSCertFile no Noklusējuma ceļš uz failu, kas satur MongoDB klienta sertifikātu vai sertifikātu ķēdi. Tiek izmantots šifrētai saziņai starp Zabbix aģentu 2 un uzraudzītajām datubāzēm.
Plugins.MongoDB.Default.TLSKeyFile no Noklusējuma ceļš uz failu, kas satur MongoDB klienta privāto atslēgu un tiek izmantots šifrētai saziņai starp Zabbix aģentu 2 un uzraudzītajām datubāzēm.

Skatiet arī: