AspNetCore.HealthChecks.CosmosDb
8.0.1
dotnet add package AspNetCore.HealthChecks.CosmosDb --version 8.0.1
NuGet\Install-Package AspNetCore.HealthChecks.CosmosDb -Version 8.0.1
<PackageReference Include="AspNetCore.HealthChecks.CosmosDb" Version="8.0.1" />
paket add AspNetCore.HealthChecks.CosmosDb --version 8.0.1
#r "nuget: AspNetCore.HealthChecks.CosmosDb, 8.0.1"
// Install AspNetCore.HealthChecks.CosmosDb as a Cake Addin #addin nuget:?package=AspNetCore.HealthChecks.CosmosDb&version=8.0.1 // Install AspNetCore.HealthChecks.CosmosDb as a Cake Tool #tool nuget:?package=AspNetCore.HealthChecks.CosmosDb&version=8.0.1
Azure Cosmos DB Health Check
This health check verifies the ability to communicate with Azure Cosmos DB. It uses the provided CosmosClient.
Defaults
By default, the CosmosClient
instance is resolved from service provider. AzureCosmosDbHealthCheckOptions
does not provide any specific containers or database ids, the health check just calls CosmosClient.ReadAccountAsync.
void Configure(IHealthChecksBuilder builder)
{
builder.Services.AddSingleton(sp => new CosmosClient(
"endpoint-from-portal",
new DefaultAzureCredential()));
builder.AddHealthChecks().AddAzureCosmosDB();
}
Customization
You can additionally add the following parameters:
clientFactory
: A factory method to provideCosmosClient
instance.optionsFactory
: A factory method to provideAzureCosmosDbHealthCheckOptions
instance. It allows to specify the database id and/or container id(s).name
: The health check name. The default isazure_cosmosdb
.failureStatus
: TheHealthStatus
that should be reported when the health check fails. Default isHealthStatus.Unhealthy
.tags
: A list of tags that can be used to filter sets of health checks.timeout
: ASystem.TimeSpan
representing the timeout of the check.
void Configure(IHealthChecksBuilder builder)
{
builder.Services.AddSingleton(sp => new CosmosClient(
"endpoint-from-portal",
new DefaultAzureCredential(),
new CosmosClientOptions()
{
ApplicationRegion = Regions.EastUS2,
}));
builder.AddHealthChecks().AddAzureCosmosDB(
optionsFactory: sp => new AzureCosmosDbHealthCheckOptions()
{
DatabaseId = "demo"
});
}
Breaking changes
In the prior releases, CosmosDbHealthCheck
was a part of HealthChecks.CosmosDb
package. It had a dependency on not just Microsoft.Azure.Cosmos
, but also Azure.Data.Tables
. The packages have been split to avoid bringing unnecessary dependencies. Moreover, CosmosDbHealthCheck
was letting the users specify how CosmosClient
should be created (from raw connection string or from endpoint and managed identity credentials), at a cost of maintaining an internal, static client instances cache. Now the type does not create client instances nor maintain an internal cache and it's the caller responsibility to provide the instance of CosmosClient
(please see #2040 for more details). Since Azure SDK recommends treating clients as singletons <see href="https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/"/> and client instances can be expensive to create, it's recommended to register a singleton factory method for Azure SDK clients. So the clients are created only when needed and once per whole application lifetime.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.Azure.Cosmos (>= 3.37.0)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.0)
-
net6.0
- Microsoft.Azure.Cosmos (>= 3.37.0)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.0)
NuGet packages (6)
Showing the top 5 NuGet packages that depend on AspNetCore.HealthChecks.CosmosDb:
Package | Downloads |
---|---|
IEvangelist.Azure.CosmosRepository.AspNetCore
This client library enables client applications to connect to Azure Cosmos via a repository pattern around the official Azure Cosmos .NET SDK. Azure Cosmos is a globally distributed, multi-model database service. For more information, refer to http://azure.microsoft.com/services/cosmos-db/. |
|
EaCloud.AspNetCore.Diagnostics
EaCloud AspNetCore 性能诊断组件,提供 AspNetCore 性能诊断功能的封装。 |
|
IceArtefact.Infrastructure.HealthCheck
Package Description |
|
MicroserviceTemplate.API
Templates to use when creating an api for Microservices. |
|
BridgingIT.DevKit.Infrastructure.Azure.HealthChecks
BridgingIT DevKit: Empowering developers with modular components for modern application development, centered around Domain-Driven Design principles. Our goal is to empower developers by offering modular components that can be easily integrated into your projects. Whether you're working with repositories, commands, queries, or other components, the bITDevKit provides flexible solutions that can adapt to your specific needs. |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on AspNetCore.HealthChecks.CosmosDb:
Repository | Stars |
---|---|
IEvangelist/azure-cosmos-dotnet-repository
Wraps the .NET SDK for Azure Cosmos DB abstracting away the complexity, exposing a simple CRUD-based repository pattern
|
Version | Downloads | Last updated |
---|---|---|
8.0.1 | 266,944 | 4/2/2024 |
8.0.0 | 229,578 | 12/15/2023 |
7.1.0 | 186,534 | 9/19/2023 |
7.0.0 | 139,887 | 7/30/2023 |
7.0.0-rc2.5 | 26,130 | 3/13/2023 |
7.0.0-rc2.4 | 14,541 | 1/14/2023 |
7.0.0-rc2.3 | 271 | 12/27/2022 |
7.0.0-rc2.2 | 1,109 | 12/27/2022 |
6.1.0 | 1,867,986 | 8/18/2022 |
6.0.3 | 129,656 | 7/30/2022 |
6.0.2 | 547,157 | 2/28/2022 |
6.0.1 | 177,046 | 12/29/2021 |
6.0.1-rc2.1 | 19,966 | 11/27/2021 |
6.0.0 | 25,160 | 12/29/2021 |
5.0.4 | 236,779 | 7/14/2021 |
5.0.3 | 133,087 | 3/9/2021 |
5.0.2 | 635 | 3/8/2021 |
5.0.1 | 27,981 | 1/5/2021 |
5.0.0 | 683 | 12/29/2020 |
5.0.0-preview1 | 408 | 11/22/2020 |
3.2.1-preview | 10,975 | 9/14/2020 |
3.2.0-preview | 391 | 9/3/2020 |
3.1.2 | 518,045 | 9/1/2020 |
3.1.1 | 146,636 | 4/17/2020 |
3.1.0 | 38,738 | 4/9/2020 |
3.0.0 | 58,753 | 9/24/2019 |
2.2.0 | 39,756 | 9/17/2019 |
2.2.0-preview | 6,502 | 4/9/2019 |