Health Check

Owned by Onesait Platform
12/05/23
2 min read

  • Introducción

  • ¿Qué es Spring Boot Actuator?

    • Guía de uso Onesait

  • Panel de monitorización. Spring boot Admin

    • Registro y monitorización de un microservicio. Spring boot Admin Cliente

Introducción

En escenarios arquitectónicos de mapas/mallas de multiples microservicios que de manera coordinada o independiente son responsables de responder y ejecutar la lógica de nuestros productos, es importante proveer de mecanismos que de manera simple permitan monitorizar y auditar el estado de salud de estos microservicios para coordinar sistemas de alertas y restaurar el servicio sin prácticamente interrupción (levantamientos o reinicios que puede ser automático en combinación de Docker, Kubernetes y CaaS)

¿Qué es Spring Boot Actuator?

Los actuators de Spring Boot nos ofrecen una serie de funcionalidades para el manejo y gestión de las

aplicaciones. Estas funcionalidades pueden ser configuradas para ser usadas a partir de endpoints HTTP o mediante JMX.

El conjunto de endpoints permite monitorizar e interactuar con las aplicaciones. Algún ejemplo de ellos son:

/actuator/health: Muestra el estado de la aplicación ("UP", "DOWN"). Sobre una conexión autenticada proporciona datos extra a parte del estado.

{
    "status" : "UP"
}

/actuator/info: Muestra información general de la aplicación (Nombre, versión y descripción)

{
    "app" : {
        "version" : "1.0.0",
        "description" : "This is my first spring boot application",
        "name" : "Spring Sample Application"
    }
}

/actuator/metrics: Muestra métricas de la aplicación de sistema operativo, JVM y a nivel de aplicación.

{
    "mem" : 193024,
    "mem.free" : 87693,
    "processors" : 4,
    "instance.uptime" : 305027,
    "uptime" : 307077,
    ...
}

Adicionalmente se pueden crear nuevos endpoints personalizados para mostrar la información que el usuario desee.

 

Para más información, podemos consultar la documentación oficial: https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html

Guía de uso Onesait

Puedes encontrar nuestra receta Onesait de como utilizarlo en Guía de uso de Spring Boot Actuator

Panel de monitorización. Spring boot Admin

Si estás utilizando el modulo MSA de Onesait Platforma,  tendrás acceso al panel de monitorización de todos lo microservicios de tu solución de manera automática Consulta https://onesaitplatform.atlassian.net/wiki/spaces/OP/pages/671121424/Improved+Monitoring+UI

Registro y monitorización de un microservicio. Spring boot Admin Cliente

En la siguiente dirección podrás encontrar la configuración necesaria para registrar un microservicio y que sea monitorizado mediante el panel de control del Spring Boot Admin. Esta hace uso de la información que nos da el actuator para obtener el estado, metricas, logs y demás información de nuestros servicios.