Code Monkey home page Code Monkey logo

rimdev.aspnet.diagnostics.healthchecks's Introduction

RimDev.AspNet.Diagnostics.HealthChecks

ASP.NET full framework implementation of ASP.NET Core health checks.

Usage

The recommended installation method is the RimDev.AspNet.Diagnostics.HealthChecks NuGet package.

PM> Install-Package RimDev.AspNet.Diagnostics.HealthChecks

Then, use it like this in an OWIN Startup class:

public class Startup
{
    public void Configuration(IAppBuilder app)
    {
        app.UseHealthChecks(
            "/_health",
            new NoopHealthCheck(),
            new PingHealthCheck(new PingHealthCheckOptions().AddHost("localhost", 1000)));
    }
}

Usage with Health Checks UI

To use with the Health Checks UI project named health checks should be used and a special ResponseWriter needs to be configured. This returns the checks with more specific information about each check in a format that the UI project can read.

public class Startup
{
    public void Configuration(IAppBuilder app)
    {
        app.UseHealthChecks(
            "/_health_ui",
            new HealthCheckOptions
            {
                ResponseWriter = UIResponseWriter.WriteHealthCheckUIResponse
            },
            new HealthCheckWrapper(new NoopHealthCheck(), "Noop health check"),
            new HealthCheckWrapper(new PingHealthCheck(new PingHealthCheckOptions().AddHost("localhost", 1000)), "Ping to localhost"));
    }
}

The UI can't be hosted in a full framework app but can easily be setup using the official docker image for those who doesn't already have a UI project set up.

Requirements

  • .NET Framework 4.6.2 or later

License

MIT

rimdev.aspnet.diagnostics.healthchecks's People

Contributors

andrewrady avatar billbogaiv avatar czy5074 avatar dependabot[bot] avatar karl-sjogren avatar kendaleiv avatar khalidabuhakmeh avatar schilco-rimdev avatar sobieck avatar tgharold avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

rimdev.aspnet.diagnostics.healthchecks's Issues

Support for publishers

Supporting health checks in ASP.NET, MVC, etc. is a great idea. Any plans for supporting publishers like in ASP.NET Core?

`HealthCheckWrapper` should have an optional param to define `failureStatus`

Notice how it's impossible to set a failureStatus:

What business problem is this hoping to solve?

I'm trying to lower the severity of some health checks (e.g., from an UriHealthCheck, notice how it takes the failure status from the Registration: https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/blob/50594f0643515e83f9bf6ce864f9594bf980b865/src/HealthChecks.Uris/UriHealthCheck.cs#L32)

Add Role Control For UI

๐Ÿ”ง Enhancement Request

I don't want to anyone see HealthCheck_UI, so I want to control request is authorized. I sent a PR about that.

Support for Health Check Names

Health checks are only identified by their type, so only one health response will be returned per type. Adding support for name will allow multiple health checks of the same type.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.