14 Plugins

Vista general

Els connectors ofereixen una opció per ampliar les capacitats de monitoratge de Zabbix. Els connectors són escrits en llenguatge de programació Go i només són compatibles amb l'agent Zabbix 2.

Els connectors ofereixen una alternativa als mòduls carregables (escrits en C) i altres mètodes per ampliar la funcionalitat de Zabbix, com ara paràmeteres d'usuari (agent de mètriques), comprovacions externes (monitoratge sense agent) i l'element de l'agent Zabbix system.run[].

Les funcions següents són específiques de l'agent Zabbix 2 i els seus connectors:

  • suport per a intervals programats i flexibles per a controls passius i actius;
  • gestió de la cua de tasques pel que fa al temps i la concurrència de tasques;
  • temps d'espera a nivell de connector;
  • Comprovació de compatibilitat de l'agent Zabbix 2 i el seu connector a l'inici.

Des de Zabbix 6.0.0, els connectors no s'han d'integrar directament a l'agent 2 i es poden afegir com a connectors carregables, facilitant així el procés de creació de connectors addicionals per recollir noves mètriques de monitoratge.

Aquesta pàgina llista els connectors natius i carregables de Zabbix i es descriuen els principis de configuració de connectors des de la perspectiva de l'usuari. Per obtindre instruccions sobre com escriure els vostres propis connectors, consulteu les directrius de desenvolupament de connectors.

Configuració dels plugins

Aquesta secció proporciona principis comuns de configuració de pluginsi pràctiques recomanades.

Tots els pluginses configuren mitjançant el paràmetre Plugins.*, que pot formar part del fitxer de configuració de l'agent Zabbix 2 o el seu propi fitxer de configuració del plugin. Si un plugin empra un fitxer de configuració independent, el camí d'accés a aquest fitxer s'ha d'especificar al paràmetre inclòs del fitxer de configuració de l'agent Zabbix 2.

Cada paràmetre del plugin ha de tindre l'estructura següent:

Plugins.<PluginName>.<Parameter>=<Value>

A més, hi ha dos grups específics més de paràmetres:

-Plugins.<PluginName>.Default.<Parameter>=<Value> emprat per definir els valors del paràmetre per defecte.

-Plugins.<PluginName>.<SessionName>.<Parameter>=<Value> emprat per definir el joc de paràmetres separats per els objectius a monitorar via les sessions anomenades.

Els noms dels paràmetres han de complir els requisits següents:

  • es recomana posar en majúscula els noms dels vostres connectors;
  • el paràmetre ha d'ésser en majúscules;
  • no es permeten pas caràcters especials;
  • la nidificació no és pas limitada per un nivell màxim;
  • el nombre de paràmetres no és pas limitat.

Sessions anomenades

Les sessions amb nom representen un nivell addicional de configuració del connector i es poden emprar per definir conjunts separats de paràmetres d'autenticació per a cada instància monitorada. Cada paràmetre de sessió anomenada ha de tindre l'estructura següent:

Plugins.<PluginName>.Sessions.<SessionName>.<Parameter>=<Value>

Un nom de sessió es pot emprar com a paràmetre de clau d'element connString en lloc d'especificar un URI, un nom d'usuari i un mot de pas per separat. A les claus d'element, el primer paràmetre pot ésser un connString o un URI. Si el primer paràmetre clau coincideix amb un nom de sessió especificat al fitxer de configuració, la comprovació s'executarà mitjançant els paràmetres de sessió indicats. Si el primer paràmetre de clau no coincideix amb cap nom de sessió, es tractarà com a URI.

La llista dels paràmetres de sessions anomenades disponibles depenen del plugin.

A les versions de Zabbix anteriors a la 6.0.17, quan es proporcioni una connString (nom de sessió) als paràmetres clau, els paràmetres clau d'element per al nom d'usuari i el mot de pas han de ser buits. Els valors es prendran dels paràmetres de sessió. Si no s'especifica un paràmetre d'autenticació per a la sessió anomenada, s'emprarà un valor predeterminat codificat en cru.

Des de Zabbix 6.0.17, podeu substituir els paràmetres de sessió especificant nous valors als paràmetres clau de l'element. En aquest cas:

