2 Complementos

Descripción general

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

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

• soporte de intervalos programados y flexibles tanto para comprobaciones pasivas como para las activas;
• 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 sus complementos 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 facilitando así 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 y tutoriales sobre cómo escribir sus propios complementos, consulte el Centro de desarrolladores.

Para obtener más información sobre el proceso de comunicación entre el agente Zabbix 2 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 y mejores prácticas de configuración de complementos comunes.

Todos los complementos se configuran usando el parámetro Plugins.*, que puede ser parte del archivo de configuración del agente Zabbix 2 o el archivo de configuración. del propio complemento Si un complemento 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 2 de Zabbix.

Un parámetro de complemento típico 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 predeterminados.

• Plugins.<PluginName>.<SessionName>.<Parameter>=<Value> se utiliza para definir conjuntos separados de parámetros para diferentes objetivos de monitoreo a través de [sesiones con nombre] (#named-sessions).

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

• se recomienda escribir 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.

Por ejemplo, para realizar comprobaciones activas que no tienen Programación intervalo de actualización inmediatamente después de que el agente se reinicie solo para el complemento Uptime, establezca Plugins.Uptime.System.ForceActiveChecksOnStart=1 en el archivo de configuración. De manera similar, para establecer un límite personalizado para comprobaciones simultáneas para el complemento de CPU, establezca Plugins.CPU.System.Capacity=N en el archivo de configuración.

Sesiones nombradas

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

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

Se puede utilizar un nombre de sesión como parámetro clave de la métrica connString en lugar de especificar un 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 un URI. Si el primer parámetro clave no coincide con ningún nombre de sesión, se tratará como un 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 las versiones de Zabbix 6.4.0-6.4.2, 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.4.2, 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.4.3, 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 del complemento predeterminado.

Parameter priority

Since version 6.4.3, Zabbix agent 2 plugins search for connection-related parameter values in the following order:

1. The first item key parameter is compared to session names. If no match is found it is treated as an actual value; in this case, step 3 will be skipped. If a match is found, the parameter value (usually, a URI) must be defined in the named session.
2. Other parameters will be taken from the item key if defined.
3. If an item key parameter (for example, password) is empty, plugin will look for the corresponding named session parameter.
4. If the session parameter is also not specified, the value defined in the corresponding default parameter will be used.
5. If all else fails, the plugin will use the hardcoded default value.

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.4.2).

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.4.3, 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.

Incorporados

Los siguientes complementos para el Agente 2 Zabbix están disponibles de fábrica. Haga clic en el nombre del complemento para ir al repositorio de complementos con información adicional.

Cargable

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

Ver también: Creación de complementos cargables.