Microsoft.Extensions.Diagnostics.Probes 9.0.0-preview.9.24556.5

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Framework 4.6.2 This package targets .NET Framework 4.6.2. The package is compatible with this framework or higher.
This is a prerelease version of Microsoft.Extensions.Diagnostics.Probes. 
dotnet add package Microsoft.Extensions.Diagnostics.Probes --version 9.0.0-preview.9.24556.5                

                    
                

            
NuGet\Install-Package Microsoft.Extensions.Diagnostics.Probes -Version 9.0.0-preview.9.24556.5
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="Microsoft.Extensions.Diagnostics.Probes" Version="9.0.0-preview.9.24556.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Microsoft.Extensions.Diagnostics.Probes --version 9.0.0-preview.9.24556.5                

                    
                

            
#r "nuget: Microsoft.Extensions.Diagnostics.Probes, 9.0.0-preview.9.24556.5"
#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. 
// Install Microsoft.Extensions.Diagnostics.Probes as a Cake Addin
#addin nuget:?package=Microsoft.Extensions.Diagnostics.Probes&version=9.0.0-preview.9.24556.5&prerelease

// Install Microsoft.Extensions.Diagnostics.Probes as a Cake Tool
#tool nuget:?package=Microsoft.Extensions.Diagnostics.Probes&version=9.0.0-preview.9.24556.5&prerelease

Microsoft.Extensions.Diagnostics.Probes

Answers Kubernetes liveness, startup, and readiness TCP probes based on the results from the Health Checks service.

Install the package

From the command-line:

dotnet add package Microsoft.Extensions.Diagnostics.Probes

Or directly in the C# project file:

<ItemGroup>
  <PackageReference Include="Microsoft.Extensions.Diagnostics.Probes" Version="[CURRENTVERSION]" />
</ItemGroup>

Usage Example

The health check endpoints can be registered and configured with the following methods:

public static IServiceCollection AddKubernetesProbes(this IServiceCollection services)
public static IServiceCollection AddKubernetesProbes(this IServiceCollection services, IConfigurationSection section)
public static IServiceCollection AddKubernetesProbes(this IServiceCollection services, Action<KubernetesProbesOptions> configure)

Each type of probe handler can have its details configured separately.

services.AddKubernetesProbes(options =>
{
    options.LivenessProbe.TcpPort = 2305;
    options.StartupProbe.TcpPort = 2306;
    options.ReadinessProbe.TcpPort = 2307;
})

The HealthAssessmentPeriod property defines how often the health-checks are assessed. By default 30 seconds.

Each probe can also specify Func<HealthCheckRegistration, bool>? FilterChecks to customize which health checks are run.

Feedback & Contributing

We welcome feedback and contributions in our GitHub repo.

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 is compatible. 
.NET Framework net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Microsoft.Extensions.Diagnostics.Probes:

Package Downloads
Archetypical.Software.Vega.Api.Abstractions

This package provides a turn-key API and DBContext for any REST and ODATA exposed data models. These models also allow for automated DBContexts across multiple db technologies. Full OTEL support and swagger/redoc tooling

GitHub repositories

This package is not used by any popular GitHub repositories.