Uniphar.PlatformCommon
2.2.0
See the version list below for details.
dotnet add package Uniphar.PlatformCommon --version 2.2.0
NuGet\Install-Package Uniphar.PlatformCommon -Version 2.2.0
<PackageReference Include="Uniphar.PlatformCommon" Version="2.2.0" />
<PackageVersion Include="Uniphar.PlatformCommon" Version="2.2.0" />
<PackageReference Include="Uniphar.PlatformCommon" />
paket add Uniphar.PlatformCommon --version 2.2.0
#r "nuget: Uniphar.PlatformCommon, 2.2.0"
#addin nuget:?package=Uniphar.PlatformCommon&version=2.2.0
#tool nuget:?package=Uniphar.PlatformCommon&version=2.2.0
Uniphar.PlatformCommon
The set of platform common classes
Status Health Checks
There are two health checks available for the status health endpoint:
- Ping
- HTTP
Once registered, to expose the /healthz/status endpoint, add the following line:
app.MapStatusHealthChecks();
Ping
It sends a ICMP echo message when requested.
builder.Services
.AddHealthChecks()
.AddPingHealthCheck(endpointUri.Host)
HTTP
It sends an HTTP GET request and expects a successful response.
builder.Services
.AddHealthChecks()
.AddHttpGetHealthCheck(
requestUri,
httpClientName: "MyHttpClient", // Optional
expectedStatusCode: HttpStatusCode.OK); // Optional
Protection
To protect the health endpoint from abuse or denial-of-service attacks, add the following lines:
builder.AddHealthCheckProtection();
// Before builder.Build();
// After app.MapStatusHealthChecks()
app.UseRequestTimeouts();
app.UseOutputCache();
// Before app.Run();
Logging
When a health check fails, a HealthCheckDegraded log is generated.
Custom Health Checks
To create custom health checks, inherit from HealthCheckBase and implement the HandleCheckHealthAsync method.
The base class provided centralized logging with pause and resume.
| 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 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 was computed. 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. |
-
net8.0
- Microsoft.Extensions.Caching.Abstractions (>= 9.0.3)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 9.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.