14 Complementos

Descripción general

Los complementos brindan una opción para ampliar las capacidades de monitoreo de Zabbix. Los complementos están escritos en el lenguaje de programación Go y son compatibles únicamente con el agente 2 de Zabbix.

Los complementos proporcionan una alternativa a los módulos cargables (escritos en C), y otros métodos para ampliar la funcionalidad de Zabbix, como parámetros de usuario (métricas del agente), comprobaciones externas (monitoreo sin agente), y system.run[] métrica de agente elemento Zabbix.

Las siguientes características son específicas de Zabbix Agent 2 y sus complementos:

• soporte de intervalos programados y flexibles tanto para controles pasivos como para activos;
• gestión de colas de tareas con respecto a la programación y la simultaneidad de tareas;
• tiempos de espera a nivel de complemento;
• verificación de compatibilidad de Zabbix Agent 2 y su complemento al inicio.

Desde Zabbix 6.0.0, los complementos no tienen que integrarse directamente en el agente 2 y se pueden agregar como complementos cargables, lo que facilita el proceso de creación de complementos adicionales para recopilar nuevas métricas de monitoreo.

Esta página enumera los complementos nativos y cargables de Zabbix y describe los principios de configuración de los complementos desde la perspectiva del usuario. Para obtener instrucciones sobre cómo escribir sus propios complementos, consulte las [Pautas de desarrollo de complementos] (https://www.zabbix.com/documentation/guidelines/en/plugins). Para obtener más información sobre el proceso de comunicación entre el agente 2 de Zabbix y un complemento cargable, así como el proceso de recopilación de métricas, consulte el diagrama de conexión.

Configuración de complementos

Esta sección proporciona principios comunes de configuración de complementos y las mejores practicas

Todos los complementos se configuran usando el parámetro Plugins.*, que puede ser parte del archivo de configuración del agente 2 de Zabbix o del archivo de configuración del propio complemento. Si un complemento usa un archivo de configuración separado, la ruta a este archivo debe ser especificada en el parámetro Include del archivo de configuración del agente 2 de Zabbix.

Cada parámetro de complemento debe tener la siguiente estructura:

Plugins.<Nombre del complemento>.<Parámetro>=<Valor>

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

• Plugins.<Nombre del complemento>.Default.<Parámetro>=<Valor> utilizado para definir valores de parámetros predeterminados.

• Plugins.<Nombre del complemento>.<SessionName>.<Parameter>=<Value> se utiliza para definir conjuntos separados de parámetros para diferentes objetivos de monitoreo a través de sesiones con nombre.

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

• se recomienda poner en mayúscula los nombres de sus complementos;
• el parámetro debe estar en mayúscula;
• los caracteres especiales no están permitidos;
• el anidamiento no está limitado por un nivel máximo;
• el número de parámetros no está limitado.

Sesiones con nombre

Las sesiones con nombre representan un nivel adicional de parámetros del complemento y se pueden utilizar para especificar conjuntos separados de parámetros de autenticación para cada una de las instancias que se están monitoreando. Cada parámetro de sesión con nombre debe tener la siguiente estructura:

Plugins.<Nombre del complemento>.Sessions.<Nombre de la sesión>.<Parámetro>=<Valor>

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

En las claves de métricas, el primer parámetro puede ser un connString o una URI. si el primer parámetro clave no coincide con ningún nombre de sesión, será tratado como una URI. Tenga en cuenta que no se admite la inserción de credenciales en un URI; en su lugar, utilice parámetros de sesión con nombre.

La lista de parámetros de sesión con nombre disponibles depende del complemento.

En versiones de Zabbix anteriores a 6.0.17, cuando se proporciona una cadena de conexión (nombre de sesión) en los parámetros clave, los parámetros clave de la métrica para el nombre de usuario y la contraseña deben estar vacíos. Los valores se tomarán de los parámetros de la sesión. Si no se especifica un parámetro de autenticación para la sesión nombrada, se utilizará un valor predeterminado codificado.

Desde Zabbix 6.0.17, es posible anular los parámetros de la sesión especificando nuevos valores en los parámetros clave de la métrica (ver ejemplo).

Desde Zabbix 6.0.18, si no se define un parámetro para la sesión nombrada, el agente 2 de Zabbix utilizará el valor definido en el parámetro predeterminado del complemento.

Prioridad del parámetro

Desde la versión 6.0.18, los complementos del agente 2 Zabbix buscan valores de parámetros relacionados con la conexión en el siguiente orden:

1. El primer parámetro clave de la métrica se compara con los nombres de las sesiones. Si no se encuentra ninguna 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, un 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 clave de métrica (por ejemplo, contraseña) está vacío, el complemento buscará el parámetro de sesión con nombre correspondiente.
4. Si tampoco se especifica el parámetro de sesión, se utilizará el valor definido en el parámetro predeterminado correspondiente.
5. Si todo lo demás falla, el complemento utilizará el valor predeterminado codificado.

Ejemplo 1

Monitoreo 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=contraseña_única
       Plugins.Mysql.Sessions.MySQL2.Uri=tcp://192.0.2.0:3306
       Plugins.Mysql.Sessions.MySQL2.User=mysql2_user
       Plugins.Mysql.Sessions.MySQL2.Password=contraseña_diferente

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

Ejemplo 2

Proporcionar algunos de los parámetros en la clave de la métrica (compatible desde Zabbix 6.0.17).

Parámetros de configuración:

Plugins.PostgreSQL.Sessions.Session1.Uri=tcp://192.0.2.234:5432
       Plugins.PostgreSQL.Sessions.Session1.User=antiguo_nombre de usuario
       Plugins.PostgreSQL.Sessions.Session1.Password=contraseña_sesión

Clave de métrica: pgsql.ping[session1,nuevo_nombre de usuario,,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: nuevo_nombre de usuario
• Contraseña del parámetro de sesión (ya que se omite en la clave de la métrica): contraseña_sesión
• Nombre de la base de datos de la clave de la métrica: postgres

Ejemplo 3

Recopilar una métrica utilizando parámetros de configuración predeterminados.

Parámetros de configuración:

Plugins.PostgreSQL.Default.Uri=tcp://192.0.2.234:5432
       Plugins.PostgreSQL.Default.User=zabbix
       Plugins.PostgreSQL.Default.Password=contraseña

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

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

• URI predeterminado: 192.0.2.234:5432
• Nombre de usuario predeterminado: zabbix
• Contraseña predeterminada: contraseña
• Nombre de la base de datos de la clave de la métrica: postgres

Valores predeterminados

Desde Zabbix 6.0.18, 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. con 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 una clave de la métrica o en los parámetros de sesión nombrada, el complemento utilizará el valor predeterminado. Si un parámetro predeterminado tampoco está definido, se utilizarán valores predeterminados codificados.

Conexiones

Algunos complementos admiten la recopilación de métricas de múltiples instancias simultáneamente. Tanto las instancias locales como las remotas pueden ser monitoreadas. Se admiten conexiones de TCP y de socket Unix.

Se recomienda configurar complementos para mantener las conexiones a las instancias en estado abierto. Los beneficios son la reducción de la congestión de la red, la latencia, y uso de CPU y memoria debido a la menor cantidad de conexiones. La biblioteca del cliente se encarga de esto.

Complementos

Todas las métricas admitidas por el Agente 2 Zabbix se recopilan mediante complementos.

Built-in

The following plugins for Zabbix agent 2 are available out-of-the-box. Click on the plugin name to go to the plugin repository with additional information.

Loadable

Click on the plugin name to go to the plugin repository with additional information.

See also: Building loadable plugins.

Notas al pie

¹ - Desde Zabbix 6.0.13, los complementos cargables comenzaron a usar el mismo sistema de versiones que el propio Zabbix. Como resultado, la versión del complemento MongoDB ha cambiado de 1.2.0 a 6.0.13 y la versión del complemento PostgreSQL ha cambiado de 1.2.1 a 6.0.13.