如何处理Kubernetes中健康检查的TaskCanceledException异常？

我在Program.cs中编写了如下代码：

builder.Services.AddHealthChecks().AddCheck<StartupProbe>("Startup Probe")
    .AddCheck<LivenessProbe>("Liveness Probe")
    .AddCheck<ReadinessProbe>("Readiness Probe");

这段代码给运行在Kubernetes中的服务添加了三个实现IHealthCheck的类，用于执行健康检查。

大多数时候运行正常，但偶尔会抛出TaskCanceledException异常，提示“A task was canceled”。这些健康检查约每5秒执行一次，偶尔的取消本身不影响服务，但相关错误日志会持续累积，导致日志文件被占满。

我了解可以使用异常处理中间件，但文档让我有以下困惑：

• 文档提到加载“页面”，但我的服务没有UI（只有Swagger UI）；
• 文档似乎需要用特性装饰控制器才能生效，但AddHealthChecks是自动配置路由的，没有对应的控制器；
• 我只想针对健康检查请求处理TaskCanceledException，但没找到限制处理范围的方法。

我也了解过异常过滤器的选项，但文档建议优先使用异常处理中间件。

是否存在仅针对健康检查处理这类错误的方法？

注：完整异常信息如下：

"EventId": 1,
"LogLevel": "Error",
"Category": "Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware",
"Message": "An unhandled exception has occurred while executing the request.",
"Exception": "
    System.Threading.Tasks.TaskCanceledException: A task was canceled.
    at Microsoft.Extensions.Diagnostics.HealthChecks.DefaultHealthCheckService.CheckHealthAsync(Func`2 predicate, CancellationToken cancellationToken)
    at Microsoft.AspNetCore.Diagnostics.HealthChecks.HealthCheckMiddleware.InvokeAsync(HttpContext httpContext)
    at Dynatrace.OneAgent.Introspection.Shared.OwinMiddlewareBase`1.Invoke(Context context)
    at Swashbuckle.AspNetCore.SwaggerUI.SwaggerUIMiddleware.Invoke(HttpContext httpContext)
    at Swashbuckle.AspNetCore.Swagger.SwaggerMiddleware.Invoke(HttpContext httpContext, ISwaggerProvider swaggerProvider)
    at Microsoft.AspNetCore.HeaderPropagation.HeaderPropagationMiddleware.Invoke(HttpContext context)
    at Dynatrace.OneAgent.Introspection.Shared.OwinMiddlewareBase`1.Invoke(Context context)
    at Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware.Invoke(HttpContext context)",
"State": {
    "Message": "An unhandled exception has occurred while executing the request.",
    "{OriginalFormat}": "An unhandled exception has occurred while executing the request."
}

你可以通过以下几种方式实现仅针对健康检查请求处理TaskCanceledException：

1. 自定义限定路径的异常处理中间件 #

创建一个仅拦截健康检查路径的中间件，在其中捕获并处理TaskCanceledException，避免错误日志被写入。示例代码如下：

// 放在健康检查中间件和DeveloperExceptionPageMiddleware之前注册
app.Use(async (context, next) =>
{
    try
    {
        await next();
    }
    catch (TaskCanceledException)
    {
        // 仅拦截健康检查路径的取消异常
        if (context.Request.Path.StartsWithSegments("/health")) // 替换为你的健康检查实际路由
        {
            // 根据需求返回合适状态码，这里以200为例
            context.Response.StatusCode = StatusCodes.Status200OK;
            await context.Response.WriteAsync("健康检查任务已取消，服务运行正常");
        }
        else
        {
            // 其他路径的异常继续抛出，交给默认逻辑处理
            throw;
        }
    }
});

// 注册健康检查中间件
app.UseHealthChecks("/health");

2. 配置健康检查中间件的错误处理逻辑 #

ASP.NET Core的健康检查中间件允许通过HealthCheckOptions自定义错误处理，直接在配置时处理异常：

app.UseHealthChecks("/health", new HealthCheckOptions
{
    ResponseWriter = async (context, report) =>
    {
        try
        {
            // 自定义健康检查响应内容
            context.Response.ContentType = "application/json";
            var result = JsonSerializer.Serialize(new
            {
                status = report.Status.ToString(),
                checks = report.Entries.Select(entry => new
                {
                    name = entry.Key,
                    status = entry.Value.Status.ToString(),
                    description = entry.Value.Description
                })
            });
            await context.Response.WriteAsync(result);
        }
        catch (TaskCanceledException)
        {
            // 处理取消异常，返回简化响应
            context.Response.StatusCode = StatusCodes.Status200OK;
            await context.Response.WriteAsync("{\"status\": \"Healthy\"}");
        }
    },
    OnHealthCheckFailed = (context, exception) =>
    {
        if (exception is TaskCanceledException)
        {
            // 取消异常不触发错误日志，返回成功状态
            context.Response.StatusCode = StatusCodes.Status200OK;
            return Task.CompletedTask;
        }
        // 其他异常交给默认逻辑处理
        return Task.FromException(exception);
    }
});

3. 过滤健康检查相关的异常日志 #

如果不想修改请求处理逻辑，也可以通过日志过滤规则直接忽略健康检查的TaskCanceledException日志。在appsettings.json中添加配置：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware": "Warning"
    },
    "Filters": [
      {
        "Name": "HealthCheckTaskCanceledFilter",
        "Args": {
          "ExceptionType": "System.Threading.Tasks.TaskCanceledException",
          "Category": "Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware",
          "Path": "/health"
        }
      }
    ]
  }
}

然后实现自定义日志过滤器：

public class HealthCheckTaskCanceledFilter : ILoggerFilter
{
    private readonly string _exceptionType;
    private readonly string _category;
    private readonly string _path;

    public HealthCheckTaskCanceledFilter(string exceptionType, string category, string path)
    {
        _exceptionType = exceptionType;
        _category = category;
        _path = path;
    }

    public void Filter(LogEvent logEvent)
    {
        if (logEvent.Category == _category && 
            logEvent.Exception?.GetType().FullName == _exceptionType &&
            logEvent.Properties.TryGetValue("Path", out var pathValue) &&
            pathValue.ToString().StartsWith(_path))
        {
            logEvent.Level = LogLevel.None; // 忽略该日志
        }
    }
}

最后在Program.cs中注册过滤器：

builder.Services.AddLogging(logging =>
{
    logging.AddFilter<HealthCheckTaskCanceledFilter>(options =>
    {
        options.ExceptionType = "System.Threading.Tasks.TaskCanceledException";
        options.Category = "Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware";
        options.Path = "/health";
    });
});

推荐方案 #

优先选择自定义中间件或健康检查选项配置，这两种方式直接针对健康检查请求处理异常，能从根源避免不必要的日志生成。如果只是需要快速屏蔽日志，日志过滤是轻量化的选择。

内容的提问来源于stack exchange，提问作者Vaccano