Implementación de Health Checks en ASP.NET Core

Los health checks son un componente esencial en el desarrollo y operación de aplicaciones modernas. Estas herramientas permiten garantizar que todos los elementos y servicios clave dentro de una aplicación estén funcionando de manera óptima. En el contexto de la programación y desarrollo, los health checks son una práctica vital para asegurarse de que los sistemas estén en buen estado y respondiendo como se espera.

Importancia de los Health Checks

En el ecosistema cada vez más complejo de aplicaciones y servicios interconectados, es fundamental contar con un mecanismo para monitorear y evaluar el estado de los componentes. Los health checks proporcionan una forma sistemática de realizar esta tarea. Al permitir que la aplicación verifique y comunique su estado, los desarrolladores y equipos de operaciones pueden identificar problemas potenciales antes de que se conviertan en fallos críticos.

Los health checks son esenciales por varias razones:

Detección Temprana de Problemas: Los health checks permiten identificar problemas en un estado incipiente. Esto significa que los equipos de operaciones pueden abordar problemas antes de que afecten negativamente a los usuarios finales.
Mantenimiento Proactivo: Al identificar problemas antes de que se conviertan en fallos mayores, los equipos de operaciones pueden planificar y ejecutar el mantenimiento de manera proactiva en lugar de reaccionar ante situaciones de emergencia.
Ahorro de Recursos: Al abordar problemas en sus primeras etapas, se evita el gasto de recursos significativos que podrían haberse destinado a solucionar fallos graves.
Mejora de la Experiencia del Usuario: Al mantener el funcionamiento normal de los sistemas, los usuarios finales experimentan menos interrupciones y disfrutan de una experiencia más fluida.
Facilita la Escalabilidad: Los sistemas de orquestación de contenedores, por ejemplo, pueden utilizar health checks para determinar cuándo escalar instancias para manejar una carga creciente.
Notificaciones y Reparación Automática: Los health checks pueden configurarse para notificar automáticamente a los equipos de operaciones cuando se detectan problemas. Además, en entornos de microservicios, pueden activar acciones automáticas de recuperación.

En resumen, los health checks son como el "chequeo de salud" de una aplicación. Son una herramienta esencial para garantizar la confiabilidad, la disponibilidad y la robustez de las aplicaciones en un mundo cada vez más interconectado y orientado al servicio. En el contexto de ASP.NET Core, implementar health checks se ha vuelto aún más fácil gracias a los paquetes y las configuraciones específicas que ofrecen. A continuación, exploraremos cómo llevar a cabo esta implementación en tu propia aplicación ASP.NET Core.

Configuración de los Paquetes

Lo primero que debemos hacer es agregar las dependencias necesarias en el archivo csproj:

<PackageReference Include="AspNetCore.HealthChecks.ApplicationStatus" Version="7.0.0" />  
<PackageReference Include="AspNetCore.HealthChecks.SendGrid" Version="7.0.0" />  
<PackageReference Include="AspNetCore.HealthChecks.SqlServer" Version="7.0.0" />  
<PackageReference Include="AspNetCore.HealthChecks.UI" Version="7.0.2" />  
<PackageReference Include="AspNetCore.HealthChecks.UI.Client" Version="7.1.0" />  
<PackageReference Include="AspNetCore.HealthChecks.UI.InMemory.Storage" Version="7.0.0" />

Configuración de los Health Checks

En el archivo de inicio de tu aplicación (Program.cs), procedemos a configurar los health checks:

using HealthChecks.ApplicationStatus.DependencyInjection;  
using HealthChecks.UI.Client;  
using Microsoft.AspNetCore.Diagnostics.HealthChecks;  
using Microsoft.Extensions.Diagnostics.HealthChecks;  

var builder = WebApplication.CreateBuilder(args);  

// Configuración de health checks  
builder.Services  
    .AddHealthChecks()  
    .AddApplicationStatus(name: "api_status", tags: new[] { "api" })  
    .AddSqlServer(       
        connectionString: builder.Configuration.GetConnectionString("Default")!,  
        name: "sql",  
        failureStatus: HealthStatus.Degraded,  
        tags: new[] { "db", "sql", "sqlserver" })  
    .AddSendGrid(apiKey: builder.Configuration["SendGrid:Key"]!, tags: new[] { "email", "sendgrid" })  
    .AddCheck<ServerHealthCheck>("server_health_check", tags: new []{"custom", "api"});

Esta configuración establece varios health checks:

Application Status: Comprueba si el servicio está en funcionamiento, mediante la detección de un posible cierre de la aplicación.
SQL Server: Verifica el estado de la base de datos a través de un simple SELECT 1;, sin generar carga de CPU.
SendGrid: Valida la configuración y disponibilidad del servicio de correos SendGrid.
Custom: Agregamos uno personalizado para implementar la lógica pertinente y determinar el estado del servicio.

