TenantHealthCheckOptions class

Namespace: Tenantry.Pro.HealthChecks · Package: Tenantry.Pro.HealthChecks · API reference

Options for tenant database health checks. Configure via builder.Services.AddHealthChecks().AddTenantryDatabaseCheck<TKey>(opts => { ... }).

public sealed class TenantHealthCheckOptions

PropertiesCopy Anchor Link

ConnectionFactoryCopy Anchor Link

Factory that creates an ADO.NET DbConnection from a connection string. Required for AddTenantryDatabaseCheck.

public Func<string, DbConnection>? ConnectionFactory { get; set; }

Value: Func<string, DbConnection>

opts.ConnectionFactory = connStr => new SqlConnection(connStr);
opts.ConnectionFactory = connStr => new NpgsqlConnection(connStr);

ConnectionTimeoutCopy Anchor Link

Maximum time to wait for each tenant's database connection to open. Default: 5 seconds.

public TimeSpan ConnectionTimeout { get; set; }

Value: TimeSpan

TagsCopy Anchor Link

ASP.NET Core health check tags applied to the database connectivity check. Useful for filtering in readiness vs. liveness probes. Default: ["tenantry", "database"].

public IList<string> Tags { get; set; }

Value: IList<string>