Use extensions to set health check result

microsoft · Jan 6, 2025 · beda8b2 · beda8b2
1 parent 83c10be
commit beda8b2
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/src/Abstractions/Activities/ActivityExtensions.cs b/src/Abstractions/Activities/ActivityExtensions.cs
@@ -4,6 +4,7 @@
 using System;
 using System.Diagnostics;
 using System.Globalization;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
 using Microsoft.Omex.Extensions.Abstractions.Activities.Processing;
 
 namespace Microsoft.Omex.Extensions.Abstractions.Activities
@@ -72,6 +73,13 @@ public static Activity MarkAsHealthCheck(this Activity activity) =>
 		public static Activity SetResult(this Activity activity, ActivityResult result) =>
 			activity.SetTag(ActivityTagKeys.Result, ActivityResultStrings.ResultToString(result));
 
+		/// <summary>
+		/// Set health check result
+		/// </summary>
+		/// <remarks>This property won't be transferred to child activity or via web requests</remarks>
+		public static Activity SetHealthCheckResult(this Activity activity, HealthStatus result) =>
+			activity.SetTag(ActivityTagKeys.HealthCheckResult, result.ToString());
+
 		/// <summary>
 		/// Set activity result to Success
 		/// </summary>

diff --git a/src/Abstractions/Microsoft.Omex.Extensions.Abstractions.csproj b/src/Abstractions/Microsoft.Omex.Extensions.Abstractions.csproj
@@ -14,6 +14,7 @@
     <Content Include="BuildTransitive\*" Pack="true" PackagePath="buildTransitive" />
   </ItemGroup>
   <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" />
     <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" />
     <PackageReference Include="System.Diagnostics.DiagnosticSource" />

diff --git a/src/Diagnostics.HealthChecks/Composables/ObservableHealthCheck.cs b/src/Diagnostics.HealthChecks/Composables/ObservableHealthCheck.cs
@@ -1,4 +1,5 @@
-// Copyright (C) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license.
 
 using System;
 using System.Diagnostics;
@@ -66,7 +67,7 @@ public async Task<HealthCheckResult> CheckHealthAsync(HealthCheckContext context
 				? result.Status
 				: context.Registration.FailureStatus;
 
-			activity?.SetTag(ActivityTagKeys.HealthCheckResult, healthCheckStatus.ToString());
+			activity?.SetHealthCheckResult(healthCheckStatus);
 
 			return new HealthCheckResult(
 				healthCheckStatus,