DocumentaciónAyuda

Monitorear los valores de una API JSON

Consulta la API de un equipo (por ejemplo, los insumos de una impresora), mira su JSON y elige con un clic los valores que se monitorean, cada uno con su métrica y sus umbrales.

En esta página

Muchos equipos tienen una API que responde en JSON: impresoras (niveles de tinta o tóner), UPS, controladoras, sistemas propios. Una prueba API JSON consulta esa API, toma los valores que elijas y los deja como métricas del dispositivo: con su gráfico y su estado en la ficha del equipo en Infraestructura, como cualquier otro monitoreo.

Antes de empezar

  • Necesitas Administrar en Plugins para crear la prueba y Operar para asociarla a un equipo.

  • La consulta la hace la sonda de monitoreo (3.3.0 o superior) que monitorea el equipo. Solo se asocia a equipos que monitorea una sonda; el agente de un servidor y la nube de ARGUNIS no la corren.

  • Si la API pide un token o usuario y clave, créalos antes en la bóveda (Configuración → Monitoreo → Credenciales). Nunca se escriben en la prueba.

Pasos

  1. Entra a Configuración → Monitoreo → Pruebas de monitoreo y presiona Nueva prueba.

  2. Escribe el Nombre (por ejemplo, «Impresora HP · tintas»).

  3. En Plugin, elige API JSON: consultar un JSON y elegir sus valores (siempre la corre una sonda).

  4. En URL de la API, escribe la dirección con las macros del dispositivo, por ejemplo https://$HOSTADDRESS$/cdm/supply/v1/suppliesPublic. Así la misma prueba sirve para todas las impresoras de ese modelo.

  5. Si el equipo usa un certificado propio (lo normal en impresoras), marca Aceptar certificado propio del equipo.

  6. En Consultar, busca un Dispositivo de ejemplo que monitoree una sonda (y elige la Credencial si la API la pide) y presiona Consultar: la pide la sonda de ese dispositivo.

  7. Verás el JSON de la API. Junto a cada valor numérico presiona Monitorear: se agrega a la tabla de Valores que se monitorean con un nombre, su métrica y su ruta.

  8. En la tabla, ajusta el Nombre, la Unidad, si alerta cuando el valor baja de o sube de, y los umbrales de Aviso y Crítico. Por ejemplo, una tinta: «baja de», aviso 20 y crítico 10.

  9. Presiona Guardar.

Después asóciala a los equipos desde su ficha (Agregar desde el catálogo) o con una Crear una etiqueta de monitoreo.

En una lista (por ejemplo, la lista de insumos), ARGUNIS busca el elemento por su contenido y no por su posición: la ruta queda como suppliesList[supplyType=inkTank, supplyColorCode=K].percentLifeDisplay (el tanque de tinta negra). Si el equipo cambia el orden de la lista, el valor se sigue encontrando.

Qué pasa después

  • Cada valor es una métrica del monitoreo en la ficha del equipo, con su gráfico.

  • El estado del monitoreo es el peor de sus valores. Si la API no responde, no devuelve JSON o falta un valor, queda en crítico y el texto dice por qué.

  • Hasta 20 valores por prueba, una respuesta de hasta 1 MB y un intervalo de al menos 30 segundos.

  • Las peticiones POST, PUT, PATCH y DELETE pueden cambiar datos en el equipo: hay que confirmarlas al guardar.

Relacionado

Buscar en Argunis Monitoring

Escribe al menos 2 letras para buscar en Argunis Monitoring.

↑↓ moverse · Enter abrir · Esc cerrar