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 plugin repository.

Ņ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 tikai konfigurācijas failus 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ātā forma).
-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 pēc ? parametrā Plugins.MongoDB.Sessions.<session_name>.Uri, ir ar visaugstāko prioritāti).
  2. Parametri Zabbix aģents 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 norādāt datubāzi savienojuma ar MongoDB serveris autentificēšanai 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 norādāt lietotājvārdu un paroli Zabbix aģents 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ģents 2 vienuma atslēgas parametrus un sesijas parametrus.
Savienojuma virknē izmantotajam resursdatora nosaukumam drīkst būt tikai viens TXT ieraksts.

Parametrs Obligāts Diapazons Noklusējums Apraksts
Plugins.MongoDB.System.Path Ceļš uz MongoDB spraudņa izpildāmo failu.
Piemērs: Plugins.MongoDB.System.Path=/usr/libexec/zabbix/zabbix-agent2-plugin-mongodb
Plugins.MongoDB.Timeout 1-30 globālais taimauts Pieprasījuma izpildes taimauts (ilgums sekundēs, cik ilgi gaidīt pieprasījuma pabeigšanu pirms tā pārtraukšanas).
Plugins.MongoDB.KeepAlive 60-900 300 Maksimālais gaidīšanas laiks (sekundēs), pirms tiek aizvērti neizmantotie spraudņa savienojumi.
Plugins.MongoDB.Sessions.<SessionName>.Uri tcp://127.0.0.1:27017 Nosauktas 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 Nosauktas sesijas lietotājvārds.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu atslēgās.
Plugins.MongoDB.Sessions.<SessionName>.Password Nosauktas sesijas parole.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu atslēgās.
Plugins.MongoDB.Sessions.<SessionName>.Direct false Savienojuma metode, ko izmanto, lai noteiktu, vai MongoDB repliku kopas mezglu automātiskā 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 serveris, 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 Autentifikācijas mehānisms pieslēgšanai MongoDB serveris.
<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 admin Datubāze savienojuma ar MongoDB serveris autentificēšanai.
<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ā maiņa uz jebkuru citu vērtību izraisīs kļūdu palaišanas laikā.
Plugins.MongoDB.Sessions.<SessionName>.ReplicaSet 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 serveris var saturēt TXT ierakstu, kas var ignorēt šo (vai jebkuru citu) parametru.

Nav pieejams, ja parametrs Plugins.MongoDB.Sessions.<SessionName>.Direct ir iestatīts uz true; aģents nevarēs startēt.
Plugins.MongoDB.Sessions.<SessionName>.ReadPreference 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ģents nevarēs startēt.
Plugins.MongoDB.Sessions.<SessionName>.TLSConnect Šifrēšanas veids saziņai starp Zabbix aģents 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 jā, ja Plugins.MongoDB.Sessions.<SessionName>.TLSConnect ir iestatīts uz vienu no: verify_ca, verify_full Pilns ceļš uz failu, kas satur augstākā līmeņa CA sertifikātus vienādranga sertifikāta pārbaudei un tiek izmantots šifrētai saziņai starp Zabbix aģents 2 un uzraudzītajām datubāzēm.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu atslēgās.
Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile jā, ja ir norādīts Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile Pilns ceļš uz failu, kas satur aģenta sertifikātu vai sertifikātu ķēdi un tiek izmantots šifrētai saziņai starp Zabbix aģents 2 un uzraudzītajām datubāzēm.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu atslēgās.
Plugins.MongoDB.Sessions.<SessionName>.TLSKeyFile jā, ja ir norādīts Plugins.MongoDB.Sessions.<SessionName>.TLSCertFile Pilns ceļš uz failu, kas satur datubāzes privāto atslēgu, kura tiek izmantota šifrētai saziņai starp Zabbix aģents 2 un uzraudzītajām datubāzēm.
<SessionName> - definē sesijas nosaukumu izmantošanai vienumu atslēgās.
Plugins.MongoDB.Default.Uri 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 Noklusējuma lietotājvārds pieslēgšanai MongoDB.
Plugins.MongoDB.Default.Password Noklusējuma parole pieslēgšanai MongoDB.
Plugins.MongoDB.Default.Direct false Noklusējuma savienojuma metode, ko izmanto, lai noteiktu, vai MongoDB repliku kopas mezglu automātiskā atklāšana ir jāiespējo vai jāatspējo.

Atbalstītās vērtības:
true - spraudnis pieslēgsies tikai norādītajam serveris, 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 Noklusējuma autentifikācijas mehānisms pieslēgšanai MongoDB serveris.

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 nosauktā 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 admin Noklusējuma datubāze savienojuma ar MongoDB serveris autentificēšanai.

Ja tiek izmantots autentifikācijas mehānisms MONGODB-X509, šis parametrs tiek automātiski iestatīts uz $external; tā maiņa uz jebkuru citu vērtību izraisīs kļūdu palaišanas laikā.
Plugins.MongoDB.Default.ReplicaSet 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 serveris var saturēt TXT ierakstu, kas var ignorēt šo (vai jebkuru citu) parametru.
Nav pieejams, ja parametrs Plugins.MongoDB.Default.Direct ir iestatīts uz true; aģents nevarēs startēt.
Plugins.MongoDB.Default.ReadPreference 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ģents nevarēs startēt.
Plugins.MongoDB.Default.TLSConnect Noklusējuma šifrēšanas veids saziņai starp Zabbix aģents 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 nosauktā sesijā, ne URI, TLS savienojums netiks izveidots.
Plugins.MongoDB.Default.TLSCAFile Noklusējuma ceļš uz failu, kas satur augstākā līmeņa CA sertifikātus vienādranga sertifikāta pārbaudei. Tiek izmantots šifrētai saziņai starp Zabbix aģents 2 un uzraudzītajām datubāzēm.
Plugins.MongoDB.Default.TLSCertFile Noklusējuma ceļš uz failu, kas satur MongoDB klienta sertifikātu vai sertifikātu ķēdi. Tiek izmantots šifrētai saziņai starp Zabbix aģents 2 un uzraudzītajām datubāzēm.
Plugins.MongoDB.Default.TLSKeyFile Noklusējuma ceļš uz failu, kas satur MongoDB klienta privāto atslēgu un tiek izmantots šifrētai saziņai starp Zabbix aģents 2 un uzraudzītajām datubāzēm.

Skatiet arī: