Microsoft.Extensions.Diagnostics.Probes
9.3.0-preview.1.25161.3
Prefix Reserved
dotnet add package Microsoft.Extensions.Diagnostics.Probes --version 9.3.0-preview.1.25161.3
NuGet\Install-Package Microsoft.Extensions.Diagnostics.Probes -Version 9.3.0-preview.1.25161.3
<PackageReference Include="Microsoft.Extensions.Diagnostics.Probes" Version="9.3.0-preview.1.25161.3" />
paket add Microsoft.Extensions.Diagnostics.Probes --version 9.3.0-preview.1.25161.3
#r "nuget: Microsoft.Extensions.Diagnostics.Probes, 9.3.0-preview.1.25161.3"
// Install Microsoft.Extensions.Diagnostics.Probes as a Cake Addin #addin nuget:?package=Microsoft.Extensions.Diagnostics.Probes&version=9.3.0-preview.1.25161.3&prerelease // Install Microsoft.Extensions.Diagnostics.Probes as a Cake Tool #tool nuget:?package=Microsoft.Extensions.Diagnostics.Probes&version=9.3.0-preview.1.25161.3&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 | Versions 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. 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. |
.NET Framework | net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
-
.NETFramework 4.6.2
- Microsoft.Bcl.TimeProvider (>= 8.0.1)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.14)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 8.0.0)
- Microsoft.Extensions.Telemetry.Abstractions (>= 9.3.0)
- System.Threading.Tasks.Extensions (>= 4.5.4)
-
net8.0
- Microsoft.Bcl.TimeProvider (>= 8.0.1)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.14)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 8.0.0)
- Microsoft.Extensions.Telemetry.Abstractions (>= 9.3.0)
-
net9.0
- Microsoft.Bcl.TimeProvider (>= 9.0.3)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.3)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 9.0.3)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 9.0.3)
- Microsoft.Extensions.Telemetry.Abstractions (>= 9.3.0)
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.