Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use ApplicationStatus health check in ServiceDefaults #7151

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+28 −26
Open

Use ApplicationStatus health check in ServiceDefaults #7151

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
331f0fa
Use ApplicationStatus health check in ServiceDefaults
matthebrown Jan 19, 2025
2e07642
Update templates
matthebrown Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
<PackageVersion Include="Azure.ResourceManager.KeyVault" Version="1.3.0" />
<PackageVersion Include="Azure.ResourceManager.Resources" Version="1.9.0" />
<!-- AspNetCore.HealthChecks dependencies (3rd party packages) -->
<PackageVersion Include="AspNetCore.HealthChecks.ApplicationStatus" Version="9.0.0" />
<PackageVersion Include="AspNetCore.HealthChecks.Azure.Data.Tables" Version="8.0.1" />
<PackageVersion Include="AspNetCore.HealthChecks.Azure.KeyVault.Secrets" Version="8.0.1" />
<PackageVersion Include="AspNetCore.HealthChecks.Azure.Messaging.EventHubs" Version="8.0.1" />
Expand Down
5 changes: 2 additions & 3 deletions playground/Playground.ServiceDefaults/Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using HealthChecks.ApplicationStatus.DependencyInjection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics.HealthChecks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using Microsoft.Extensions.Logging;
using OpenTelemetry;
using OpenTelemetry.Metrics;
Expand Down Expand Up @@ -84,8 +84,7 @@ private static TBuilder AddOpenTelemetryExporters<TBuilder>(this TBuilder builde
public static TBuilder AddDefaultHealthChecks<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
{
builder.Services.AddHealthChecks()
// Add a default liveness check to ensure app is responsive
.AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]);
.AddApplicationStatus();

return builder;
}
Expand Down
1 change: 1 addition & 0 deletions playground/Playground.ServiceDefaults/Playground.ServiceDefaults.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" />
<PackageReference Include="OpenTelemetry.Instrumentation.Http" />
<PackageReference Include="OpenTelemetry.Instrumentation.Runtime" />
<PackageReference Include="AspNetCore.HealthChecks.ApplicationStatus" />

<AspireProjectOrPackageReference Include="Microsoft.Extensions.ServiceDiscovery.Dns" />
<AspireProjectOrPackageReference Include="Microsoft.Extensions.ServiceDiscovery" />
Expand Down
5 changes: 2 additions & 3 deletions playground/TestShop/TestShop.ServiceDefaults/Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using HealthChecks.ApplicationStatus.DependencyInjection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics.HealthChecks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using Microsoft.Extensions.Logging;
using OpenTelemetry;
using OpenTelemetry.Metrics;
Expand Down Expand Up @@ -83,8 +83,7 @@ private static TBuilder AddOpenTelemetryExporters<TBuilder>(this TBuilder builde
public static TBuilder AddDefaultHealthChecks<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
{
builder.Services.AddHealthChecks()
// Add a default liveness check to ensure app is responsive
.AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]);
.AddApplicationStatus();

return builder;
}
Expand Down
1 change: 1 addition & 0 deletions playground/TestShop/TestShop.ServiceDefaults/TestShop.ServiceDefaults.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
<PackageReference Include="OpenTelemetry.Instrumentation.Runtime" />

<PackageReference Include="Microsoft.Extensions.Http.Resilience" />
<PackageReference Include="AspNetCore.HealthChecks.ApplicationStatus" />
</ItemGroup>

<ItemGroup>
Expand Down
1 change: 1 addition & 0 deletions ...-empty/8.2/AspireApplication.1.ServiceDefaults/AspireApplication.1.ServiceDefaults.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.9.0" />
<PackageReference Include="AspNetCore.HealthChecks.ApplicationStatus" Version="ß!!REPLACE_WITH_LATEST_VERSION!!" />
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't want to use the replacement token here. Just put in the version number. This is causing the tests to fail currently.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<PackageReference Include="AspNetCore.HealthChecks.ApplicationStatus" Version="ß!!REPLACE_WITH_LATEST_VERSION!!" />
<PackageReference Include="AspNetCore.HealthChecks.ApplicationStatus" Version="9.0" />

