Nummy.HealthChecker
2.2.0
dotnet add package Nummy.HealthChecker --version 2.2.0
NuGet\Install-Package Nummy.HealthChecker -Version 2.2.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Nummy.HealthChecker" Version="2.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Nummy.HealthChecker" Version="2.2.0" />
<PackageReference Include="Nummy.HealthChecker" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Nummy.HealthChecker --version 2.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Nummy.HealthChecker, 2.2.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Nummy.HealthChecker@2.2.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Nummy.HealthChecker&version=2.2.0
#tool nuget:?package=Nummy.HealthChecker&version=2.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Nummy Health Checker package for .NET Core
Overview
This is a .NET Core library for health checking in your application.
Installation
or install the package via NuGet Package Manager Console:
Install-Package Nummy.HealthChecker
Getting Started
1. Run Nummy on your Docker
2. Add your application in Nummy
3. Configure in your project
In your Program.cs file add the following line:
using Nummy.HealthChecker.Extensions;
using Nummy.HealthChecker.Entites;
// .. other configurations
// Register checker and configure the check
builder.Services.AddNummyHealthChecker(options =>
{
options.Path = "/nummy/health"; // default is /nummy/health
options.CheckTimeout = TimeSpan.FromSeconds(30); // default is 30 seconds
options.CheckAsync = async (sp, ct) =>
{
// Example: use services from DI
// var db = sp.GetRequiredService<MyDbContext>();
// await db.Database.ExecuteSqlRawAsync("SELECT 1", ct);
// For now: simple "OK"
return new NummyHealthResult
{
IsHealthy = true,
Message = "Service is healthy"
};
};
});
// .. other configurations
var app = builder.Build();
// Map Health endpoint
app.MapNummyHealthChecker();
// Other endpoints, e.g. controllers
app.MapControllers();
// .. other configurations
4. Now, your application is set up using the Nummy Health Checker.
You can see its status in Nummy.
License
This library is licensed under the MIT License.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net9.0
- Microsoft.AspNetCore.Http (>= 2.3.0)
- Microsoft.Extensions.Options (>= 9.0.5)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.