Tago.Extensions.Healthcheck 6.0.0

Health Check Response Writer

Overview

The Health Check Response Writer is a NuGet package for C# that allows you to customize health check responses, manage routes for each endpoint, and set a parent route for all health endpoints. This package is designed to provide flexibility and control over how health check information is presented and accessed in your application.

Features

• Customizable Responses: Tailor the health check responses to meet your specific needs.
• Response Services: Utilize built-in services to generate health check responses.
• Route Management: Easily manage routes for individual health check endpoints.
• Parent Route Configuration: Set a parent route for all health endpoints to streamline access.

Installation

To install the Health Check Response Writer package, run the following command in the Package Manager Console:

Install-Package Tago.Extensions.Healthcheck

Usage

Basic Setup

1. Add the package to your project:

   using Tago.Extensions.Healthcheck;
   

2. Configure the health check response writer in your Program.cs / Startup.cs:

   builder.Services.AddHealthChecks()
    .WithApplicationInfo((sp, o) =>
    {
        o.Add("appName", "test");
        o.Add("environment", "test");
    })
    .AddMemoryHealthcheck(1024)
    .AddCheck<TestHealth>("test", tags: new[] { "startup" })
    //.AddHttpEndpointHealthCheck("http", new Microsoft.Extensions.Diagnostics.HealthChecks.HttpEndpointHealthCheckOptions
    //{
    //    Url = "https://tag-solutions.com",
    //    Method = HttpRequestMethods.Get,
    //    ReadResponse = false,
    //    TimeOut = TimeSpan.FromSeconds(5)
    //})    
    ;
   
     app.MapHealthCheckRoutes()
     .MapReadynessEndpoint(predicate: (reg) => {
         return reg?.Tags?.Contains("startup") != true;
     })
     .MapLivenessEndpoint()
     .MapConfiguarionEndpoint("config")
     .MapEndpoint("started", (reg) => {
         return reg?.Tags?.Contains("startup") == true;
     })
     ;
   

Customizing Responses

You can customize the health check responses by modifying the ConfigureResponse option. This allows you to format the response based on your requirements.

builder.Services.AddHealthCheckResponseWriter<MyResponseWriter>();

 app.MapHealthCheckRoutes("hc")
     .MapEndpoint<MyResponseWriter>("some-endpoint");

Setting a Parent Route

You can set a parent route for all health endpoints to make them accessible under a common path.

app.MapHealthCheckRoutes("service-health")
     .MapReadynessEndpoint("ready")
     .MapLivenessEndpoint("alive")
     ;

License

This project is licensed under the MIT License.