Healthie.NET.CosmosDb 4.1.2

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Healthie.NET.CosmosDb --version 4.1.2
                    
NuGet\Install-Package Healthie.NET.CosmosDb -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.CosmosDb" 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.CosmosDb" Version="4.1.2" />
                    
Directory.Packages.props
<PackageReference Include="Healthie.NET.CosmosDb" />
                    
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.CosmosDb --version 4.1.2
                    
#r "nuget: Healthie.NET.CosmosDb, 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.CosmosDb@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.CosmosDb&version=4.1.2
                    
Install as a Cake Addin
#tool nuget:?package=Healthie.NET.CosmosDb&version=4.1.2
                    
Install as a Cake Tool

Healthie.NET - Trust your uptime

Healthie.NET.CosmosDb

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.

Azure CosmosDB IStateProvider implementation for Healthie.NET. Persists pulse checker state to CosmosDB for durable storage across application restarts and distributed environments.

Installation

dotnet add package Healthie.NET.CosmosDb

Usage

using Healthie.StateProviding.CosmosDb;
using Microsoft.Azure.Cosmos;

var cosmosClient = new CosmosClient("your-connection-string");

builder.Services
    .AddHealthie(typeof(Program).Assembly)
    .AddHealthieCosmosDb(cosmosClient, "your-database", "healthie-state");

The container is created on startup if it does not exist. The database is not, so create it yourself or point at an existing one.

If you would rather build the Container yourself, the original overload still works:

var container = cosmosClient.GetContainer("your-database", "healthie-state");

builder.Services
    .AddHealthie(typeof(Program).Assembly)
    .AddHealthieCosmosDb(container);

Important: The CosmosDB container must use /id as the partition key path. Startup fails with a clear error if an existing container is partitioned differently.

Key Types

Type Description
StartupExtensions.AddHealthieCosmosDb() Registers CosmosDbStateProvider as the singleton IStateProvider and CosmosDbStateProviderInitializer as an IStateProviderInitializer.
CosmosDbStateProvider Implements IStateProvider using CosmosDB point reads, bulk reads, and upserts.
CosmosDbStateProviderInitializer Creates the container on startup if it is missing and validates its partition key path.

How It Works

  • Each pulse checker's state is stored as a document with the checker's fully-qualified name as both the id and partition key.
  • GetStateAsync reads the document by id; returns default on 404 NotFound.
  • GetStatesAsync sends all requested id and partition-key pairs through CosmosDB's ReadManyItemsAsync, so a dashboard load or leader renewal does not wait for one sequential network call per checker.
  • Each document records the assembly-qualified type of the state it holds, and reading it as a different type throws rather than returning a mismatched state. Documents written before the type was recorded carry no type and are read as-is.
  • SetStateAsync upserts the document, creating or replacing it atomically.

Concurrency

Writes can be made conditional. GetStateEntryAsync returns the state together with the document's ETag, and TrySetStateAsync sends it as If-Match, so a write made from a state that has since changed is refused (CosmosDB answers 412 PreconditionFailed) rather than silently overwriting whoever changed it. When nothing is stored yet there is no ETag to match, so the write becomes a create, which CosmosDB refuses a second time with 409 Conflict — the same guarantee at the one moment there is nothing to compare.

A refused write is reported as false, not thrown. Under contention losing is the expected outcome and the answer is always the same: read again, reapply, write again. StateProviderExtensions.UpdateStateAsync is that loop. Both writers go through it — the setting change and the check storing its result — which is what makes the guarantee hold in both directions: a check that read the state before a setting changed no longer writes the old setting back over it.

SetStateAsync still upserts unconditionally. It replaces a whole document with one the caller supplies, so there is no version to carry and nothing to compare — it is the escape hatch, not the path the library takes.

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

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
4.1.4 100 9/30/2026
4.1.3 88 9/29/2026
4.1.2 122 9/12/2026
4.1.1 146 8/14/2026
4.1.0 122 7/30/2026
4.0.0 126 7/30/2026
3.1.4 129 7/19/2026
3.1.3 119 7/18/2026
3.1.2 121 7/18/2026
3.1.1 120 7/18/2026
3.1.0 125 7/17/2026
3.0.0 130 7/15/2026
2.3.0 155 2/24/2026
2.1.1-beta 132 2/24/2026
2.0.0-beta 135 2/22/2026
1.1.0-beta 144 5/31/2025
1.0.0-beta 218 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