</ItemGroup>

</Project>
5 changes: 2 additions & 3 deletions ...ectTemplates/templates/aspire-empty/8.2/AspireApplication.1.ServiceDefaults/Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using HealthChecks.ApplicationStatus.DependencyInjection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics.HealthChecks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using Microsoft.Extensions.Logging;
using OpenTelemetry;
using OpenTelemetry.Metrics;
Expand Down Expand Up @@ -84,8 +84,7 @@ private static IHostApplicationBuilder AddOpenTelemetryExporters(this IHostAppli
public static IHostApplicationBuilder AddDefaultHealthChecks(this IHostApplicationBuilder builder)
{
builder.Services.AddHealthChecks()
// Add a default liveness check to ensure app is responsive
.AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]);
.AddApplicationStatus();

return builder;
}
Expand Down
1 change: 1 addition & 0 deletions ...-empty/9.0/AspireApplication.1.ServiceDefaults/AspireApplication.1.ServiceDefaults.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.9.0" />
<PackageReference Include="AspNetCore.HealthChecks.ApplicationStatus" Version="!!REPLACE_WITH_LATEST_VERSION!!" />
</ItemGroup>

</Project>
5 changes: 2 additions & 3 deletions ...ectTemplates/templates/aspire-empty/9.0/AspireApplication.1.ServiceDefaults/Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using HealthChecks.ApplicationStatus.DependencyInjection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics.HealthChecks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.ServiceDiscovery;
using OpenTelemetry;
Expand Down Expand Up @@ -92,8 +92,7 @@ private static TBuilder AddOpenTelemetryExporters<TBuilder>(this TBuilder builde
public static TBuilder AddDefaultHealthChecks<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
{
builder.Services.AddHealthChecks()
// Add a default liveness check to ensure app is responsive
.AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]);
.AddApplicationStatus();

return builder;
}
Expand Down
1 change: 1 addition & 0 deletions ...pire.ProjectTemplates/templates/aspire-servicedefaults/8.2/Aspire.ServiceDefaults1.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.9.0" />
<PackageReference Include="AspNetCore.HealthChecks.ApplicationStatus" Version="!!REPLACE_WITH_LATEST_VERSION!!" />
</ItemGroup>

</Project>
5 changes: 2 additions & 3 deletions src/Aspire.ProjectTemplates/templates/aspire-servicedefaults/8.2/Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using HealthChecks.ApplicationStatus.DependencyInjection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics.HealthChecks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.ServiceDiscovery;
using OpenTelemetry;
Expand Down Expand Up @@ -91,8 +91,7 @@ private static IHostApplicationBuilder AddOpenTelemetryExporters(this IHostAppli
public static IHostApplicationBuilder AddDefaultHealthChecks(this IHostApplicationBuilder builder)
{
builder.Services.AddHealthChecks()
// Add a default liveness check to ensure app is responsive
.AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]);
.AddApplicationStatus();

return builder;
}
Expand Down
1 change: 1 addition & 0 deletions ...pire.ProjectTemplates/templates/aspire-servicedefaults/9.0/Aspire.ServiceDefaults1.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.9.0" />
<PackageReference Include="AspNetCore.HealthChecks.ApplicationStatus" Version="!!REPLACE_WITH_LATEST_VERSION!!" />
</ItemGroup>

</Project>
4 changes: 2 additions & 2 deletions src/Aspire.ProjectTemplates/templates/aspire-servicedefaults/9.0/Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using HealthChecks.ApplicationStatus.DependencyInjection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics.HealthChecks;
using Microsoft.Extensions.DependencyInjection;
Expand Down Expand Up @@ -92,8 +93,7 @@ private static TBuilder AddOpenTelemetryExporters<TBuilder>(this TBuilder builde
public static TBuilder AddDefaultHealthChecks<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
{
builder.Services.AddHealthChecks()
// Add a default liveness check to ensure app is responsive
.AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]);
.AddApplicationStatus();

