Health checks

Tenantry.Pro.HealthChecks adds ASP.NET Core health checks that probe every tenant database: one verifies connectivity, the other reports pending EF Core migrations. Both enumerate tenants from your store and report per-tenant detail in the health check data dictionary.

InstallCopy Anchor Link

dotnet add package Tenantry.Pro.HealthChecks

Both checks build on database-per-tenant, so pro.UseDatabasePerTenant(...) must be configured with a GetConnectionString delegate.

Database connectivity checkCopy Anchor Link

AddTenantryDatabaseCheck<TKey> opens an ADO.NET connection to each tenant's database. Supply a ConnectionFactory that turns a connection string into the right DbConnection for your provider:

using Microsoft.Data.SqlClient;
using Tenantry.Pro.HealthChecks.Extensions;

builder.Services.AddHealthChecks()
    .AddTenantryDatabaseCheck<string>(opts =>
    {
        opts.ConnectionFactory = cs => new SqlConnection(cs);     // Npgsql: new NpgsqlConnection(cs)
        opts.ConnectionTimeout = TimeSpan.FromSeconds(5);          // per-tenant open timeout (default 5s)
        opts.Tags = ["tenantry", "database"];                      // health check tags
    });

Result semantics:

The check is registered under the name tenantry-databases.

Migration checkCopy Anchor Link

AddTenantryMigrationCheck<TKey, TContext> queries each tenant's pending migrations. Supply a factory that builds your DbContext from a connection string:

builder.Services.AddHealthChecks()
    .AddTenantryMigrationCheck<string, AppDbContext>(
        cs => new AppDbContext(
            new DbContextOptionsBuilder<AppDbContext>().UseSqlServer(cs).Options));

Result semantics:

Registered under the name tenantry-migrations. Because it inspects EF Core migration metadata, it uses reflection and is annotated [RequiresDynamicCode]/[RequiresUnreferencedCode] — expect the AOT/trimming analyzer to flag it.

Exposing the endpointCopy Anchor Link

var app = builder.Build();

app.MapHealthChecks("/health");

// Or split readiness from liveness using the tags above:
app.MapHealthChecks("/health/ready", new HealthCheckOptions
{
    Predicate = check => check.Tags.Contains("tenantry")
});

A GET /health returns the aggregate status; enable a detailed response writer to surface the per-tenant data dictionary if you want tenant-level visibility.

See alsoCopy Anchor Link

• Database per tenant — the connection-string source these checks use.
• Migration orchestration — the same pending-migration information, plus the ability to apply it.