Formación de agentes especiales

Como paso preparatorio, debes crear tres directorios, todos ellos ubicados en ~/local/lib/python3/cmk_addons/plugins/<plug-in_family>. El cuarto directorio que se muestra en el ejemplo siguiente es opcional: puede utilizarse para una comprobación basada en un agente.

¿Qué podría ser más adecuado como agente especial mínimo que una comprobación local que proporcione un servicio «Hello World!»? Incluso un sencillo script de shell que genere dos líneas de salida puede hacerlo:

No te olvides: el archivo debe ser ejecutable:

Esto asignará los permisos necesarios:

Ahora se ha creado una regla mínima:

El «name» hace referencia al nombre del agente especial, al que se le asigna el prefijo «agent_». Un agente configurado de esta manera estará disponible en «Other integrations». Sin embargo, su plantilla de configuración no contiene entradas debido a que «elements={}» está vacío.

Esta configuración combina el agente especial que se va a ejecutar con los ajustes obtenidos de la interfaz gráfica de usuario y los ajustes predeterminados. Estos ajustes se convierten ahora en parámetros de llamada. name vuelve a referirse al nombre del agente especial, al que se le añade el prefijo agent_.

Esto proporciona los requisitos básicos para el agente especial. Por supuesto, puedes añadir más información a estos en cualquier momento.

Una vez creados los archivos, comprueba primero si Checkmk puede validarlos:

A continuación, reinicia el servidor web del sitio:

Si quieres que la nueva regla sea visible en la búsqueda de inmediato, tendrás que reiniciar la base de datos en memoria Redis:

Si ahora abres Setup > Agents > Other integrations, deberías ver la nueva entrada «Hello special!» en la sección «Custom integrations».

Si no aparece, comprueba primero si has guardado todos los archivos en la ubicación indicada. Si buscas otras posibles causas de error, en las ediciones comerciales puedes hacerlo cómodamente a través de la administración de los paquetes de extensión de Checkmk. Como alternativa, hemos enumerado las causas de error más importantes y las posibles soluciones en el capítulo Solución de problemas.

Al igual que en el ejercicio anterior, primero crea los directorios necesarios, esta vez con el nombre ometemp en lugar de hellospecial.

Ahora que hay que procesar datos reales, también tendrás que pensar, por ejemplo, en el lenguaje de programación y el preprocesamiento. Nuestro ejercicio consulta una API pública y recibe datos JSON. Esto se podría hacer en el shell con un comando curl. Sin embargo, dado que Checkmk viene con un Python bien equipado, tiene sentido utilizarlo.

La siguiente decisión tiene que ver con el procesamiento de los datos. Por ejemplo, puedes simplemente pasar los datos JSON a la salida del agente o convertirlos a un formato de tabla en el agente especial. En la práctica, normalmente decidirás esto en función de tu entorno de trabajo: ¿Se ha tenido en cuenta la «división del trabajo» al desarrollar tu comprobación? ¿Los datos preparados simplifican el desarrollo del complemento de comprobación basado en el agente asociado? ¿O incluso lo hacen innecesario? Esto último ocurre si los datos se pueden preparar de tal manera que se puedan analizar con un complemento de comprobación ya existente.

Nuestro ejemplo simplemente reenvía la respuesta JSON. El análisis se lleva a cabo entonces en el complemento de comprobación basado en agente. La longitud y la latitud se introducen mediante los argumentos de línea de comandos --latitude y --longitude. Para poder leer mejor los argumentos de línea de comandos, utilizamos la biblioteca argparse. Dado que Open-Meteo admite la latitud y la longitud codificadas en la URL, basta con una URL con marcadores de posición. Prueba esta URL en el navegador con tu propia latitud y longitud.

La sección del agente ometemp solo contendrá el objeto JSON recibido. Prueba el agente especial ejecutándolo desde la línea de comandos.

Tu salida en la línea de comandos debería verse ahora algo así:

El siguiente paso es la configuración de reglas para el agente. Una vez completada, esta regla se mostrará en Setup > Agents > Other integrations, en la agrupación «Environmental».

Con esto, también se ha creado el agente especial. Después de comprobarlo en cmk-validate-plugins, reinicia el servidor web del sitio:

Ahora se podría crear una regla basada en este agente especial con Add rule: Open-Meteo temperature. Sin embargo, esta regla aún no servirá de mucho, ya que actualmente solo contiene los dos campos para introducir la longitud y la latitud.

