Healthie.NET.Abstractions 4.1.0

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

Healthie.NET - Trust your uptime

Healthie.NET.Abstractions

NuGet

Live demo — healthie.compiletheory.com — a read-only Healthie.NET dashboard watching real status pages (Anthropic, OpenAI, GitHub, Cloudflare, and more), built from these packages.

Core interfaces, models, enums, and the PulseChecker abstract base class for the Healthie.NET health monitoring framework. This package contains no implementations -- only the contracts and types that all other Healthie.NET packages depend on.

Installation

dotnet add package Healthie.NET.Abstractions

Usage

Inherit from PulseChecker and override CheckAsync to implement a health check:

using Healthie.Abstractions;
using Healthie.Abstractions.Enums;
using Healthie.Abstractions.Models;
using Healthie.Abstractions.StateProviding;

public class DatabasePulseChecker : PulseChecker
{
    private readonly IDbConnectionFactory _db;

    public DatabasePulseChecker(IStateProvider stateProvider, IDbConnectionFactory db)
        : base(stateProvider, PulseInterval.Every30Seconds, unhealthyThreshold: 3)
    {
        _db = db;
    }

    public override async Task<PulseCheckerResult> CheckAsync(
        CancellationToken cancellationToken = default)
    {
        using var conn = await _db.CreateConnectionAsync(cancellationToken);
        return new PulseCheckerResult(PulseCheckerHealth.Healthy, "OK");
    }
}

Key Types

Type Description
PulseChecker Abstract base class -- inherit to create a health check.
IPulseChecker Full pulse checker contract (IPulse + IState + IAsyncDisposable).
IStateProvider Contract for state persistence (GetStateAsync / SetStateAsync).
IPulseScheduler Contract for scheduling (ScheduleAsync / UnscheduleAsync).
PulseCheckerResult Record returned from CheckAsync with Health and Message.
PulseCheckerState Record holding interval, threshold, failure count, history, tags, group, pin, and last result.
PulseCheckerHealth Enum: Healthy, Suspicious, Unhealthy.
PulseInterval Enum: 13 intervals from EverySecond to Every5Minutes.
HealthieOptions Global options (e.g. MaxHistoryLength).

Describing a checker

A checker can say where it belongs and what it is, and both are picked up by the dashboard.

public class RedisCachePulseChecker(IStateProvider stateProvider) : PulseChecker(stateProvider)
{
    public override string DisplayName => "Redis Cache";

    // One group at most: this is where the checker lives.
    public override string DefaultGroup => "Data Stores";

    // Any number of tags: these describe it, and may cut across groups.
    public override IReadOnlyList<string> DefaultTags => ["tier-1", "cache"];

    public override Task<PulseCheckerResult> CheckAsync(CancellationToken cancellationToken = default)
        => /* ... */;
}

Both seed PulseCheckerState the first time a checker runs and are never applied again, so a change made later -- through SetGroupAsync / SetTagsAsync, or on the dashboard -- survives a restart rather than being reset to what the code says.

SetPinnedAsync sorts a checker above the rest. A pin is stored with the checker rather than per viewer, on the grounds that the checks worth watching are the same for everyone.

See Also

Back to main README

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.

NuGet packages (15)

Showing the top 5 NuGet packages that depend on Healthie.NET.Abstractions:

Package Downloads
Healthie.NET.DependencyInjection

Dependency injection registration helpers for Healthie.NET -- assembly scanning, service registration, and a built-in timer scheduler.

Healthie.NET.Api

ASP.NET Core API endpoints for Healthie.NET -- exposes RESTful endpoints for managing pulse checkers with configurable routing and authorization.

Healthie.NET.Dashboard

Blazor health monitoring dashboard for Healthie.NET -- zero-dependency UI with real-time event-driven state updates, checker management, and configurable authorization.

Healthie.NET.Quartz

Quartz.NET scheduling provider for Healthie.NET -- persistent, CRON-based pulse check scheduling with clustering support.

Healthie.NET.CosmosDb

Azure CosmosDB state provider for Healthie.NET -- persists pulse checker state to CosmosDB for durable cross-restart storage.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.1.0 72 7/30/2026
4.0.0 68 7/30/2026
3.1.4 226 7/19/2026
3.1.3 209 7/18/2026
3.1.2 221 7/18/2026
3.1.1 214 7/18/2026
3.1.0 231 7/17/2026
3.0.0 224 7/15/2026
2.3.0 1,967 2/24/2026
2.1.1-beta 193 2/24/2026
2.0.0-beta 198 2/22/2026
1.1.0-beta 195 5/31/2025
1.0.0-beta 276 5/18/2025

Twenty packages was too many, and two of them had no business being separate. This release fixes
that without breaking anything: **an application on 4.0.0 upgrades by changing nothing.**

### Added

- **`Healthie.NET`**, the package to install first. It carries no code of its own, only a dependency
 on `Healthie.NET.DependencyInjection`, so it is one install and one dependency rather than a
 bundle -- no provider, scheduler or UI framework arrives with it. The name people guess did not
 exist before, and the actual entry point was called `DependencyInjection`, which reads like
 plumbing rather than the way in.
- **Uptime reporting and leader election are in the core package.** `AddHealthieUptime()` and
 `AddHealthieLeaderElection()` need nothing else installed. Both stay opt-in: nothing runs until
 you call them.

### Deprecated

- **`Healthie.NET.Uptime`** and **`Healthie.NET.LeaderElection`**. Neither carried a third-party
 dependency, so keeping them separate cost two installs and saved nothing -- the provider packages
 exist to keep Npgsql or Temporalio off machines that do not use them, and these two were not
 providers.

 **Nothing breaks.** Both packages are still published, now as assemblies of type forwards, so an
 application that references either keeps compiling *and* keeps running untouched. That is what
 makes this a minor release: moving a type between assemblies is a binary break the compiler cannot
 see, because source keeps building and only the runtime finds out. Remove the reference whenever it
 suits you; neither package will gain features.

### Fixed

- **The sample Dockerfiles took their .NET base images by mutable tag.** A tag is a different image
 next week, so the build that passed review is not the build that ships. Both are pinned by digest,
 which Dependabot updates the way it updates a package version. Closes four OpenSSF Scorecard
 *Pinned-Dependencies* findings.

### Security

- **An Azure CosmosDB key committed in May 2025 was confirmed dead and the alert closed.** It had
 already been removed from the working tree; the account it belonged to no longer exists in the
 owning tenant, verified by enumerating every Cosmos account across that tenant's subscriptions, so
 the key authenticates to nothing. It remains in history at `ee0c78e`, inert.
- **Stray screenshots can no longer be committed.** Root-level PNGs are ignored, scoped to the root
 so the images the docs and samples genuinely ship are untouched.

Full changelog: https://github.com/ivanvyd/Healthie.NET/blob/v4.1.0/CHANGELOG.md