reggieray/dotnet-health-checks

Overview

Healthz.Api is a C# minimal API showcasing usage of health checks. The API makes usage of:

• Registering a library health check
• Registering a custom health check
• Filter health checks
• Customising output

Getting Started: 👨🏻‍💻

Clone: ⚒️

git clone https://github.com/reggieray/dotnet-health-checks

Run: 👟

Run from either two options below:

Dotnet CLI: 💻

dotnet run --project ./src/Healthz.Api/ --configuration Release

Docker: 🐋

docker-compose up --build

HTTP Documentation: 📄

Explore HealthzApi.http and make requests with the following options available:

• Visual Studio: Visual Studio .http files
• VSCode: VS Code REST Client extension
• CLI: httpYac

Example usage using httpYac:

httpyac HealthzApi.http

Test: 🧪

dotnet test ./tests/Healthz.Api.Tests/ --configuration Release

Configuration: ⚙️

Alter configuration or environment variables to change the output of the health checks.

Dotnet CLI: 💻

Alter the HealthCheck section within appsettings.Development.json and re-run.

{
  /*config removed for brevity*/
  "HealthCheck": {
    "MyCustomStartUpHealthCheck": "False",
    "UriCheck": "https://matthewregis.dev/"
  }
}

Docker: 🐋

Alter the environment section within docker-compose.yaml and re-run.

version: "3"
services: 
    healthzapi:
        environment:
            HealthCheck__MyCustomStartUpHealthCheck: "False"
            HealthCheck__UriCheck: "https://matthewregis.dev"
# config removed for brevity #