Healthie.NET.CosmosDb 4.1.0

Prefix Reserved
dotnet add package Healthie.NET.CosmosDb --version 4.1.0
                    
NuGet\Install-Package Healthie.NET.CosmosDb -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.CosmosDb" 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.CosmosDb" Version="4.1.0" />
                    
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.0
                    
#r "nuget: Healthie.NET.CosmosDb, 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.CosmosDb@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.CosmosDb&version=4.1.0
                    
Install as a Cake Addin
#tool nuget:?package=Healthie.NET.CosmosDb&version=4.1.0
                    
Install as a Cake Tool

Healthie.NET - Trust your uptime

Healthie.NET.CosmosDb

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.

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

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