Healthie.NET.CosmosDb 3.1.2

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Healthie.NET.CosmosDb --version 3.1.2
                    


                    

                
NuGet\Install-Package Healthie.NET.CosmosDb -Version 3.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="3.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="3.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 3.1.2
                    


                    

                
#r "nuget: Healthie.NET.CosmosDb, 3.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@3.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=3.1.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Healthie.NET.CosmosDb&version=3.1.2
                    


                            Install as a Cake Tool

Healthie.NET - Trust your uptime

Healthie.NET.CosmosDb

NuGet

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 ReadItemAsync / UpsertItemAsync.
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.
  • 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 are last-write-wins. When two writers read the same state and write it back concurrently — a scheduled check and a dashboard-initiated setting change, say — whichever writes last is kept, and the other's change is lost.

For check results that is the wanted behavior: the most recent result is the interesting one. For setting changes it is a real limitation. Resolving it needs a concurrency token on IStateProvider itself, which is planned for the next major version; guarding the write with an ETag underneath the current interface can only turn a lost update into a failed write, and a failed write is recorded as a failed health check.

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.0 37 7/30/2026
4.0.0 38 7/30/2026
3.1.4 96 7/19/2026
3.1.3 92 7/18/2026
3.1.2 92 7/18/2026
3.1.1 86 7/18/2026
3.1.0 95 7/17/2026
3.0.0 96 7/15/2026
2.3.0 134 2/24/2026
2.1.1-beta 118 2/24/2026
2.0.0-beta 119 2/22/2026
1.1.0-beta 132 5/31/2025
1.0.0-beta 205 5/18/2025

### Fixed

- The prerendered dashboard no longer risks dropping its own circuit on a board with much state.
 3.1.1 carried the states from prerender to the interactive render by persisting them into the
 page, which put the whole board -- every checker and all its history -- on the SignalR circuit.
 That payload grows with each checker, and past SignalR's default 32&#160;KB message limit the hub
 rejects it and the circuit never starts: the board freezes on the prerendered snapshot, styled but
 not live. The states now stay on the server between the two renders (Blazor Server holds them there
 already) and only a short-lived token travels to the browser and back, so the wire cost is constant
 whatever the size of the board. A token that no longer resolves falls back to a fresh read. No
 SignalR limit needs raising, so no extra memory or denial-of-service exposure comes with it.

### Fixed

- The dashboard no longer flickers on load when it is prerendered. Hosted the usual
 way -- `<HealthieDashboard />` on an interactive-server page, which prerenders by
 default -- the server rendered the full board, then the circuit connected a moment
 later and the component started again from an empty state, read every checker afresh,
 and briefly replaced the board already on screen. In that gap a status icon, which the
 dashboard stylesheet sizes against its surroundings, painted for a frame before those
 rules applied and filled the board as one large ring. The states the prerender reads
 are now carried across to the interactive render through `PersistentComponentState`,
 so the first interactive render matches the prerendered one: nothing is replaced, no
 frame shows an unsized icon, and the redundant second read of every checker is gone.

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