Reo.Core.HealthCheck

Описание пакета

Пакет Reo.Core.HealthCheck предоставляет инструменты для реализации и интеграции проверок работоспособности (health checks) в приложениях на основе ASP.NET Core. Он позволяет:

• Создавать кастомные проверки состояния сервисов.
• Агрегировать результаты множества проверок для оценки общего состояния кластера.
• Интегрировать с интерфейсом проверок состояния (Health Checks UI).
• Проверять наличие зарегистрированных проверок в контейнере зависимостей.

Решаемая проблема: Упрощение реализации сложных сценариев мониторинга состояния сервисов в распределённых системах.

---

Основные компоненты

1. AbstractClusterHealthCheck

   • Абстрактный класс для реализации проверок, агрегирующих результаты множества IHealthCheck.
   • Определяет логику оценки состояния кластера на основе количества здоровых узлов.

2. EndpointRouteBuilderExtensions

   • Методы расширения для добавления эндпоинта /hc с поддержкой интерфейса проверок состояния (Health Checks UI).

3. ServiceCollectionExtensions

   • Утилиты для проверки наличия зарегистрированных проверок в IServiceCollection.

---

Требования

• .NET версия: 8.0
• Зависимости:
  • AspNetCore.HealthChecks.UI.Client
  • System.Text.Json
  • Microsoft.EntityFrameworkCore

---

Установка

# Через NuGet Package Manager Install-Package Reo.Core.HealthCheck # Через .NET CLI dotnet add package Reo.Core.HealthCheck

---

Настройка

Регистрация проверок в ASP.NET Core

1. Добавьте проверку в контейнер зависимостей:

   services.AddHealthChecks() .AddCheck("custom-check", new CustomHealthCheck());

2. Используйте AbstractClusterHealthCheck для агрегации:

   public class CustomClusterHealthCheck : AbstractClusterHealthCheck { public CustomClusterHealthCheck(IEnumerable<IHealthCheck> healthChecks) : base(healthChecks) { } }

3. Настройте эндпоинт проверок:

   app.UseEndpoints(endpoints => { endpoints.MapDefaultHealthCheck(); });

---

Использование

Пример 1: Создание кастомной проверки

public class DatabaseHealthCheck : IHealthCheck { public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context, CancellationToken cancellationToken = default) { // Логика проверки подключения к БД return HealthCheckResult.Healthy(); } }

Пример 2: Агрегация результатов

var healthChecks = new List<IHealthCheck> { new DatabaseHealthCheck(), new CustomHealthCheck() }; var clusterCheck = new CustomClusterHealthCheck(healthChecks);

Пример 3: Проверка наличия зарегистрированной проверки

if (services.IsExistHealthCheck("custom-check")) { Console.WriteLine("Проверка 'custom-check' уже зарегистрирована."); }

---

Лицензия

Данный пакет распространяется под лицензией MIT.