Des de Zabbix 6.0.18, si no es defineix un paràmetre per la sessió anomenada, l'agent 2 de Zabbix emprarà el valor definit al paràmetre per defecte del plugin.

Prioritat dels paràmetres

Des de la versió 6.4.3, els plugins de l'agent 2 de Zabbix cerquen els valors de paràmetres relatius a les connexions en l'ordre següent:

  1. El paràmetre clau del primer element es compara amb els noms de sessió. Si no es troba cap coincidència, es tractarà com un valor real; en aquest cas, s'ometrà el pas 3. Si es troba una coincidència, el valor del paràmetre (normalment, un URI) s'ha de definir a la sessió anomenada.
  2. Altres paràmetres es prendran de la clau d'element si està definit.
  3. Si un paràmetre de clau d'element (per exemple, mot de pas) és buit, el plugin cercarà el paràmetre de sessió corresponent.
  4. Si tampoc s'especifica el paràmetre de sessió, s'emprarà el valor definit al paràmetre predeterminat corresponent.
  5. Si tot falla, el plugin emprarà el valor predeterminat codificat en cru.
Exemple 1

Monitoratge de dues instàncies “MySQL1” i “MySQL2”.

Paràmetres de configuració:

Plugins.Mysql.Sessions.MySQL1.Uri=tcp://127.0.0.1:3306
       Plugins.Mysql.Sessions.MySQL1.User=mysql1_user
       Plugins.Mysql.Sessions.MySQL1.Password=unique_password
       Plugins.Mysql.Sessions.MySQL2.Uri=tcp://192.0.2.0:3306
       Plugins.Mysql.Sessions.MySQL2.User=mysql2_user
       Plugins.Mysql.Sessions.MySQL2.Password=different_password

Com a resultat d'aquesta configuració, cada nom de sessió es pot emprar com a connString a una clau d'element, com ara mysql.ping[MySQL1] o mysql .ping[MySQL2].

Exemple 2

Proporcionant alguns paràmetres a la clau d'element (admès des de Zabbix 6.0.17).

Paràmetres de configuració:

Plugins.Postgres.Sessions.Session1.Uri=tcp://192.0.2.234:5432
       Plugins.Postgres.Sessions.Session1.User=old_username
       Plugins.Postgres.Sessions.Session1.Password=session_password

Clau d'element: pgsql.ping[session1,new_username,,postgres]

Com a resultat de la configuració, l'agent es connectarà a PostgreSQL emprant els paràmetres següents:

  • Paràmetre URI de la sessió: 192.0.2.234:5432
  • Usuari de la clau d'element: new_username
  • Mot de pas del paràmetre de la sessió (des que s'ha omès a la clau d'element): session_password
  • Nom de la base de dades per la clau d'element: postgres
Exemple 3

Recollint una mètrica emprant els paràmetres de configuració per defecte. Paràmetres de configuració:

Plugins.Postgres.Default.Uri=tcp://192.0.2.234:5432
       Plugins.Postgres.Default.User=zabbix
       Plugins.Postgres.Default.Password=password

Clau d'element: pgsql.ping[,,,postgres]

Com a resultat de la configuració, l'agent es connectarà a PostgreSQL emprant els paràmetres següents:

  • URI per defecte: 192.0.2.234:5432
  • Usuari per defecte: zabbix
  • Mot de pas per defecte: password
  • Nom de la base de dades per la clau d'element: postgres
Valors per defecte

Des de Zabbix 6.0.18, podeu establir els valors per defecte per als paràmetres relatius a les connexions (URI, usuari, mot de pas, etc.) a l'arxiu de configuració, en aquest format:

Plugins.<PluginName>.Default.<Parameter>=<Value>

Per exemple, Plugins.Mysql.Default.Username=zabbix, Plugins.MongoDB.Default.Uri=tcp://127.0.0.1:27017, etc.

Si no es proporciona un valor de cada paràmetre a una clau d'element dels paràmetres de la sessió anomenada, el plugin emprarà el valor per defecte. Si algun paràmetre no s'ha definit, s'empraran els valors en brut.

