Healthie.NET.Abstractions 4.1.2

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Healthie.NET.Abstractions --version 4.1.2
                    


                    

                
NuGet\Install-Package Healthie.NET.Abstractions -Version 4.1.2
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.2" />
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.2" />
                    


                            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.2
                    


                    

                
#r "nuget: Healthie.NET.Abstractions, 4.1.2"
#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.2
#: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.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Healthie.NET.Abstractions&version=4.1.2
                    


                            Install as a Cake Tool

Healthie.NET - Trust your uptime

Healthie.NET.Abstractions

NuGet

▶ Live demo — board.healthie-dotnet.dev — a read-only Healthie.NET dashboard watching real status pages (Anthropic, OpenAI, GitHub, Cloudflare, and more), built from these packages. Full documentation at healthie-dotnet.dev.

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.2 98 9/12/2026
4.1.1 429 8/14/2026
4.1.0 490 7/30/2026
4.0.0 453 7/30/2026
3.1.4 244 7/19/2026
3.1.3 229 7/18/2026
3.1.2 240 7/18/2026
3.1.1 235 7/18/2026
3.1.0 243 7/17/2026
3.0.0 241 7/15/2026
2.3.0 1,980 2/24/2026
2.1.1-beta 197 2/24/2026
2.0.0-beta 204 2/22/2026
1.1.0-beta 203 5/31/2025
1.0.0-beta 280 5/18/2025

### Fixed

- The dashboard event-log and about dialogs now move focus inside, keep keyboard focus contained,
 close with Escape, and restore focus to the control that opened them.
- Dashboard checker rows now expose selection as a real button alongside their action buttons,
 removing nested interactive controls while preserving whole-row pointer selection.
- A dashboard state-provider failure now shows a recoverable unavailable state with a retry action
 instead of looking like an empty installation with no registered checkers.
- The Blazor sample now keeps the dashboard stylesheet in its static host head, preventing an
 unstyled flash while the interactive head reconnects on a slow network.
- HTTP checker display names and result messages now omit URI user information, query strings, and
 fragments, server-controlled reason phrases, and transport exception details, preventing embedded
 credentials and tokens from reaching stored history, alerts, logs, or the dashboard while requests
 still use the complete configured URI.
- Alert-history persistence now loads durable history before its first post-restart write and
 coalesces changes raised during a slow state-provider write into one latest-state follow-up. This
 preserves earlier alerts without duplicating the new one and avoids an unbounded queue of tasks
 and redundant full-history writes during alert bursts.
- The Web API sample maps its unauthenticated management API and mutation-enabled MCP endpoint only
 in Development, so deploying the sample with a production environment no longer exposes those
 local demonstration surfaces. Liveness and readiness probes remain available.
- History clearing and startup trimming now use optimistic concurrency, so they no longer overwrite
 a check result or setting changed by another replica between the read and write.
- Leader election now serializes schedule changes with leadership transitions and reconciles every
 registered checker's persisted active state and schedule through a bulk read on lease renewal. A
 pause or cadence change made through another replica now reaches the leader, a fresh leader
 removes inactive durable jobs left by the previous process, and reconciliation runs with bounded
 concurrency while an independent lease heartbeat prevents slow scheduler calls from expiring an
 otherwise healthy leader. Partial and cancelled transitions remain tracked until cleanup succeeds,
 and shutdown does not release the lease over work it could not stop.
- CosmosDB multi-state reads now use `ReadManyItemsAsync`, avoiding one sequential network round
 trip per checker during dashboard loads and leader renewal.
- The in-memory lease provider now returns exactly one winner when replicas contend concurrently.
- Coravel, Hangfire, Temporal, and the leader-election decorator now validate schedules before they
 are persisted. Cronos expressions requiring an absent jitter seed are reported as validation
 failures instead of escaping as server errors. The built-in timer also rejects periods outside
 `PeriodicTimer`'s supported range before replacing a working schedule.
- Temporal now preserves Healthie.NET's six-field, leading-seconds cron meaning by translating it
 to Temporal's seven-field seconds form. It rejects Cronos-only relative-day and descending-range
 expressions whose Temporal meaning differs, and fixed periods outside Temporal's supported range,
 before an existing schedule is removed.
- Uptime recording now starts a new observation segment on the first fresh result after a process
 restart, even when its health matches persisted state. Time while no process was observing the
 checker remains unknown, and a transition that finds the bounded queue full is retried by the next
 fresh result.

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