| | | 1 | | using Kestrun.Health; |
| | | 2 | | using Kestrun.Hosting.Options; |
| | | 3 | | using Kestrun.Models; |
| | | 4 | | using Kestrun.Scripting; |
| | | 5 | | using Kestrun.Utilities; |
| | | 6 | | using Microsoft.Net.Http.Headers; |
| | | 7 | | using System.Text.Json; |
| | | 8 | | using System.Text.Json.Serialization; |
| | | 9 | | |
| | | 10 | | namespace Kestrun.Hosting; |
| | | 11 | | |
| | | 12 | | /// <summary> |
| | | 13 | | /// Adds health-check specific helpers to <see cref="KestrunHost"/>. |
| | | 14 | | /// </summary> |
| | | 15 | | public static class KestrunHostHealthExtensions |
| | | 16 | | { |
| | | 17 | | private static readonly JsonSerializerOptions JsonOptions; |
| | | 18 | | |
| | | 19 | | static KestrunHostHealthExtensions() |
| | | 20 | | { |
| | 0 | 21 | | JsonOptions = new JsonSerializerOptions(JsonSerializerDefaults.Web) |
| | 0 | 22 | | { |
| | 0 | 23 | | DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, |
| | 0 | 24 | | WriteIndented = false |
| | 0 | 25 | | }; |
| | 0 | 26 | | JsonOptions.Converters.Add(new JsonStringEnumConverter()); |
| | 0 | 27 | | } |
| | | 28 | | |
| | | 29 | | /// <summary> |
| | | 30 | | /// Registers a GET endpoint (default <c>/health</c>) that aggregates the state of all registered probes. |
| | | 31 | | /// </summary> |
| | | 32 | | /// <param name="host">The host to configure.</param> |
| | | 33 | | /// <param name="configure">Optional action to mutate the default endpoint options.</param> |
| | | 34 | | /// <returns>The <see cref="KestrunHost"/> instance for fluent chaining.</returns> |
| | | 35 | | public static KestrunHost AddHealthEndpoint(this KestrunHost host, Action<HealthEndpointOptions>? configure = null) |
| | | 36 | | { |
| | 0 | 37 | | ArgumentNullException.ThrowIfNull(host); |
| | | 38 | | |
| | 0 | 39 | | var merged = host.Options.Health?.Clone() ?? new HealthEndpointOptions(); |
| | 0 | 40 | | configure?.Invoke(merged); |
| | | 41 | | |
| | 0 | 42 | | var mapOptions = new MapRouteOptions |
| | 0 | 43 | | { |
| | 0 | 44 | | Pattern = merged.Pattern, |
| | 0 | 45 | | HttpVerbs = [HttpVerb.Get], |
| | 0 | 46 | | ScriptCode = new LanguageOptions |
| | 0 | 47 | | { |
| | 0 | 48 | | Language = ScriptLanguage.Native, |
| | 0 | 49 | | }, |
| | 0 | 50 | | AllowAnonymous = merged.AllowAnonymous, |
| | 0 | 51 | | DisableAntiforgery = true, |
| | 0 | 52 | | RequireSchemes = [.. merged.RequireSchemes], |
| | 0 | 53 | | RequirePolicies = [.. merged.RequirePolicies], |
| | 0 | 54 | | CorsPolicy = merged.CorsPolicy ?? string.Empty, |
| | 0 | 55 | | RateLimitPolicyName = merged.RateLimitPolicyName, |
| | 0 | 56 | | ShortCircuit = merged.ShortCircuit, |
| | 0 | 57 | | ShortCircuitStatusCode = merged.ShortCircuitStatusCode, |
| | 0 | 58 | | ThrowOnDuplicate = merged.ThrowOnDuplicate, |
| | 0 | 59 | | }; |
| | 0 | 60 | | mapOptions.OpenAPI.Add(HttpVerb.Get, new OpenAPIMetadata(pattern: merged.Pattern) |
| | 0 | 61 | | { |
| | 0 | 62 | | Summary = merged.OpenApiSummary, |
| | 0 | 63 | | Description = merged.OpenApiDescription, |
| | 0 | 64 | | OperationId = merged.OpenApiOperationId, |
| | 0 | 65 | | Tags = merged.OpenApiTags |
| | 0 | 66 | | }); |
| | | 67 | | |
| | | 68 | | // Auto-register endpoint only when enabled |
| | 0 | 69 | | if (!merged.AutoRegisterEndpoint) |
| | | 70 | | { |
| | 0 | 71 | | host.Logger.Debug("Health endpoint AutoRegisterEndpoint=false; skipping automatic mapping for pattern {Patte |
| | 0 | 72 | | return host; |
| | | 73 | | } |
| | | 74 | | |
| | | 75 | | // If the app pipeline is already built/configured, map immediately; otherwise defer until build |
| | 0 | 76 | | if (host.IsConfigured) |
| | | 77 | | { |
| | 0 | 78 | | MapHealthEndpointImmediate(host, merged, mapOptions); |
| | 0 | 79 | | return host; |
| | | 80 | | } |
| | | 81 | | |
| | 0 | 82 | | return host.Use(app => MapHealthEndpointImmediate(host, merged, mapOptions)); |
| | | 83 | | } |
| | | 84 | | |
| | | 85 | | /// <summary> |
| | | 86 | | /// Registers a GET endpoint (default <c>/health</c>) using a pre-configured <see cref="HealthEndpointOptions"/> ins |
| | | 87 | | /// </summary> |
| | | 88 | | /// <param name="host">The host to configure.</param> |
| | | 89 | | /// <param name="options">A fully configured options object.</param> |
| | | 90 | | /// <returns>The <see cref="KestrunHost"/> instance for fluent chaining.</returns> |
| | | 91 | | public static KestrunHost AddHealthEndpoint(this KestrunHost host, HealthEndpointOptions options) |
| | | 92 | | { |
| | 0 | 93 | | ArgumentNullException.ThrowIfNull(host); |
| | 0 | 94 | | ArgumentNullException.ThrowIfNull(options); |
| | | 95 | | |
| | 0 | 96 | | return host.AddHealthEndpoint(dest => CopyHealthEndpointOptions(options, dest)); |
| | | 97 | | } |
| | | 98 | | |
| | | 99 | | // ApplyConventions removed; unified with KestrunHostMapExtensions.AddMapOptions |
| | | 100 | | |
| | | 101 | | private static string[] ExtractTags(HttpRequest request) |
| | | 102 | | { |
| | 0 | 103 | | var collected = new List<string>(); |
| | 0 | 104 | | if (request.Query.TryGetValue("tag", out var singleValues)) |
| | | 105 | | { |
| | 0 | 106 | | foreach (var value in singleValues) |
| | | 107 | | { |
| | 0 | 108 | | if (!string.IsNullOrEmpty(value)) |
| | | 109 | | { |
| | 0 | 110 | | collected.AddRange(value.Split(',', StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyE |
| | | 111 | | } |
| | | 112 | | } |
| | | 113 | | } |
| | | 114 | | |
| | 0 | 115 | | if (request.Query.TryGetValue("tags", out var multiValues)) |
| | | 116 | | { |
| | 0 | 117 | | foreach (var value in multiValues) |
| | | 118 | | { |
| | 0 | 119 | | if (!string.IsNullOrEmpty(value)) |
| | | 120 | | { |
| | 0 | 121 | | collected.AddRange(value.Split(',', StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyE |
| | | 122 | | } |
| | | 123 | | } |
| | | 124 | | } |
| | | 125 | | |
| | 0 | 126 | | return collected.Count == 0 |
| | 0 | 127 | | ? [] |
| | 0 | 128 | | : [.. collected.Where(static t => !string.IsNullOrWhiteSpace(t)) |
| | 0 | 129 | | .Select(static t => t.Trim()) |
| | 0 | 130 | | .Distinct(StringComparer.OrdinalIgnoreCase)]; |
| | | 131 | | } |
| | | 132 | | |
| | | 133 | | private static void CopyHealthEndpointOptions(HealthEndpointOptions source, HealthEndpointOptions target) |
| | | 134 | | { |
| | 0 | 135 | | ArgumentNullException.ThrowIfNull(source); |
| | 0 | 136 | | ArgumentNullException.ThrowIfNull(target); |
| | | 137 | | |
| | 0 | 138 | | target.Pattern = source.Pattern; |
| | 0 | 139 | | target.DefaultTags = source.DefaultTags is { Length: > 0 } tags |
| | 0 | 140 | | ? [.. tags] |
| | 0 | 141 | | : Array.Empty<string>(); |
| | 0 | 142 | | target.AllowAnonymous = source.AllowAnonymous; |
| | 0 | 143 | | target.TreatDegradedAsUnhealthy = source.TreatDegradedAsUnhealthy; |
| | 0 | 144 | | target.ThrowOnDuplicate = source.ThrowOnDuplicate; |
| | 0 | 145 | | target.RequireSchemes = source.RequireSchemes is { Length: > 0 } schemes |
| | 0 | 146 | | ? [.. schemes] |
| | 0 | 147 | | : Array.Empty<string>(); |
| | 0 | 148 | | target.RequirePolicies = source.RequirePolicies is { Length: > 0 } policies |
| | 0 | 149 | | ? [.. policies] |
| | 0 | 150 | | : Array.Empty<string>(); |
| | 0 | 151 | | target.CorsPolicy = source.CorsPolicy; |
| | 0 | 152 | | target.RateLimitPolicyName = source.RateLimitPolicyName; |
| | 0 | 153 | | target.ShortCircuit = source.ShortCircuit; |
| | 0 | 154 | | target.ShortCircuitStatusCode = source.ShortCircuitStatusCode; |
| | 0 | 155 | | target.OpenApiSummary = source.OpenApiSummary; |
| | 0 | 156 | | target.OpenApiDescription = source.OpenApiDescription; |
| | 0 | 157 | | target.OpenApiOperationId = source.OpenApiOperationId; |
| | 0 | 158 | | target.OpenApiTags = source.OpenApiTags is { Count: > 0 } openApiTags |
| | 0 | 159 | | ? [.. openApiTags] |
| | 0 | 160 | | : new List<string>(); |
| | 0 | 161 | | target.OpenApiGroupName = source.OpenApiGroupName; |
| | 0 | 162 | | target.MaxDegreeOfParallelism = source.MaxDegreeOfParallelism; |
| | 0 | 163 | | target.ProbeTimeout = source.ProbeTimeout; |
| | 0 | 164 | | target.AutoRegisterEndpoint = source.AutoRegisterEndpoint; |
| | 0 | 165 | | target.DefaultScriptLanguage = source.DefaultScriptLanguage; |
| | | 166 | | // BUGFIX: Ensure the response content type preference is propagated when using the overload |
| | | 167 | | // that accepts a pre-configured HealthEndpointOptions instance. Without this line the |
| | | 168 | | // ResponseContentType would always fall back to Json for PowerShell Add-KrHealthEndpoint |
| | | 169 | | // which calls AddHealthEndpoint(host, options) internally. |
| | 0 | 170 | | target.ResponseContentType = source.ResponseContentType; |
| | 0 | 171 | | target.XmlRootElementName = source.XmlRootElementName; |
| | 0 | 172 | | target.Compress = source.Compress; |
| | 0 | 173 | | } |
| | 0 | 174 | | private static int DetermineStatusCode(ProbeStatus status, bool treatDegradedAsUnhealthy) => status switch |
| | 0 | 175 | | { |
| | 0 | 176 | | ProbeStatus.Healthy => StatusCodes.Status200OK, |
| | 0 | 177 | | ProbeStatus.Degraded when !treatDegradedAsUnhealthy => StatusCodes.Status200OK, |
| | 0 | 178 | | _ => StatusCodes.Status503ServiceUnavailable |
| | 0 | 179 | | }; |
| | | 180 | | |
| | | 181 | | /// <summary> |
| | | 182 | | /// Maps the health endpoint immediately. |
| | | 183 | | /// </summary> |
| | | 184 | | /// <param name="host">The KestrunHost instance.</param> |
| | | 185 | | /// <param name="merged">The merged HealthEndpointOptions instance.</param> |
| | | 186 | | /// <param name="mapOptions">The route mapping options.</param> |
| | | 187 | | /// <exception cref="InvalidOperationException">Thrown if a route with the same pattern and HTTP verb already exists |
| | | 188 | | private static void MapHealthEndpointImmediate(KestrunHost host, HealthEndpointOptions merged, MapRouteOptions mapOp |
| | | 189 | | { |
| | 0 | 190 | | if (host.MapExists(mapOptions.Pattern!, HttpVerb.Get)) |
| | | 191 | | { |
| | 0 | 192 | | var message = $"Route '{mapOptions.Pattern}' (GET) already exists. Skipping health endpoint registration."; |
| | 0 | 193 | | if (merged.ThrowOnDuplicate) |
| | | 194 | | { |
| | 0 | 195 | | throw new InvalidOperationException(message); |
| | | 196 | | } |
| | 0 | 197 | | host.Logger.Warning(message); |
| | 0 | 198 | | return; |
| | | 199 | | } |
| | | 200 | | |
| | | 201 | | // Acquire WebApplication (throws if Build() truly has not executed yet). Using host.App here allows |
| | | 202 | | // early AddHealthEndpoint calls before EnableConfiguration via deferred middleware. |
| | 0 | 203 | | var endpoints = host.App; |
| | 0 | 204 | | var endpointLogger = host.Logger.ForContext("HealthEndpoint", merged.Pattern); |
| | | 205 | | |
| | 0 | 206 | | var map = endpoints.MapMethods(merged.Pattern, [HttpMethods.Get], async context => |
| | 0 | 207 | | { |
| | 0 | 208 | | var requestTags = ExtractTags(context.Request); |
| | 0 | 209 | | var tags = requestTags.Length > 0 ? requestTags : merged.DefaultTags; |
| | 0 | 210 | | var snapshot = host.GetHealthProbesSnapshot(); |
| | 0 | 211 | | |
| | 0 | 212 | | var report = await HealthProbeRunner.RunAsync( |
| | 0 | 213 | | probes: snapshot, |
| | 0 | 214 | | tagFilter: tags, |
| | 0 | 215 | | perProbeTimeout: merged.ProbeTimeout, |
| | 0 | 216 | | maxDegreeOfParallelism: merged.MaxDegreeOfParallelism, |
| | 0 | 217 | | logger: endpointLogger, |
| | 0 | 218 | | ct: context.RequestAborted).ConfigureAwait(false); |
| | 0 | 219 | | |
| | 0 | 220 | | var request = await KestrunRequest.NewRequest(context).ConfigureAwait(false); |
| | 0 | 221 | | var response = new KestrunResponse(request) |
| | 0 | 222 | | { |
| | 0 | 223 | | CacheControl = new CacheControlHeaderValue |
| | 0 | 224 | | { |
| | 0 | 225 | | NoCache = true, |
| | 0 | 226 | | NoStore = true, |
| | 0 | 227 | | MustRevalidate = true, |
| | 0 | 228 | | MaxAge = TimeSpan.Zero |
| | 0 | 229 | | } |
| | 0 | 230 | | }; |
| | 0 | 231 | | context.Response.Headers.Pragma = "no-cache"; |
| | 0 | 232 | | context.Response.Headers.Expires = "0"; |
| | 0 | 233 | | |
| | 0 | 234 | | var statusCode = DetermineStatusCode(report.Status, merged.TreatDegradedAsUnhealthy); |
| | 0 | 235 | | switch (merged.ResponseContentType) |
| | 0 | 236 | | { |
| | 0 | 237 | | case HealthEndpointContentType.Json: |
| | 0 | 238 | | await response.WriteJsonResponseAsync(report, depth: 10, compress: merged.Compress, statusCode: stat |
| | 0 | 239 | | break; |
| | 0 | 240 | | case HealthEndpointContentType.Yaml: |
| | 0 | 241 | | await response.WriteYamlResponseAsync(report, statusCode).ConfigureAwait(false); |
| | 0 | 242 | | break; |
| | 0 | 243 | | case HealthEndpointContentType.Xml: |
| | 0 | 244 | | await response.WriteXmlResponseAsync( |
| | 0 | 245 | | report, |
| | 0 | 246 | | statusCode, |
| | 0 | 247 | | rootElementName: merged.XmlRootElementName ?? "Response", |
| | 0 | 248 | | compress: merged.Compress).ConfigureAwait(false); |
| | 0 | 249 | | break; |
| | 0 | 250 | | case HealthEndpointContentType.Text: |
| | 0 | 251 | | var text = HealthReportTextFormatter.Format(report); |
| | 0 | 252 | | await response.WriteTextResponseAsync(text, statusCode, contentType: $"text/plain; charset={response |
| | 0 | 253 | | break; |
| | 0 | 254 | | case HealthEndpointContentType.Auto: |
| | 0 | 255 | | default: |
| | 0 | 256 | | await response.WriteResponseAsync(report, statusCode).ConfigureAwait(false); |
| | 0 | 257 | | break; |
| | 0 | 258 | | } |
| | 0 | 259 | | |
| | 0 | 260 | | await response.ApplyTo(context.Response).ConfigureAwait(false); |
| | 0 | 261 | | }).WithMetadata(new ScriptLanguageAttribute(ScriptLanguage.Native)); |
| | | 262 | | |
| | 0 | 263 | | host.AddMapOptions(map, mapOptions); |
| | 0 | 264 | | host._registeredRoutes[(mapOptions.Pattern!, HttpVerb.Get)] = mapOptions; |
| | 0 | 265 | | host.Logger.Information("Registered health endpoint at {Pattern}", mapOptions.Pattern); |
| | 0 | 266 | | } |
| | | 267 | | } |