return builder;
}
Expand Down
1 change: 1 addition & 0 deletions ...e-StarterApplication.1.ServiceDefaults/Aspire-StarterApplication.1.ServiceDefaults.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.9.0" />
<PackageReference Include="AspNetCore.HealthChecks.ApplicationStatus" Version="!!REPLACE_WITH_LATEST_VERSION!!" />
</ItemGroup>

</Project>
5 changes: 2 additions & 3 deletions ...es/templates/aspire-starter/8.2/Aspire-StarterApplication.1.ServiceDefaults/Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using HealthChecks.ApplicationStatus.DependencyInjection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics.HealthChecks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using Microsoft.Extensions.Logging;
using OpenTelemetry;
using OpenTelemetry.Metrics;
Expand Down Expand Up @@ -84,8 +84,7 @@ private static IHostApplicationBuilder AddOpenTelemetryExporters(this IHostAppli
public static IHostApplicationBuilder AddDefaultHealthChecks(this IHostApplicationBuilder builder)
{
builder.Services.AddHealthChecks()
// Add a default liveness check to ensure app is responsive
.AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]);
.AddApplicationStatus();

return builder;
}
Expand Down
1 change: 1 addition & 0 deletions ...e-StarterApplication.1.ServiceDefaults/Aspire-StarterApplication.1.ServiceDefaults.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Http" Version="1.9.0" />
<PackageReference Include="OpenTelemetry.Instrumentation.Runtime" Version="1.9.0" />
<PackageReference Include="AspNetCore.HealthChecks.ApplicationStatus" Version="!!REPLACE_WITH_LATEST_VERSION!!" />
</ItemGroup>

</Project>
5 changes: 2 additions & 3 deletions ...es/templates/aspire-starter/9.0/Aspire-StarterApplication.1.ServiceDefaults/Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using HealthChecks.ApplicationStatus.DependencyInjection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics.HealthChecks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.ServiceDiscovery;
using OpenTelemetry;
Expand Down Expand Up @@ -92,8 +92,7 @@ private static TBuilder AddOpenTelemetryExporters<TBuilder>(this TBuilder builde
public static TBuilder AddDefaultHealthChecks<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
{
builder.Services.AddHealthChecks()
// Add a default liveness check to ensure app is responsive
.AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]);
.AddApplicationStatus();

return builder;
}
Expand Down
5 changes: 2 additions & 3 deletions tests/TestingAppHost1/TestingAppHost1.ServiceDefaults/Extensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using HealthChecks.ApplicationStatus.DependencyInjection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Diagnostics.HealthChecks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using Microsoft.Extensions.Logging;
using OpenTelemetry;
using OpenTelemetry.Metrics;
Expand Down Expand Up @@ -93,8 +93,7 @@ private static TBuilder AddOpenTelemetryExporters<TBuilder>(this TBuilder builde
public static TBuilder AddDefaultHealthChecks<TBuilder>(this TBuilder builder) where TBuilder : IHostApplicationBuilder
{
builder.Services.AddHealthChecks()
// Add a default liveness check to ensure app is responsive
.AddCheck("self", () => HealthCheckResult.Healthy(), ["live"]);
.AddApplicationStatus();

return builder;
}
Expand Down
1 change: 1 addition & 0 deletions tests/TestingAppHost1/TestingAppHost1.ServiceDefaults/TestingAppHost1.ServiceDefaults.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
<PackageReference Include="OpenTelemetry.Instrumentation.AspNetCore" />
<PackageReference Include="OpenTelemetry.Instrumentation.Http" />
<PackageReference Include="OpenTelemetry.Instrumentation.Runtime" />
<PackageReference Include="AspNetCore.HealthChecks.ApplicationStatus" />
</ItemGroup>

<ItemGroup>
Expand Down
Loading