Eigenverft.WebLib.HealthProbes 1.0.0.5

dotnet add package Eigenverft.WebLib.HealthProbes --version 1.0.0.5
                    
NuGet\Install-Package Eigenverft.WebLib.HealthProbes -Version 1.0.0.5
                    
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="Eigenverft.WebLib.HealthProbes" Version="1.0.0.5" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Eigenverft.WebLib.HealthProbes" Version="1.0.0.5" />
                    
Directory.Packages.props
<PackageReference Include="Eigenverft.WebLib.HealthProbes" />
                    
Project file
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 Eigenverft.WebLib.HealthProbes --version 1.0.0.5
                    
#r "nuget: Eigenverft.WebLib.HealthProbes, 1.0.0.5"
                    
#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 Eigenverft.WebLib.HealthProbes@1.0.0.5
                    
#: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=Eigenverft.WebLib.HealthProbes&version=1.0.0.5
                    
Install as a Cake Addin
#tool nuget:?package=Eigenverft.WebLib.HealthProbes&version=1.0.0.5
                    
Install as a Cake Tool

Eigenverft.WebLib.HealthProbes

NuGet Version NuGet Downloads Repository CI Targets License

A fixed, dependency-free /health short-circuit for simple liveness probes, with suppression of browser favicon requests caused by that probe.

✨ At a glance

Capability What it does
UseHealthProbeFaviconAware() Add the /health and probe-originated favicon behavior.
GET /health Returns 200 OK, plain-text OK, and no-cache headers.
GET or HEAD /favicon.ico Returns 204 only when the Referer path is exactly /health.

📦 Installation

dotnet add package Eigenverft.WebLib.HealthProbes

🚀 Quick start

Add a simple liveness endpoint

using Eigenverft.WebLib.HealthProbes;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;

app.UseHealthProbeFaviconAware();

// Register before middleware that the health request should bypass.
app.Run(context => context.Response.WriteAsync("application"));

Package behavior

The middleware handles only GET and HEAD for the case-insensitive /health path. GET returns 200 with the body OK; HEAD returns the same status without a body. Both responses use text/plain; charset=utf-8 and set Cache-Control: no-store, no-cache plus Pragma: no-cache. Other methods continue through the pipeline.

A GET or HEAD for /favicon.ico returns 204 only when its Referer resolves to the exact /health path; a query string is allowed. Other favicon requests continue normally. Register the middleware early when probes must bypass later filters.

This is a fixed liveness response. It does not invoke ASP.NET Core health checks or inspect application dependencies. Map a separate readiness endpoint when health status must reflect application services.

🎯 Target frameworks

Targets .NET 8 and .NET 10. A .NET 9 application can consume the compatible net8.0 asset.

📄 License

Licensed under the MIT License by Eigenverft.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  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 is compatible.  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.
  • net10.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0.5 90 9/29/2026
1.0.0.4 87 9/28/2026
1.0.0.3 110 9/12/2026

Initial capability package extracted from Eigenverft.WebLib.Infrastructure.

- ASP.NET Core health probe middleware with favicon-aware handling for lightweight service endpoints.
- Public namespaces and behavior remain compatible with the original Infrastructure implementation.