在 .NET Core Worker Service 中执行健康检查 [英] Performing a health check in .NET Core Worker Service

问题描述

如何在 .NET Core Worker Service 中实现健康检查?

How can I implement health checks in a .NET Core Worker Service?

服务将在 Docker 内部运行，需要能够检查服务的健康状况.

The service will be run inside Docker and needs to be able to check the health of the service.

推荐答案

另一种方法是实现 IHealthCheckPublisher.

这种方法的好处是能够重用您现有的 IHealthCheck 或与依赖 IHealthCheck 接口(如 这个.

The benefits of this approach is the ability to re-use your existing IHealthChecks or integration with 3rd party libraries that rely on IHealthCheck interface (like this one).

虽然您仍然将 Microsoft.NET.Sdk.Web 作为 SDK，但您不需要添加任何 asp.net 细节.

Though you still target Microsoft.NET.Sdk.Web as the SDK you don't need to add any asp.net specifics.

这是一个例子:

public static IHostBuilder CreateHostBuilder(string[] args)
{
  return Host
    .CreateDefaultBuilder(args)
    .ConfigureServices((hostContext, services) =>
    {
      services
        .AddHealthChecks()
        .AddCheck<RedisHealthCheck>("redis_health_check")
        .AddCheck<RfaHealthCheck>("rfa_health_check");

      services.AddSingleton<IHealthCheckPublisher, HealthCheckPublisher>();
      services.Configure<HealthCheckPublisherOptions>(options =>
      {
        options.Delay = TimeSpan.FromSeconds(5);
        options.Period = TimeSpan.FromSeconds(5);
      });
    });
}

public class HealthCheckPublisher : IHealthCheckPublisher
{
  private readonly string _fileName;
  private HealthStatus _prevStatus = HealthStatus.Unhealthy;

  public HealthCheckPublisher()
  {
    _fileName = Environment.GetEnvironmentVariable(EnvVariableNames.DOCKER_HEALTHCHECK_FILEPATH) ??
                Path.GetTempFileName();
  }

  public Task PublishAsync(HealthReport report, CancellationToken cancellationToken)
  {
    // AWS will check if the file exists inside of the container with the command
    // test -f $DOCKER_HEALTH_CHECK_FILEPATH

    var fileExists = _prevStatus == HealthStatus.Healthy;

    if (report.Status == HealthStatus.Healthy)
    {
      if (!fileExists)
      {
        using var _ = File.Create(_fileName);
      }
    }
    else if (fileExists)
    {
      File.Delete(_fileName);
    }

    _prevStatus = report.Status;

    return Task.CompletedTask;
  }
}

这篇关于在 .NET Core Worker Service 中执行健康检查的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！