Skip to content

Various health checks based on `Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck`

License

Notifications You must be signed in to change notification settings

dailydevops/healthchecks

Repository files navigation

HealthChecks

GitHub GitHub top language GitHub repo size GitHub Pipeline CI

CodeFactor Grade Codecov Quality Gate Status Technical Debt

What is this repository about?

This is a mono repository for several NuGet packages based on the Microsoft.Extensions.Diagnostics.HealthChecks package. The main goal of this repository is to provide a set of health checks for different services and frameworks, which are fully configurable either via code or configuration.

What is the difference between this repository and the AspNetCore.Diagnostics.HealthChecks repository?

The main difference is that we try to focus on providing packages that are fully configurable via code or configuration. This means that you can configure the health checks in your Program.cs file, or in your appsettings.json file, or in any other configuration provider. In some cases, we provide the same healthcheck for a service with an alternative implementation. For example, we provide a healthcheck for MySql that is based on MySql.Data and one that is based on MySqlConnector. This allows you to choose the implementation that best suits your needs or fits your existing dependencies. In addition, we try to support the latest LTS and STS versions of .NET (.NET Support Policy) as well as the latest preview version of .NET for at least 3 years, but we can't guarantee this. This depends on the support of related NuGet packages and the .NET platform itself. See the Supported .NET Version section for more details.

NuGet packages

The following table lists all currently available NuGet packages. For more details about the packages, please visit the corresponding NuGet page.

Package Name Current Version Downloads
NetEvolve.HealthChecks
Contains general application HealthChecks.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.Abstractions
Contains abstract implementations for the NetEvolve.HealthChecks.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.Apache.Kafka
Contains HealthChecks for Apache Kafka, based on the NuGet package Confluent.Kafka.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.Azure.Blobs
Contains HealthChecks for Azure Blob Storage.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.Azure.Queues
Contains HealthChecks for Azure Queue Storage.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.Azure.Tables
Contains HealthChecks for Azure Table Storage.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.ClickHouse
Contains HealthChecks for ClickHouse, based on the nuget package ClickHouse.Client.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.Dapr
Contains HealthChecks for Dapr, based on the nuget package Dapr.Client.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.MySql
Contains HealthChecks for MySql, based on the nuget package MySql.Data.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.MySql.Connector
Contains HealthChecks for MySql, based on the nuget package MySqlConnector.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.Npgsql
Contains HealthChecks for PostgreSQL, based on the nuget package Npgsql.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.Oracle
Contains HealthChecks for Oracle Databases, based on the nuget package Oracle.ManagedDataAccess.Core.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.Redis
Contains HealthChecks for Redis, based on the NuGet package StackExchange.Redis.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.Redpanda
Contains HealthChecks for Redpanda, based on the NuGet package Confluent.Kafka. This is a temporary measure; if a dedicated Redpanda client is provided in the future, we will use it immediately.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.SqlEdgeDEPRECATED
Contains HealthChecks for SqlEdge, based on the nuget package Microsoft.Data.SqlClient.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.SQLite
Contains HealthChecks for SQLite, based on the nuget package Microsoft.Data.Sqlite.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.SqlServer
Contains HealthChecks for Microsoft SqlServer, based on the nuget package Microsoft.Data.SqlClient.
NuGet Version NuGet Downloads
NetEvolve.HealthChecks.SqlServer.Legacy
Contains HealthChecks for Microsoft SqlServer, based on the nuget package System.Data.SqlClient.
NuGet Version NuGet Downloads

Package naming explanation

The package names are based on the following naming schema - NetEvolve.HealthChecks.<GroupName?>.<ServiceName>

The GroupName is optional and is used to group related services. For example, all azure platform services are grouped under Azure. The ServiceName is the name of the service for which the health check is provided. For example, SqlServer or MySql.

The following table lists all planned and used groups. We will add more groups maybe in the future, if the demand is there.

  • Apache
  • AWS
  • Azure
  • GCP

Supported .NET version

We try to support the LTS and STS versions of .NET (.NET Support Policy), as well as the latest preview version of .NET. We will try to support each framework version for at least 3 years, but we can't guarantee it. This depends on the support of related NuGet packages and the .NET platform itself.

.NET Version Supported
.NET Standard ❌ No
.NET 7.0 or earlier versions ❌ No
.NET 8.0 ✅ Yes
.NET 9.0 ✅ Yes

Why did we choose this approach? Because we want to be able to take advantage of the latest language features of the .NET platform and the performance gains that come with them. We know that not all of our NuGet packages will gain performance from this, but this is our general strategy and nobody knows what the future will bring.

Where can I find more information about the end-of-life (EOL) date for the relevant components?

To get more information about the end-of-life (EOL) date for the relevant components, please visit the website of the creators of the components or try the website endoflife.date.

Why not .NET Standard?

With the .NET Standard Microsoft created a specification for APIs that are intended to be available on all .NET implementations. This was a great idea, but it also has some drawbacks. The main drawback is that the .NET Standard is a specification and not an implementation. This means that the real work is done by .NET implementations, such as .NET 5.0 and later versions. Which is why we decided us against the .NET Standard and for the concrete .NET implementations.

See The future of .NET Standard for more details.

About

Various health checks based on `Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck`

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Contributors 4

  •  
  •  
  •  
  •