|
| 1 | +using System.Text.Json; |
| 2 | +using Microsoft.AspNetCore.Diagnostics.HealthChecks; |
| 3 | +using Microsoft.Extensions.Diagnostics.HealthChecks; |
| 4 | +using StarBlog.Api.HealthChecks; |
| 5 | + |
| 6 | +namespace StarBlog.Api.Extensions; |
| 7 | + |
| 8 | +public static class ConfigureHealthChecks { |
| 9 | + /// <summary> |
| 10 | + /// 为 StarBlog.Api 注册健康检查(Health Checks)。 |
| 11 | + /// - Liveness:仅用于判断进程是否还“活着”(不依赖外部资源) |
| 12 | + /// - Readiness:用于判断服务是否“就绪”(会检查关键依赖是否可用,如数据库) |
| 13 | + /// </summary> |
| 14 | + public static void AddStarBlogHealthChecks(this IServiceCollection services) { |
| 15 | + services |
| 16 | + .AddHealthChecks() |
| 17 | + .AddCheck<LiveHealthCheck>( |
| 18 | + name: "live", |
| 19 | + tags: new[] { HealthCheckTags.Live } |
| 20 | + ) |
| 21 | + .AddCheck<SqliteLogHealthCheck>( |
| 22 | + name: "sqlite-log", |
| 23 | + tags: new[] { HealthCheckTags.Ready } |
| 24 | + ) |
| 25 | + .AddCheck<FreeSqlHealthCheck>( |
| 26 | + name: "freesql", |
| 27 | + tags: new[] { HealthCheckTags.Ready } |
| 28 | + ); |
| 29 | + } |
| 30 | + |
| 31 | + /// <summary> |
| 32 | + /// 映射健康检查端点: |
| 33 | + /// - /health/live:存活探针 |
| 34 | + /// - /health/ready:就绪探针 |
| 35 | + /// - /health、/healthz:汇总探针(兼容别名) |
| 36 | + /// </summary> |
| 37 | + public static WebApplication MapStarBlogHealthChecks(this WebApplication app) { |
| 38 | + // HealthChecks:最常见的三种探针(以及 /healthz 兼容别名) |
| 39 | + app.MapHealthChecks( |
| 40 | + "/health/live", |
| 41 | + CreateHealthCheckOptions(r => r.Tags.Contains(HealthCheckTags.Live)) |
| 42 | + ) |
| 43 | + .AllowAnonymous(); |
| 44 | + |
| 45 | + app.MapHealthChecks( |
| 46 | + "/health/ready", |
| 47 | + CreateHealthCheckOptions(r => r.Tags.Contains(HealthCheckTags.Ready)) |
| 48 | + ) |
| 49 | + .AllowAnonymous(); |
| 50 | + |
| 51 | + app.MapHealthChecks( |
| 52 | + "/health", |
| 53 | + CreateHealthCheckOptions(_ => true) |
| 54 | + ) |
| 55 | + .AllowAnonymous(); |
| 56 | + |
| 57 | + app.MapHealthChecks( |
| 58 | + "/healthz", |
| 59 | + CreateHealthCheckOptions(_ => true) |
| 60 | + ) |
| 61 | + .AllowAnonymous(); |
| 62 | + |
| 63 | + return app; |
| 64 | + } |
| 65 | + |
| 66 | + /// <summary> |
| 67 | + /// 统一的 HealthCheckOptions,输出 JSON,并按健康状态返回 HTTP 状态码。 |
| 68 | + /// </summary> |
| 69 | + public static HealthCheckOptions CreateHealthCheckOptions(Func<HealthCheckRegistration, bool> predicate) { |
| 70 | + return new HealthCheckOptions { |
| 71 | + Predicate = predicate, |
| 72 | + AllowCachingResponses = false, |
| 73 | + ResultStatusCodes = { |
| 74 | + [HealthStatus.Healthy] = StatusCodes.Status200OK, |
| 75 | + [HealthStatus.Degraded] = StatusCodes.Status200OK, |
| 76 | + [HealthStatus.Unhealthy] = StatusCodes.Status503ServiceUnavailable |
| 77 | + }, |
| 78 | + ResponseWriter = WriteResponseAsync |
| 79 | + }; |
| 80 | + } |
| 81 | + |
| 82 | + private static Task WriteResponseAsync(HttpContext context, HealthReport report) { |
| 83 | + context.Response.ContentType = "application/json; charset=utf-8"; |
| 84 | + |
| 85 | + var payload = new { |
| 86 | + status = report.Status.ToString(), |
| 87 | + totalDurationMs = report.TotalDuration.TotalMilliseconds, |
| 88 | + checks = report.Entries.Select(entry => new { |
| 89 | + name = entry.Key, |
| 90 | + status = entry.Value.Status.ToString(), |
| 91 | + durationMs = entry.Value.Duration.TotalMilliseconds, |
| 92 | + description = entry.Value.Description, |
| 93 | + error = entry.Value.Exception?.Message, |
| 94 | + data = entry.Value.Data.Count == 0 ? null : entry.Value.Data |
| 95 | + }) |
| 96 | + }; |
| 97 | + |
| 98 | + return context.Response.WriteAsync(JsonSerializer.Serialize(payload)); |
| 99 | + } |
| 100 | +} |
0 commit comments