martymcflaye / younited.healthcheck.entityframeworkmigrations

Add a validation that all Entity Framework migrations have been executed, for a given DbContext, to the list of webapi healthchecks collection

Younited Credit netcore Entity Framework healthcheck library

The purpose of this project is to add a validation that all Entity Framework core migrations have been executed, for a given DbContext, to the list of webapi healthchecks collection

Getting Started

1. Setup health checks for your webapp, as explained in this article

2. Add reference to the Younited.HealthCheck.EntityFrameworkMigrations nuget to your webapp project

3. Publish a health check for your EntityFramework DbContext

services.AddHealthChecks()
    .AddEntityFrameworkMigrationsCheck<SampleDbContext>() // Registers required services and check the pipeline

    // And all the other checks you may need for your app
    .AddCheck<PingHealthChecker>(nameof(PingHealthChecker));

You can refer to the sample app setup for further reference

Once the setup is done, you shall receive missing migrations as part of the health detailed status

{
    "status": "Unhealthy",
    "totalDuration": "00:00:05.9933318",
    "entries": {
        
        "SampleDbContextMigrationsHealthCheck": {
            "data": {
                "MissingMigrations": [
                    "20200531210738_MissingMigration"
                ]
            },
            "description": "1 migrations were not executed on the DB",
            "duration": "00:00:05.9883966",
            "status": "Unhealthy"
        },

        "PingHealthChecker": {
            "data": {},
            "description": "Ping Check",
            "duration": "00:00:00.0001120",
            "status": "Healthy"
        }
    }
}

Code of conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].