Skip to content

Commit

Permalink
Fixes #2571. Cosmos DB client integration health checks (#2698)
Browse files Browse the repository at this point in the history
  • Loading branch information
IEvangelist authored Feb 27, 2025
1 parent 35136ae commit c1b427a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 10 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: .NET Aspire Cosmos DB Entity Framework Core integration
description: Learn how to install and configure the .NET Aspire Cosmos DB Entity Framework Core integration to connect to existing Cosmos DB instances or create new instances from .NET with the Azure Cosmos DB emulator.
ms.date: 02/24/2025
ms.date: 02/26/2025
uid: dotnet/aspire/azure-cosmos-db-entity-framework-integration
---

Expand Down Expand Up @@ -118,8 +118,6 @@ builder.AddCosmosDbContext<MyDbContext>(

### Client integration health checks

By default, .NET Aspire integrations enable health checks for all services. For more information, see [.NET Aspire integrations overview](../fundamentals/integrations-overview.md).

The .NET Aspire Microsoft Entity Framework Core Cosmos DB integration currently doesn't implement health checks, though this may change in future releases.

[!INCLUDE [integration-observability-and-telemetry](../includes/integration-observability-and-telemetry.md)]
Expand Down
9 changes: 2 additions & 7 deletions docs/database/azure-cosmos-db-integration.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: .NET Aspire Azure Cosmos DB integration
description: Learn how to install and configure the .NET Aspire Azure Cosmos DB integration to connect to existing Cosmos DB instances or create new instances from .NET with the Azure Cosmos DB emulator.
ms.date: 02/24/2025
ms.date: 02/26/2025
uid: dotnet/aspire/azure-cosmos-db-integration
---

Expand Down Expand Up @@ -152,12 +152,7 @@ builder.AddAzureCosmosClient(

### Client integration health checks

By default, .NET Aspire integrations enable health checks for all services. For more information, see [.NET Aspire integrations overview](../fundamentals/integrations-overview.md).

The .NET Aspire Azure Cosmos DB integration:

- Adds the health check when <xref:Aspire.Microsoft.Azure.Cosmos.MicrosoftAzureCosmosSettings.DisableTracing?displayProperty=nameWithType> is `false`, which attempts to connect to the Cosmos DB.
- Integrates with the `/health` HTTP endpoint, which specifies all registered health checks must pass for app to be considered ready to accept traffic.
The .NET Aspire Cosmos DB client integration currently doesn't implement health checks, though this may change in future releases.

[!INCLUDE [integration-observability-and-telemetry](../includes/integration-observability-and-telemetry.md)]

Expand Down

0 comments on commit c1b427a

Please sign in to comment.