Además de estas verificaciones, el repositorio AspNetCore.Diagnostics.HealthChecks ofrece una amplia gama de health checks predefinidos para componentes clave en aplicaciones ASP.NET Core, como otras bases de datos o servicios como Rabbitmq.

ServerHealthCheck - Health Check Personalizado

A continuación, se muestra un ejemplo de implementación para el health check personalizado ServerHealthCheck:

using Microsoft.Extensions.Diagnostics.HealthChecks;  

namespace Web;  

public class ServerHealthCheck : IHealthCheck  
{  
    public Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context,  
        CancellationToken cancellationToken = default)  
    {  
        var isServerHealthy = CheckServerStatus();  

        return Task.FromResult(isServerHealthy  
            ? HealthCheckResult.Healthy("El servidor está en funcionamiento.")  
            : HealthCheckResult.Unhealthy("El servidor no está respondiendo."));  
    }  

    private bool CheckServerStatus()  
    {  
        // Implementa aquí la lógica para verificar el estado del servidor.  
        return true; // Simulamos que el servidor está en funcionamiento  
    }  
}

Configuración de la Interfaz de Usuario de Health Checks

Para añadir la interfaz de usuario de health checks, debemos incluir la siguiente configuración:

builder.Services  
    .AddHealthChecksUI()  
    .AddInMemoryStorage();

El repositorio AspNetCore.Diagnostics.HealthChecks ofrece opciones de persistencia flexibles para la interfaz de usuario de health checks. Puedes elegir entre varias opciones de almacenamiento, como InMemory Storage, SQL Server Storage, Redis Storage y Elasticsearch Storage, para almacenar y acceder a los resultados de las verificaciones de salud.

Endpoints

En el mismo archivo Program.cs, configuramos las rutas y los endpoints con los health checks:

var app = builder.Build();  

app.MapGet("/", () => "¡Hola, mundo!");  
app.MapHealthChecks("/healthz", new HealthCheckOptions()  
{  
    Predicate = _ => true,  
    ResponseWriter = UIResponseWriter.WriteHealthCheckUIResponse  
});  
app.MapHealthChecksUI();  

app.Run();

appsettings.json

Configura el archivo appsettings.json con las cadenas de conexión y claves necesarias:

{  
  "Logging": {  
    "LogLevel": {  
      "Default": "Information",  
      "Microsoft.AspNetCore": "Warning"  
    }  
  },  
  "AllowedHosts": "*",  
  "ConnectionStrings": {  
    "Default" : "<Tu cadena de conexión>"  
  },  
  "SendGrid": {  
    "Key": "<Clave de API de Sendgrid>"  
  },  
  "HealthChecksUI": {  
    "HealthChecks": [  
      {  
        "Name": "API Demo",  
        "Uri": "http://localhost:<puerto>/healthz"  
      }  
    ],  
    "Webhooks": [],  
    "EvaluationTimeInSeconds": 10,  
    "MinimumSecondsBetweenFailureNotifications": 60  
  }  
}

Probando los Health Checks

Al ejecutar la aplicación, puedes acceder a la ruta /healthz para ver el estado de los health checks configurados:

{
  "status": "Healthy",
  "totalDuration": "00:00:00.1591922",
  "entries": {
    "api_status": {
      "data": {},
      "duration": "00:00:00.0000854",
      "status": "Healthy",
      "tags": [
        "api"
      ]
    },
    "sql": {
      "data": {},
      "duration": "00:00:00.0048486",
      "status": "Healthy",
      "tags": [
        "db",
        "sql",
        "sqlserver"
      ]
    },
    "sendgrid": {
      "data": {},
      "duration": "00:00:00.1590220",
      "status": "Healthy",
      "tags": [
        "email",
        "sendgrid"
      ]
    },
    "server_health_check": {
      "data": {},
      "description": "El servidor está en funcionamiento.",
      "duration": "00:00:00.0000300",
      "status": "Healthy",
      "tags": [
        "custom",
        "api"
      ]
    }
  }
}

La interfaz de usuario de health checks, accesible en /healthchecks-ui, muestra una visualización gráfica de estos resultados.

Conclusión

La implementación de health checks es una práctica esencial para asegurar la disponibilidad y robustez de las aplicaciones. Gracias al paquete AspNetCore.HealthChecks en ASP.NET Core, la configuración y monitorización del estado de los servicios y componentes es simple y eficaz. Al invertir en health checks, estarás mejor preparado para enfrentar problemas y garantizar una experiencia de usuario sin problemas.

Blog