2 Plugins

Descripción general

Los plugins ofrecen una opción para ampliar las capacidades de monitorización de Zabbix. Los plugins están escritos en el lenguaje de programación Go y solo son compatibles con el agente Zabbix 2. Los plugins proporcionan una alternativa a los módulos cargables (escritos en C) y a otros métodos para ampliar la funcionalidad de Zabbix.

Las siguientes características son específicas del agente 2 y sus plugins:

• soporte de intervalos programados y flexibles tanto para comprobaciones pasivas como activas;
• gestión de la cola de tareas con respecto a la programación y concurrencia de tareas;
• tiempos de espera a nivel de plugin;
• comprobación de compatibilidad del agente Zabbix 2 y sus plugins al iniciar.

Desde Zabbix 6.0, los plugins no tienen que integrarse directamente en el agente 2 y pueden añadirse como plugins cargables, lo que facilita el proceso de creación de plugins adicionales para recopilar nuevas métricas de monitorización.

Esta página enumera los plugins nativos y cargables de Zabbix, y describe los principios de configuración de plugins desde la perspectiva del usuario.

Configuración de plugins

Esta sección proporciona los principios comunes de configuración de plugins y las mejores prácticas.

Todos los plugins se configuran utilizando el parámetro Plugins.* , que puede formar parte del archivo de configuración del agente Zabbix 2 o del propio archivo de configuración del plugin. Si un plugin utiliza un archivo de configuración separado, la ruta a este archivo debe especificarse en el parámetro Include del archivo de configuración del agente Zabbix 2.

Un parámetro típico de plugin tiene la siguiente estructura:

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

Además, existen dos grupos específicos de parámetros:

• Plugins.<PluginName>.Default.<Parameter>=<Value> utilizado para definir valores de parámetros por defecto.

• Plugins.<PluginName>.<SessionName>.<Parameter>=<Value> utilizado para definir conjuntos separados de parámetros para diferentes objetivos de monitorización mediante sesiones nombradas.

Todos los nombres de parámetros deben cumplir los siguientes requisitos:

• se recomienda escribir en mayúscula los nombres de los plugins;
• el parámetro debe estar en mayúscula;
• no se permiten caracteres especiales;
• la anidación no está limitada por un nivel máximo;
• el número de parámetros no está limitado.

Por ejemplo, para realizar comprobaciones activas que no tengan el intervalo de actualización Scheduling inmediatamente después del reinicio del agente solo para el plugin Uptime, establezca Plugins.Uptime.System.ForceActiveChecksOnStart=1 en el archivo de configuración. De manera similar, para establecer un límite personalizado para las comprobaciones concurrentes para el plugin CPU, establezca Plugins.CPU.System.Capacity=N en el archivo de configuración.

Valores predeterminados

Puede establecer valores predeterminados para los parámetros relacionados con la conexión (URI, nombre de usuario, contraseña, etc.) en el archivo de configuración en el formato:

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

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

Si no se proporciona un valor para dicho parámetro en la clave de la métrica o en los parámetros de la sesión nombrada, el plugin utilizará el valor predeterminado. Si un parámetro predeterminado tampoco está definido, se utilizarán los valores predeterminados codificados.

Sesiones nombradas

Las sesiones nombradas representan un nivel adicional de parámetros de plugin y pueden utilizarse para especificar conjuntos separados de parámetros de autenticación para cada una de las instancias que se están monitorizando. Cada parámetro de sesión nombrada debe tener la siguiente estructura:

Plugins.<NombreDelPlugin>.Sessions.<NombreDeLaSesion>.<Parámetro>=<Valor>

Un nombre de sesión puede utilizarse como parámetro de clave de métrica connString en lugar de especificar una URI, nombre de usuario y/o contraseña por separado.

En las claves de métrica, el primer parámetro puede ser una connString o una URI. Si el primer parámetro de la clave no coincide con ningún nombre de sesión, se tratará como una URI. Tenga en cuenta que no se admite el paso de credenciales URI incrustadas en la clave de la métrica, utilice parámetros de sesión nombrada en su lugar.

La lista de parámetros de sesión nombrada disponibles depende del plugin.

Es posible sobrescribir los parámetros de sesión especificando nuevos valores en los parámetros de la clave de la métrica (consulte el ejemplo).

Si un parámetro no está definido para la sesión nombrada, Zabbix agent 2 utilizará el valor definido en el parámetro de plugin por defecto.

Prioridad de los parámetros

Los plugins de Zabbix agent 2 buscan los valores de los parámetros relacionados con la conexión en el siguiente orden:

1. El primer parámetro de la clave de la métrica se compara con los nombres de sesión. Si no se encuentra coincidencia, se trata como un valor real; en este caso, se omitirá el paso 3. Si se encuentra una coincidencia, el valor del parámetro (normalmente, una URI) debe definirse en la sesión nombrada.
2. Otros parámetros se tomarán de la clave de la métrica si están definidos.
3. Si un parámetro de la clave de la métrica (por ejemplo, password) está vacío, el plugin buscará el parámetro correspondiente en la sesión nombrada.
4. Si el parámetro de la sesión tampoco está especificado, se utilizará el valor definido en el parámetro por defecto correspondiente.
5. Si todo lo demás falla, el plugin utilizará el valor por defecto codificado.

Ejemplo 1

Supervisión de dos instancias “MySQL1” y “MySQL2”.

Parámetros de configuración:

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

Como resultado de esta configuración, cada nombre de sesión puede utilizarse como un connString en una clave de métrica, por ejemplo, mysql.ping[MySQL1] o mysql.ping[MySQL2].

Ejemplo 2

Proporcionando algunos de los parámetros en la clave de la métrica.

Parámetros de configuración:

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

Clave de la métrica: pgsql.ping[session1,new_username,,postgres]

Como resultado de esta configuración, el agente se conectará a PostgreSQL utilizando los siguientes parámetros:

• URI del parámetro de sesión: 192.0.2.234:5432
• Nombre de usuario de la clave de la métrica: new_username
• Contraseña del parámetro de sesión (ya que se omite en la clave de la métrica): session_password
• Nombre de la base de datos de la clave de la métrica: postgres

Ejemplo 3

Recopilando una métrica utilizando los parámetros de configuración por defecto.

Parámetros de configuración:

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

Clave de la métrica: pgsql.ping[,,,postgres]

Como resultado de esta configuración, el agente se conectará a PostgreSQL utilizando los siguientes parámetros:

• URI por defecto: 192.0.2.234:5432
• Usuario por defecto: zabbix
• Contraseña por defecto: password
• Nombre de la base de datos de la clave de la métrica: postgres

Conexiones

Algunos plugins admiten la recopilación de métricas de varias instancias simultáneamente. Se pueden monitorizar tanto instancias locales como remotas. Se admiten conexiones TCP y Unix-socket.

Se recomienda configurar los plugins para mantener las conexiones a las instancias en un estado abierto. Los beneficios son la reducción de la congestión de red, la latencia y el uso de CPU y memoria debido al menor número de conexiones. La biblioteca cliente se encarga de esto.

Plugins

Todas las métricas soportadas por el agente Zabbix 2 son recolectadas por plugins.

Integrado

Los siguientes plugins para Zabbix agent 2 están disponibles de forma predeterminada. Haga clic en el nombre del plugin para ir al repositorio del plugin con información adicional.

Cargables

Los plugins cargables para Zabbix agent 2 no están disponibles por defecto y deben instalarse por separado:

• Para Linux, puede usar paquetes o compilar plugins.
• Para Windows, puede instalar desde MSI o compilar plugins.

Haga clic en el nombre del plugin para ir al repositorio del plugin con información adicional.