ReactiveProbes 1.3.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package ReactiveProbes --version 1.3.0
                    


                    

                
NuGet\Install-Package ReactiveProbes -Version 1.3.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="ReactiveProbes" Version="1.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ReactiveProbes" Version="1.3.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ReactiveProbes" />
                    


                            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 ReactiveProbes --version 1.3.0
                    


                    

                
#r "nuget: ReactiveProbes, 1.3.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 ReactiveProbes@1.3.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=ReactiveProbes&version=1.3.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ReactiveProbes&version=1.3.0
                    


                            Install as a Cake Tool

ReactiveProbes

.NET Coverage NuGet NuGet Repo

An ASP.NET startup probe built with reactive extensions. It validates all registered health checks and marks the startup as ready. It exposes a /ready endpoint that returns healthy or unhealthy for startup probes to mark the API as ready or not.

Features

  • Validates all registered health checks.
  • Marks the startup as ready based on health checks.
  • Exposes a /ready endpoint for readiness probes.
  • Adds REST API health checks.
  • Adds SQL Server health checks using connection strings or EF Core DbContext.
  • Registers reactive health probes with /start and /stop endpoints.

Installation

To include ReactiveProbes in your project, you can use the following NuGet package:

dotnet add package ReactiveProbes

Usage

Register the health checks in your ASP.NET web API.

Add ReactiveProbes to your startup:

services.AddReactiveProbes();

Register the probes:

app.RegisterReactiveStartupProbe();

The /ready endpoint will be available to check the readiness of your application.

Adding REST API Health Checks

To add a REST API health check:

services.AddHealthChecks()
        .AddRestApiCheck("api-check", "https://api.example.com/health");
Adding SQL Server Health Checks

To add a SQL Server health check using a connection string from the configuration:

services.AddHealthChecks()
        .AddSqlServerCheck("DefaultConnection");

To add a SQL Server health check using an EF Core DbContext:

services.AddHealthChecks()
        .AddSqlServerCheck<MyDbContext>();
Registering Reactive Health Probes

To register reactive health probes with start and stop endpoints:

app.RegisterReactiveHealthProbe();

This sets up the following endpoints:

  • /health to display the health check status
  • /health/stop to stop the health checks
  • /health/start to start the health checks

Contributing

Feel free to submit issues, fork the repository and send pull requests!

License

This project is licensed under the MIT License.

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
1.3.0 148 12/21/2025
1.2.0 153 1/28/2025
1.1.0 149 12/23/2024
1.0.2 178 12/12/2024
1.0.1 166 12/9/2024
1.0.0 166 12/7/2024