Si una clau d'element no té paràmetres, l'agent 2 de Zabbix provarà a collir la mètrica emprant valors definits a la secció de paràmetres per defecte.

Connexions

Alguns connectors admeten la recollida de mètriques de diverses instàncies simultàniament. Es poden controlar tant les instàncies locals com les remotes. S'admeten tant les connexions de socket TCP com Unix.

Es recomana configurar connectors per mantindre les connexions d'instància en estat obert. Els avantatges són la reducció de la congestió de la xarxa, la latència i l'ús de la CPU i la memòria a causa de menys connexions. La biblioteca del client s'encarrega d'això.

Es pot determinar quant de temps han de romandre obertes les connexions no emprades mitjançant Plugins.<PluginName>.KeepAlive.
Exemple: Plugins.Memcached.KeepAlive

Plugins

Totes les mètriques admeses per l'agent Zabbix 2 són recollides per els plugins.

Per defecte

Els connectors següents per a l'agent Zabbix 2 són disponibles de manera immediata. Feu clic al nom del connector per accedir al repositori de connectors amb informació addicional.

Nom del connector Descripció Claus dels elements compatibles Comentaris
Agent Mètrica de l'agent Zabbix emprat. agent.hostname, agent.ping, agent.version Les claus admeses tenen els mateixos paràmetres que keys de l'agent Zabbix.
Ceph Monitoratge de Ceph. ceph.df.details, ceph.osd.stats, ceph.osd.discovery, ceph.osd.dump,
ceph.ping, ceph.pool.discovery, ceph.status
CPU Monitoratge del processador del sistema (nombre de processadors/nuclis de processador, processadors descoberts, percentatge d'ús). system.cpu.discovery, system.cpu.num, system.cpu.util Les claus admeses tenen els mateixos paràmetres que keys de l'agent Zabbix.
Docker Monitoratge de contenidors Docker. docker.container_info, docker.container_stats, docker.containers, docker.containers.discovery,
docker.data_usage, docker.images, docker.images.discovery, docker.info, docker.ping
Veieu també:
Paràmetres de configuració
Fitxer Recolliu mètriques de fitxers. vfs.file.cksum, vfs.file.contents, vfs.file.exists, vfs.file.md5sum,
vfs.file.regexp, vfs.file.regmatch, vfs.file.size, vfs.file.time
Les claus admeses tenen la mateixa configuració que les keys de l'agent Zabbix.
Nucli Suport del nucli. kernel.maxfiles, kernel.maxproc Les claus preses tenen suport la mateixa configuració que keys de l'agent Zabbix.
Registre Monitoratge de fitxers de registre. log, log.count, logrt, logrt.count Les claus admeses tenen els mateixos paràmetres que keys de l'agent Zabbix.

Veieu també:
Connexió de paràmetres de configuració (Unix/Windows)
Memcached Monitoratge del servidor Memcached. memcached.ping, memcached.statistics
Modbus Llegeix dades de Modbus. modbus.get Les claus admeses tenen els mateixos paràmetres que l'agent Zabbix keys.
MQTT Obté els valors publicats dels temes MQTT. mqtt.get
MySQL Monitorització de MySQL i les seves bifurcacions. mysql.db.discovery , mysql.db.size, mysql.get_status_variables,
mysql.ping, mysql.replication.discovery, mysql.replication.get_slave_status, mysql.version
Per configurar una connexió xifrada a la base de dades, empreu sessions anomenades i especifiqueu els paràmetres TLS per a la sessió anomenada al fitxer de configuració de l'agent. Actualment, els paràmetres TLS no es poden passar com a paràmetres clau d'element.
NetIf Monitorització d'interfícies de xarxa. net.if.collisions, net.if.discovery, net.if.in, net.if.out, net.if.total Les claus admeses tenen els mateixos paràmetres que keys Agent Zabbix.
Oracle Monitoratge de bases de dades Oracle. oracle.diskgroups.stats, oracle.diskgroups.discovery, oracle.archive.info, oracle.archive.discovery,
oracle.cdb.info, oracle.custom.query, oracle.datafiles.stats, oracle.db.discovery,
oracle.fra.stats, oracle.instance.info, oracle.pdb.info, oracle.pdb.discovery,
oracle.pga.stats, oracle.ping, oracle.proc.stats, oracle.redolog.info,
oracle.sga.stats, oracle.sessions.stats, oracle.sys.metrics, oracle.sys.params,
oracle.ts.stats, oracle.ts.discovery, oracle.user.info, oracle.version
Instal·la l'[Oracle Instant Client] (https://www.oracle.com/database/technologies/instant-client/downloads.html) abans d'emprar el connector.
Proc Percentatge d'ús de la CPU del procés. proc.cpu.util Les claus admeses tenen la mateixa configuració que keys de l'agent Zabbix.
Redis Monitoratge del servidor Redis. redis.config, redis.info, redis.ping, redis.slowlog.count
Smart Monitorització S.M.A.R.T. smart.attribute.discovery, smart.disk.discovery, smart.disk.get La versió mínima necessària de smartctl és la 7.1.
Els drets d'accés sudo/root a smartctl són necessaris per a l'usuari que executi l'agent Zabbix 2. El plugin empra només les següents comandes:
/usr/sbin/smartctl -a *
/usr/sbin/smartctl --scan *
/usr/sbin/smartctl -j -V

Les claus admeses només es poden emprar amb l'agent Zabbix 2 a Linux/Windows, tant com a comprovació passiva com activa.
Veieu també:
Paràmetres de onfiguració
Swap Intercanvi de la mida de l'espai en octets/percentatge. system.swap.size Les claus admeses tenen els mateixos paràmetres que l'agent Zabbix keys.
SystemRun Executa l'ordre especificada. system.run Les claus admeses tenen els mateixos paràmetres que l'agent Zabbix keys.

Veieu també:
Paràmetres de configuració del connector (Unix/Windows)
Systemd Monitoratge de serveis de systemd. systemd.unit.discovery, systemd.unit.get, systemd.unit.info
TCP Comprovació de la disponibilitat de connexió TCP. port net.tcp. Claus admeses tenen la mateixa configuració que l'agent Zabbix keys.
UDP Monitoratge de la disponibilitat i el rendiment dels serveis UDP. net.udp.service, net.udp.service.perf Les claus admeses tenen els mateixos paràmetres que l'agent Zabbix keys.
Uname Obtenció d'informació del sistema. system.hostname, system.sw.arch, system.uname Les claus admeses tenen la mateixa configuració que l'agent Zabbix keys.
Uptime Recuperació d'informació sobre la recopilació de mètriques de temps d'activitat del sistema. system.uptime Admet les claus tenen la mateixa configuració que l'agent Zabbix keys.
VFSDev Recollida de mètriques VFS. vfs.dev.discovery, vfs.dev.read, vfs.dev.write Les claus admeses tenen els mateixos paràmetres que l'agent Zabbix keys.
WebCertificate Monitoratge del certificat del lloc web TLS/SSL. web.certificate.get
Pàgina web Monitoratge de pàgines web. web.page.get, web.page.perf, web.page.regexp Les claus admeses tenen els mateixos paràmetres que l'agent Zabbix keys.
ZabbixAsync Recollida de mètriques asíncrones. net.tcp.listen, net.udp.listen, sensor, system.boottime, system.cpu.intr, system.cpu.load,
system.cpu.switches, system.hw.cpu, system.hw.macaddr, system.localtime, system.sw.os,
system.swap.in, system.swap.out, vfs.fs.discovery
Les claus admeses tenen els mateixos paràmetres que keys de l'agent Zabbix.
ZabbixStats Mètrica interna del servidor Zabbix/proxy o nombre d'elements retardats en una cua . zabbix.stats Les claus admeses tenen els mateixos paràmetres que l'agent Zabbix claus.
ZabbixSync Recollida de mètriques síncrones. net.dns, net.dns.record, net.tcp.service, net.tcp.service.perf, proc.mem,
proc.num, system.hw.chassis, system.hw.devices, system.sw.packages,
system.users.num, vfs.dir.count, vfs.dir.size, vfs.fs

Carregable

Connectors carregables, quan s'inicien amb:
- -V --version - mostra la versió del connector i la informació de la llicència;
- -h --help - mostra informació d'ajuda.

Feu clic al nom del connector per accedir al repositori de connectors amb informació addicional.

Nom del connector Descripció Claus d'elements admesos Comentaris
Ember+ Monitoratge d'Ember+. ember.get Aquest plugin s'admet des de Zabbix 6.0.30. Actualment només és disponible si es compila des de la font (tant per a Unix com per a Windows).

Veieu també paràmetres de configuració del plugin d'Ember+.
MongoDB Servidor MongoDB i monitoratge del clúster (document distribuït base de dades basada en -). mongodb.collection.stats, mongodb.collections.discovery, mongodb.collections.usage, mongodb.connpool.stats, mongodb.jumbo_chunks.count, mongodb.oplog.stats,
mongodb.ping, mongodb.rs.config, mongodb.rs.status, mongodb.server.status,
mongodb.sh.discovery, mongodb.version
Aquest connector es pot carregar des de Zabbix 6.0.6 (anteriorment integrat). Els binaris de plugins precompilats per windows són disponibles des de Zabbix 6.0.19 i són compatibles amb les versions anteriors a la 6.0.

Per configurar connexions de base de dades xifrades, empreu named-sessions i especifiqueu els paràmetres TLS per a la sessió anomenada al fitxer de configuració de l'agent.
Admet les versions del connector 1.2.1, 6.0.13 i posteriors^ 1^.
Actualment, els paràmetres TLS no es poden passar com a paràmetres clau d'element.

Veieu també el fitxer de configuració del connector MongoDB.
MSSQL Monitoratge d'una base de dades MSSQL. mssql.availability.group.get, mssql.custom.query, mssql.db.get, mssql.job.status.get, mssql.last.backup.get, mssql.local.db.get, mssql.mirroring.get, mssql.nonlocal.db.get, mssql.perfcounter.get, mssql.ping, mssql.quorum.get, mssql.quorum.member.get, mssql.replica.get, mssql.version Aquest plugin s'admet des de Zabbix 6.0.27. Els binaris de plugins precompilats per a Windows són disponibles des de Zabbix 6.0.28 i són compatibles amb la versió 6.0.27.

Per configurar connexió xifrada a la base de dades, especifiqueu els paràmetres TLS a l'arxiu de configuració de l'agent, paràmetres sessió anomenada o per defecte. Actualment, els paràmetres TLS no es poden passar com a paràmetres de clau d'element.

Veieu també els paràmetres de configuració del plugin d'MSSQL.
PostgreSQL Monitoratge de PostgreSQL i les seves bifurcacions. pgsql.autovacuum.count, pgsql.archive, pgsql.bgwriter, pgsql.cache.hit, pgsql.connections,
pgsql.custom.query, pgsql.dbstat, pgsql.dbstat.sum, pgsql.db.age, plsql.db.bloating_tables,
pgsql.db.discovery, pgsql.db.size, pgsql.locks, pgsql.oldest.xid, pgsql.ping, pgsql.queries,
pgsql.replication.count, pgsql.replication.process, pgsql.replication.process.discovery, pgsql.replication.recovery_role, pgsql.replication.status,
pgsql.replication_lag.b, pgsql.replication_lag.sec., pgsql.uptime, pgsql.version, pgsql.wal.stat
Aquest connector es pot carregar des de Zabbix 6.0.10 (anteriorment inclòs). Els binaris de plugins precompilats per a Windows són disponibles des de Zabbix 6.0.19 i són compatibles amb les versions anteriors a la 6.0.

Per configurar connexions de base de dades xifrades, empreu named-sessions i especifiqueu la configuració de TLS per la sessió anomenada al fitxer de configuració dels agents. Actualment, els paràmetres TLS no es poden passar com a paràmetres clau d'element.

Veieu també: Creació de connectors carregables.

Nota al peu

1 - Des de Zabbix 6.0.13, els plugins carregables han començat a emprar el mateix sistema de versionat que el del Zabbix. Per això, la versió del plugin de MongoDB ha canviat d'1.2.0 a 6.0.13 i la versió del plugin de PostgreSQL ha canviat de la 1.2.1 a la 6.0.13.