Documentation
Table of Contents
1 Módulos cargables
Descripción general
Los módulos cargables ofrecen una opción orientada al rendimiento para ampliar la funcionalidad de Zabbix.
Puede extender la funcionalidad de Zabbix de muchas maneras, por ejemplo, con parámetros de usuario, comprobaciones externas, y métricas del agente Zabbix system.run[] . Funcionan muy bien, pero tienen un gran inconveniente, llamado fork(). Zabbix tiene que bifurcar un nuevo proceso cada vez que maneja una métrica de usuario, lo cual no es bueno para el rendimiento. Normalmente no es gran cosa, sin embargo podría ser un problema grave al monitorear sistemas integrados, tener una gran cantidad de parámetros monitoreados o scripts pesados con lógica compleja o tiempo de inicio prolongado.
El soporte de módulos cargables ofrece formas de ampliar el agente Zabbix, el servidor y el proxy sin sacrificar el rendimiento.
Un módulo cargable es básicamente una biblioteca compartida utilizada por el demonio Zabbix. y cargado al inicio. La biblioteca debe contener ciertas funciones, por lo que qun proceso Zabbix puede detectar que el archivo es de hecho un módulo que puede cargar y con el que puede trabajar.
Los módulos cargables tienen una serie de beneficios. Un gran rendimiento y la capacidad de implementar cualquier lógica es muy importante, pero quizás la ventaja más importante es la capacidad de desarrollar, utilizar y compartir módulos Zabbix. Contribuye a un mantenimiento sin problemas y ayuda a entregar nuevas funcionalidades de forma más fácil e independiente del código base central de Zabbix.
La licencia y distribución de módulos en formato binario se rige por la licencia AGPL-3.0 (los módulos se vinculan con Zabbix en tiempo de ejecución y utilizan encabezados Zabbix ; todo el código Zabbix tiene licencia AGPL-3.0 desde Zabix 7.0). Zabbix no garantiza la compatibilidad binaria.
La estabilidad de la API del módulo está garantizada durante el ciclo de cada versión Zabbix LTS (Soporte a largo plazo). La estabilidad de la API de Zabbix no está garantizada (técnicamente, es posible llamar a las funciones internas de Zabbix desde un módulo, pero no hay garantía de que dichos módulos funcionen).
1 Módulo API
Para que una biblioteca compartida sea tratada como un módulo Zabbix, debe implementar y exportar varias funciones. Actualmente hay seis funciones en la API del módulo Zabbix, solo una de las cuales es obligatoria y los otros cinco son opcionales.
1.1 Interfaz obligatoria
La única función obligatoria es zbx_module_api_version():
Esta función debería devolver la versión de la API implementada por este módulo y para que el módulo se cargue, esta versión debe coincidir con una versión de API del módulo compatible con Zabbix. La versión de la API del módulo compatible con Zabbix es ZBX_MODULE_API_VERSION. Entonces esta función debería devolver esta constante. La antigua constante ZBX_MODULE_API_VERSION_ONE utilizada para este propósito ahora está definida para ser igual a ZBX_MODULE_API_VERSION para preservar compatibilidad de fuentes, pero no se recomienda su uso.
Interfaz opcional
Las funciones opcionales son zbx_module_init(), zbx_module_item_list(), zbx_module_item_timeout(), zbx_module_history_write_cbs() y zbx_module_uninit():
Esta función debe realizar la inicialización necesaria para el módulo (si la hay). Si tiene éxito, debería devolver ZBX_MODULE_OK. De lo contrario debería devolver ZBX_MODULE_FAIL. En este último caso, Zabbix no comenzará.
Esta función debería devolver una lista de métricas admitidas por el módulo. Cada métrica se define en una estructura ZBX_METRIC, consulte la sección siguiente para más detalles. La lista termina con una estructura ZBX_METRIC con el campo "key" a NULL.
Si el módulo exporta zbx_module_item_list() entonces esta función es utilizada por Zabbix para especificar la configuración de tiempo de espera en el archivo de configuración de Zabbix que deben obedecer las comprobaciones de métricas implementadas por el módulo. Aquí, el parámetro "timeout" está en segundos.
Esta función debería devolver funciones de callback que el servidor Zabbix utilizará para exportar el historial de diferentes tipos de datos. Se proporcionan funciones de devolución de llamada como campos de la estructura ZBX_HISTORY_WRITE_CBS, los campos pueden ser NULL si el módulo no está interesado en el historial de cierto tipo.
Esta función debe realizar la desinicialización necesaria (si corresponde) como liberar recursos asignados, cerrar descriptores de archivos, etc.
Todas las funciones se llaman una vez al iniciar Zabbix cuando el módulo está cargado, con la excepción de zbx_module_uninit(), que se llama una vez en Zabbix se apaga cuando se descarga el módulo.
Definición de métricas
Cada métrica se define en una estructura ZBX_METRIC:
Aquí, key es la clave de la métrica (por ejemplo, "dummy.random"), flags es ya sea CF_HAVEPARAMS o 0 (dependiendo de si la métrica acepta parámetros o no), function es una función de C que implementa la métrica (por ejemplo, "zbx_module_dummy_random") y test_param es la lista de parámetros que se utilizarán cuando el agente Zabbix se inicia con el parámetro "-p" (por ejemplo, "1,1000", puede ser NULL). Una definición de ejemplo puede verse así:
static ZBX_METRIC keys[] =
{
{ "dummy.random", CF_HAVEPARAMS, zbx_module_dummy_random, "1,1000" },
{ NULL }
}Cada función que implementa una métrica debe aceptar dos punteros como parámetros, el primero de tipo AGENT_REQUEST y el segundo de tipo AGENT_RESULT:
int zbx_module_dummy_random(AGENT_REQUEST *request, AGENT_RESULT *result)
{
...
SET_UI64_RESULT(result, from + rand() % (to - from + 1));
return SYSINFO_RET_OK;
}Estas funciones deberían devolver SYSINFO_RET_OK, si el valor de la métrica es obtenido con éxito. De lo contrario, deberían devolver SYSINFO_RET_FAIL. Consulte el módulo "ficticio" de ejemplo a continuación para obtener detalles sobre cómo obtener la información de AGENT_REQUEST y cómo configurar la información en AGENT_RESULT.
Proporcionar devoluciones de llamada de exportación del historial
La exportación del historial a través del módulo ya no es compatible por proxy Zabbix.
El módulo puede especificar funciones para exportar datos históricos por tipo: Numérico (flotante), numérico (sin signo), carácter, texto y registro:
typedef struct
{
void (*history_float_cb)(const ZBX_HISTORY_FLOAT *history, int history_num);
void (*history_integer_cb)(const ZBX_HISTORY_INTEGER *history, int history_num);
void (*history_string_cb)(const ZBX_HISTORY_STRING *history, int history_num);
void (*history_text_cb)(const ZBX_HISTORY_TEXT *history, int history_num);
void (*history_log_cb)(const ZBX_HISTORY_LOG *history, int history_num);
}
ZBX_HISTORY_WRITE_CBS;Cada uno de ellos debe tomar la matriz "history" de métricas "history_num" como argumentos. Dependiendo del tipo de datos del historial que se van a exportar, se denomina "historial". una serie de las siguientes estructuras, respectivamente:
typedef struct
{
zbx_uint64_t itemid;
int clock;
int ns;
double value;
}
ZBX_HISTORY_FLOAT;
typedef struct
{
zbx_uint64_t itemid;
int clock;
int ns;
zbx_uint64_t value;
}
ZBX_HISTORY_INTEGER;
typedef struct
{
zbx_uint64_t itemid;
int clock;
int ns;
const char *value;
}
ZBX_HISTORY_STRING;
typedef struct
{
zbx_uint64_t itemid;
int clock;
int ns;
const char *value;
}
ZBX_HISTORY_TEXT;
typedef struct
{
zbx_uint64_t itemid;
int clock;
int ns;
const char *value;
const char *source;
int timestamp;
int logeventid;
int severity;
}
ZBX_HISTORY_LOG;Las devoluciones de llamada serán utilizadas por los procesos de sincronización del historial del servidor Zabbix en el fin del procedimiento de sincronización del historial después de que los datos se escriban en la base de datos de Zabbix. y guardado en la caché de valores.
En caso de error interno en el módulo de exportación del historial, se recomienda que el módulo esté escrito de tal manera que no bloquee todo el seguimiento hasta que se recupere pero descarta los datos y permite que el servidor Zabbix continúe ejecutándose.
Construcción de módulos
Actualmente, los módulos están destinados a construirse dentro del árbol fuente de Zabbix, porque la API del módulo depende de algunas estructuras de datos que están definidas en los encabezados de Zabbix.
El encabezado más importante para los módulos cargables es include/module.h, que define estas estructuras de datos. Otros encabezados del sistema necesarios que ayuda a include/module.h para que funcione correctamente son stdlib.h y stdint.h.
Con esta información en mente, todo está listo para que el módulo sea construido. El módulo debe incluir stdlib.h, stdint.h y module.h, y el script de compilación debe asegurarse de que estos archivos estén en la ruta de inclusión. Consulte el módulo "ficticio" de ejemplo a continuación para obtener más detalles.
Otro encabezado útil es include/zbxcommon.h, que define la función zabbix_log(), que se puede utilizar para propósitos de registro y depuración.
Parámetros de configuración
El agente, servidor y proxy de Zabbix admiten dos parámetros para tratar los módulos:
- LoadModulePath: ruta completa a la ubicación de los módulos cargables
- LoadModule: módulo(s) que se cargarán al inicio. Los módulos deben estar ubicados en un directorio especificado por LoadModulePath o la ruta debe preceder al nombre del módulo. Si la ruta anterior es absoluta (comienza con '/') entonces se ignora LoadModulePath. Se permite incluir múltiples parámetros LoadModule.
Por ejemplo, para extender el agente Zabbix podríamos agregar los siguiente parámetros:
LoadModulePath=/usr/local/lib/zabbix/agent/
LoadModule=mariadb.so
LoadModule=apache.so
LoadModule=kernel.so
LoadModule=/usr/local/lib/zabbix/dummy.soAl iniciar el agente, cargará los módulos mariadb.so, apache.so y kernel.so del directorio /usr/local/lib/zabbix/agent mientras dummy.so se cargará desde /usr/local/lib/zabbix. El agente no podrá iniciarse si falta un módulo, en caso de permisos incorrectos o si una biblioteca compartida no es un módulo Zabbix.
Configuración de interfaz
Los módulos cargables son compatibles con el agente, servidor y proxy de Zabbix. Por lo tanto, el tipo de métrica en la interfaz de Zabbix depende de dónde se ha cargado el módulo. Si el módulo se ha cargado en el agente, entonces el tipo de métrica debe ser "agente Zabbix" o "agente Zabbix (activo)". Si el módulo se ha cargado en el servidor o proxy, entonces el tipo de métrica debe ser "Comprobación simple".
La exportación del historial a través de módulos Zabbix no necesita ninguna configuración en la interfaz. Si el módulo se carga exitosamente por el servidor y proporciona la función zbx_module_history_write_cbs() que devuelve al menos una función de devolución de llamada no NULL, entonces se exportará el historial habilitado automáticamente.
Módulo ficticio
Zabbix incluye un módulo de muestra escrito en lenguaje C. El módulo está ubicado en src/modules/dummy:
alex@alex:~trunk/src/modules/dummy$ ls -l
-rw-rw-r-- 1 alex alex 9019 Apr 24 17:54 dummy.c
-rw-rw-r-- 1 alex alex 67 Apr 24 17:54 Makefile
-rw-rw-r-- 1 alex alex 245 Apr 24 17:54 READMEEl módulo está bien documentado y puede usarse como plantilla para sus propios módulos.
Después de ejecutar ./configure en la raíz del árbol fuente de Zabbix como se ha descrito anteriormente, simplemente ejecute make para compilar dummy.so.
/*
** Zabbix
** Copyright (C) 2001-2020 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
#include <stdlib.h>
#include <string.h>
#include <time.h>
#include <stdint.h>
#include "module.h"
/* the variable keeps timeout setting for item processing */
static int item_timeout = 0;
/* module SHOULD define internal functions as static and use a naming pattern different from Zabbix internal */
/* symbols (zbx_*) and loadable module API functions (zbx_module_*) to avoid conflicts */
static int dummy_ping(AGENT_REQUEST *request, AGENT_RESULT *result);
static int dummy_echo(AGENT_REQUEST *request, AGENT_RESULT *result);
static int dummy_random(AGENT_REQUEST *request, AGENT_RESULT *result);
static ZBX_METRIC keys[] =
/* KEY FLAG FUNCTION TEST PARAMETERS */
{
{"dummy.ping", 0, dummy_ping, NULL},
{"dummy.echo", CF_HAVEPARAMS, dummy_echo, "a message"},
{"dummy.random", CF_HAVEPARAMS, dummy_random, "1,1000"},
{NULL}
};
/******************************************************************************
* *
* Function: zbx_module_api_version *
* *
* Purpose: returns version number of the module interface *
* *
* Return value: ZBX_MODULE_API_VERSION - version of module.h module is *
* compiled with, in order to load module successfully Zabbix *
* MUST be compiled with the same version of this header file *
* *
******************************************************************************/
int zbx_module_api_version(void)
{
return ZBX_MODULE_API_VERSION;
}
/******************************************************************************
* *
* Function: zbx_module_item_timeout *
* *
* Purpose: set timeout value for processing of items *
* *
* Parameters: timeout - timeout in seconds, 0 - no timeout set *
* *
******************************************************************************/
void zbx_module_item_timeout(int timeout)
{
item_timeout = timeout;
}
/******************************************************************************
* *
* Function: zbx_module_item_list *
* *
* Purpose: returns list of item keys supported by the module *
* *
* Return value: list of item keys *
* *
******************************************************************************/
ZBX_METRIC *zbx_module_item_list(void)
{
return keys;
}
static int dummy_ping(AGENT_REQUEST *request, AGENT_RESULT *result)
{
SET_UI64_RESULT(result, 1);
return SYSINFO_RET_OK;
}
static int dummy_echo(AGENT_REQUEST *request, AGENT_RESULT *result)
{
char *param;
if (1 != request->nparam)
{
/* set optional error message */
SET_MSG_RESULT(result, strdup("Invalid number of parameters."));
return SYSINFO_RET_FAIL;
}
param = get_rparam(request, 0);
SET_STR_RESULT(result, strdup(param));
return SYSINFO_RET_OK;
}
/******************************************************************************
* *
* Function: dummy_random *
* *
* Purpose: a main entry point for processing of an item *
* *
* Parameters: request - structure that contains item key and parameters *
* request->key - item key without parameters *
* request->nparam - number of parameters *
* request->params[N-1] - pointers to item key parameters *
* request->types[N-1] - item key parameters types: *
* REQUEST_PARAMETER_TYPE_UNDEFINED (key parameter is empty) *
* REQUEST_PARAMETER_TYPE_ARRAY (array) *
* REQUEST_PARAMETER_TYPE_STRING (quoted or unquoted string) *
* *
* result - structure that will contain result *
* *
* Return value: SYSINFO_RET_FAIL - function failed, item will be marked *
* as not supported by zabbix *
* SYSINFO_RET_OK - success *
* *
* Comment: get_rparam(request, N-1) can be used to get a pointer to the Nth *
* parameter starting from 0 (first parameter). Make sure it exists *
* by checking value of request->nparam. *
* In the same manner get_rparam_type(request, N-1) can be used to *
* get a parameter type. *
* *
******************************************************************************/
static int dummy_random(AGENT_REQUEST *request, AGENT_RESULT *result)
{
char *param1, *param2;
int from, to;
if (2 != request->nparam)
{
/* set optional error message */
SET_MSG_RESULT(result, strdup("Invalid number of parameters."));
return SYSINFO_RET_FAIL;
}
param1 = get_rparam(request, 0);
param2 = get_rparam(request, 1);
/* there is no strict validation of parameters and types for simplicity sake */
from = atoi(param1);
to = atoi(param2);
if (from > to)
{
SET_MSG_RESULT(result, strdup("Invalid range specified."));
return SYSINFO_RET_FAIL;
}
SET_UI64_RESULT(result, from + rand() % (to - from + 1));
return SYSINFO_RET_OK;
}
/******************************************************************************
* *
* Function: zbx_module_init *
* *
* Purpose: the function is called on agent startup *
* It should be used to call any initialization routines *
* *
* Return value: ZBX_MODULE_OK - success *
* ZBX_MODULE_FAIL - module initialization failed *
* *
* Comment: the module won't be loaded in case of ZBX_MODULE_FAIL *
* *
******************************************************************************/
int zbx_module_init(void)
{
/* initialization for dummy.random */
srand(time(NULL));
return ZBX_MODULE_OK;
}
/******************************************************************************
* *
* Function: zbx_module_uninit *
* *
* Purpose: the function is called on agent shutdown *
* It should be used to cleanup used resources if there are any *
* *
* Return value: ZBX_MODULE_OK - success *
* ZBX_MODULE_FAIL - function failed *
* *
******************************************************************************/
int zbx_module_uninit(void)
{
return ZBX_MODULE_OK;
}
/******************************************************************************
* *
* Functions: dummy_history_float_cb *
* dummy_history_integer_cb *
* dummy_history_string_cb *
* dummy_history_text_cb *
* dummy_history_log_cb *
* *
* Purpose: callback functions for storing historical data of types float, *
* integer, string, text and log respectively in external storage *
* *
* Parameters: history - array of historical data *
* history_num - number of elements in history array *
* *
******************************************************************************/
static void dummy_history_float_cb(const ZBX_HISTORY_FLOAT *history, int history_num)
{
int i;
for (i = 0; i < history_num; i++)
{
/* do something with history[i].itemid, history[i].clock, history[i].ns, history[i].value, ... */
}
}
static void dummy_history_integer_cb(const ZBX_HISTORY_INTEGER *history, int history_num)
{
int i;
for (i = 0; i < history_num; i++)
{
/* do something with history[i].itemid, history[i].clock, history[i].ns, history[i].value, ... */
}
}
static void dummy_history_string_cb(const ZBX_HISTORY_STRING *history, int history_num)
{
int i;
for (i = 0; i < history_num; i++)
{
/* do something with history[i].itemid, history[i].clock, history[i].ns, history[i].value, ... */
}
}
static void dummy_history_text_cb(const ZBX_HISTORY_TEXT *history, int history_num)
{
int i;
for (i = 0; i < history_num; i++)
{
/* do something with history[i].itemid, history[i].clock, history[i].ns, history[i].value, ... */
}
}
static void dummy_history_log_cb(const ZBX_HISTORY_LOG *history, int history_num)
{
int i;
for (i = 0; i < history_num; i++)
{
/* do something with history[i].itemid, history[i].clock, history[i].ns, history[i].value, ... */
}
}
/******************************************************************************
* *
* Function: zbx_module_history_write_cbs *
* *
* Purpose: returns a set of module functions Zabbix will call to export *
* different types of historical data *
* *
* Return value: structure with callback function pointers (can be NULL if *
* module is not interested in data of certain types) *
* *
******************************************************************************/
ZBX_HISTORY_WRITE_CBS zbx_module_history_write_cbs(void)
{
static ZBX_HISTORY_WRITE_CBS dummy_callbacks =
{
dummy_history_float_cb,
dummy_history_integer_cb,
dummy_history_string_cb,
dummy_history_text_cb,
dummy_history_log_cb,
};
return dummy_callbacks;
}The module exports three new items:
dummy.ping- always returns '1'dummy.echo[param1]- returns the first parameter as it is, for example,dummy.echo[ABC]will return ABCdummy.random[param1, param2]- returns a random number within the range of param1-param2, for example,dummy.random[1,1000000]
Limitaciones
La compatibilidad con módulos cargables se implementa únicamente para la plataforma Unix. Significa que no funciona para agentes de Windows.
En algunos casos, es posible que un módulo necesite leer la configuración relacionada con los parámetros del módulo de zabbix_agentd.conf. Actualmente no es compatible. Si necesita que su módulo use algunos parámetros de configuración debe probablemente implementar el análisis de un archivo de configuración específico del módulo.