MNW #035: Health Checks In ASP .NET Core For Monitoring Your Applications

Read time: 5 minutes

A big thank you to our sponsors who keep this newsletter free to the reader:

Today's issue is sponsored by Rebus Pro. Rebus is a free .NET "service bus", and Rebus Pro is the perfect one-up for serious Rebus users. Use Fleet Manager to get Slack alerts when something fails and retry dead-lettered messages with a click of the mouse.

And by Hasura, an open-source engine that gives instant GraphQL and REST APIs on new or existing SQL Server, enabling teams to ship apps faster.

We all want to build robust and reliable applications that can scale indefinitely and handle any number of requests.

But with distributed systems and microservices architectures growing in complexity, it's becoming increasingly harder to monitor the health of our applications.

It's vital that you have a system in place to receive quick feedback of your application health.

That's where health checks come in.

Health checks provide a way to monitor and verify the health of various components of an application including:

Databases
APIs
Caches
External services

Here's what I'll show you in this week's newsletter:

What are health checks
Adding a custom health check
Using existing health check libraries
Customizing the health checks response format

Let's see how to implement health checks in ASP .NET Core.

What Are Health Checks?

Health checks are a proactive mechanism for monitoring and verifying the health and availability of an application in ASP .NET Core.

ASP .NET Core has built-in support for implementing health checks.

Here's the basic configuration, which registers the health check services and adds the HealthCheckMiddleware to respond at the specified URL.

The health check returns a HealthStatus value indicating the health of the service.

There are three distinct HealthStatus values:

HealthStatus.Healthy
HealthStatus.Degraded
HealthStatus.Unhealthy

You can use the HealthStatus to indicate the different states of your application.

For example, if the application is functioning slower than expected you can return HealthStatus.Degraded.

Adding Custom Health Checks

You can create custom health checks by implementing the IHealthCheck interface.

For example, you can implement a check to see if your SQL database is available.

It's important to use a query that can complete quickly in the database, like SELECT 1.

Here's a custom health check implementation example in the SqlHealthCheck class:

After you implement the custom health check, you need to register it.

The previous call to AddHealthChecks now becomes:

We're giving it a custom name and setting which status to use as the failure result in HealthCheckContext.Registration.FailureStatus.

But stop and think for a moment.

Do you want to implement a custom health check on your own for every external service that you have?

Of course not! There's a better solution.

Using Existing Health Check Libraries

Before you start implementing a custom health check for everything, you should first see if there's already an existing library.

In the AspNetCore.Diagnostics.HealthChecks repository you can find a wide collection health check packages for frequently used services and libraries.

Here are just a few examples:

SQL Server - AspNetCore.HealthChecks.SqlServer
Postgres - AspNetCore.HealthChecks.Npgsql
Redis - AspNetCore.HealthChecks.Redis
RabbitMQ - AspNetCore.HealthChecks.RabbitMQ
AWS S3 - AspNetCore.HealthChecks.Aws.S3
SignalR - AspNetCore.HealthChecks.SignalR

Here's how to add health checks for PostgreSQL and RabbitMQ:

Formatting Health Checks Response

By default, the endpoint returning you health check status will return a string value representing a HealthStatus.

This isn't practical if you have multiple health checks configured, as you'd want to view the health status individually per service.

To make matters worse, if one of the services is failing the entire response will return Unhealthy and you don't know what's causing the issue.

You can solve this by providing a ResponsWriter, and there's an existing one in the AspNetCore.HealthChecks.UI.Client library.

Let's install the NuGet package:

And you need to slightly update the call to MapHealthChecks to use the ResponseWriter coming from this library:

After making these changes, here's what the response from the health check endpoint looks like:

Takeaway

Application monitoring is important to track availability, resource usage, and changes to performance in your application.

I've used health checks before to implement failover scenarios in a cloud deployment. When one application instance stops responding with a healthy result, a new one is created to continue serving requests.

It's easy to monitor the health of your ASP .NET Core applications by exposing health checks for your services.

You can decide to implement custom health checks, but first consider if there are existing solutions.

Thank you for reading, and have an awesome Saturday.

Whenever you're ready, there are 3 ways I can help you 🎁

To access all of the source code that I use in my YouTube videos support me on Patreon
For more practical & in-depth coding examples subscribe to my YouTube channel
Promote yourself to 15.000+ subscribers by sponsoring this newsletter (booked out 2 months)

Want a better way to get the latest news? 📰

If you're tired of clickbait and partisanship in the news, consider a news aggregator called the Otherweb. It's free, ad-free and junk-free. Check it out here.

You received this email because you subscribed to our list. You can unsubscribe at any time.

Dragise Cvetkovica 2, Niš, 18000, Serbia

MNW #035: Health Checks In ASP.NET Core For Monitoring Your Applications

MNW #035: Health Checks In ASP .NET Core For Monitoring Your Applications

What Are Health Checks?

Adding Custom Health Checks

Using Existing Health Check Libraries

Formatting Health Checks Response

Takeaway

Older messages

MNW #034: Idempotent Consumer - Handling Duplicate Messages

MNW #033: EF Core Raw SQL Queries

MNW #032: How To Use Rate Limiting In ASP .NET Core

MNW #031: Implementing The Saga Pattern With Rebus And RabbitMQ

MNW #030: How To Publish MediatR Notifications In Parallel

You Might Also Like

Deduplication in Distributed Systems: Myths, Realities, and Practical Solutions

How to know if your data has been exposed

⚙️ Amazon and Anthropic

⚡ THN Recap: Top Cybersecurity Threats, Tools & Tips (Nov 18-24)

Researchers Uncover Malware Using BYOVD to Bypass Antivirus Protections

Post from Syncfusion Blogs on 11/25/2024

Is there more to your iPhone?

🎉 Black Friday Early Access: 50% OFF

Open Pull Request #59

Last chance to register: SecOps made smarter