A continuación, ampliamos el nuevo agente especial para que no solo contenga la longitud y la latitud, sino que también las procese. Nuestro objetivo final es obtener los valores de temperatura actuales para nuestra ubicación. Por lo tanto, la siguiente configuración combina el agente especial que se va a ejecutar con los ajustes obtenidos de la interfaz gráfica de usuario —es decir, de nuestra sección de reglas existente— y los ajustes de los estándares.

Los valores de longitud y latitud, que normalmente puedes especificar, se transfieren ahora al diccionario denominado «params». Al mismo tiempo, el objeto «host_config» contiene todos los ajustes específicos del host que se van a utilizar aquí. Por ejemplo, «host_config.primary_ip_config.address» te da acceso a la dirección IP principal, y «host_config.name» contiene el nombre del host.

Al transferir al agente especial, ten en cuenta que la llamada se realiza a través de un shell. Por lo tanto, la lista de parámetros de llamada solo puede contener cadenas de caracteres. Los ajustes se convierten entonces en parámetros de llamada que terminan en la lista command_arguments.

Para completar la información, aquí también te mostramos el complemento de verificación basado en agentes. El desarrollo de estos complementos se describe en detalle en el artículo sobre complementos de verificación basados en agentes.

Una diferencia con respecto al ejemplo mencionado en el artículo es la transferencia del JSON devuelto por la API REST: El complemento de verificación siempre recibe la sección del agente como una lista bidimensional («lista de listas») de cadenas. En primer lugar, usamos `itertools` para convertir esta lista bidimensional en una unidimensional. A continuación, concatenamos esta matriz resultante con espacios, lo que convierte toda la sección del agente en una sola cadena. Por último, nos aseguramos de sustituir las comillas simples por comillas dobles para poder cargar la cadena directamente como un objeto con `json.loads()`.

Siempre es buena idea ejecutar una validación con cmk-validate-plugins si has realizado cambios en elementos que se ejecutan dentro de los procesos de Checkmk. En este artículo, estos incluyen reglas, configuración de llamadas y complementos de comprobación.

Si solo has realizado cambios en la configuración de llamadas y en el propio agente especial, basta con generar una nueva configuración para el núcleo de monitorización y reiniciarlo. Esto se hace con el comando:

Si también has modificado reglas o complementos de comprobación, primero genera la configuración para el núcleo de monitorización y, a continuación, reinicia todo el sitio:

Los scripts descritos en este artículo para el agente especial, la configuración de reglas y la configuración de llamadas, cuando se utilizan en combinación con este complemento de comprobación, deberían proporcionarte ahora un servicio operativo en Checkmk:

Si el servicio Check_MK cambia repentinamente su estado a «WARN» o «CRIT» después de que se haya activado su agente especial, echa un vistazo a su Summary asociado.

Si el Summary indica una conexión con el nuevo agente especial, comprueba las propiedades del host. Debe seleccionarse el valor Configured API integrations and Checkmk agent para el parámetro Checkmk agent / API integrations.

Si tu agente especial no aparece (o ya no aparece) en Checkmk en «Setup > Agents > Other integrations», puede que haya un error en la configuración de la regla (rulesets/special_agent.py).

Si utilizas una de las ediciones comerciales, es posible que veas una advertencia en rojo al intentar editar la regla o crear una nueva. Sigue el enlace a la página de informes de errores. Allí se mostrará la posible causa del problema.

A continuación, consulta las descripciones de los errores:

Por ejemplo, recibirás un mensaje como este:

Comprueba la sintaxis de tu archivo `rulesets/special_agent.py`. Comprueba si se han tenido en cuenta todas las bibliotecas necesarias y si se han importado todas las variables. Comprueba si todas las sangrías son correctas y revisa toda la sintaxis.

También puede haber un problema en la configuración de la llamada o en el propio agente especial. Esto se hace evidente, por ejemplo, porque aparece una advertencia amarilla durante Activate changes.

Comprueba el archivo server_side_calls/special_agent.py siguiendo la información del mensaje de error. Si esto no resuelve el error, puedes volver a buscar mensajes de error en la línea de comandos:

Tras esperar un momento, obtendrás un resultado similar al siguiente (aquí abreviado para mayor claridad):

Las últimas líneas del resultado son especialmente interesantes: En el archivo server_side_calls/special_agent.py se está intentando acceder a un elemento del diccionario params que no existe.

Otra posible causa del error puede ser que el complemento de comprobación no esté generando ningún dato. Esto también se puede comprobar en la línea de comandos:

Si aquí recibes un mensaje de error en lugar de una cadena con los datos de medición actuales, utiliza el mensaje de error para corregirlo.