TraconHealthCheckExtensions

Namespace Tracon · Assembly Tracon.AspNetCore.dll

Extensions that connect Tracon to the standard.NET health check system.

public static class TraconHealthCheckExtensions

Inheritance

object ← TraconHealthCheckExtensions

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Methods

AddTraconHealthChecks(IHealthChecksBuilder, string, IEnumerable<string>?)

Registers the Tracon health check. The consumer sets up its own /health path.

public static IHealthChecksBuilder AddTraconHealthChecks(this IHealthChecksBuilder builder, string name = "tracon", IEnumerable<string>? tags = null)

Parameters

builder IHealthChecksBuilder

The health checks builder.

name string

The name of the check. Default is tracon.

tags IEnumerable<string>?

Tags to add to the check. Example: readiness/liveness separation.

Returns

IHealthChecksBuilder

The builder, for chaining.

Remarks

Tracon does not call MapHealthChecks — taking over the consumer’s path choice would break the no-surprises rule. Setup:

builder.Services.AddHealthChecks().AddTraconHealthChecks();
app.MapHealthChecks("/health");

The check reads TraconDiagnosticsCollector; it produces no model call. For the three states, see Tracon.TraconHealthCheck.

This call only adds a service registration; whether AddTracon is called before or after it does not matter (DI registration is order-independent). However, if AddTracon is never called, TraconDiagnosticsCollector cannot be resolved on the first /health probe and DI raises a clear error.

Exceptions

ArgumentNullException

builder is null.

ArgumentException

name is empty.