Show aggregate health status in the dashboard (#5770)

* Added the aggregated health state to the resource server protocol to enable showing it in the dashboard.
- Don't show healthy/unhealthy, just use the heath state to show readiness in the dashboard UX.
- Use an internal annotation to keep track of DCP resource names for state updates.
- Publish health state updates to instances as well as the main resource.

Author: davidfowl

src/Aspire.Dashboard/Components/Controls/ResourceDetails.razor.cs

@@ -74,7 +74,8 @@ protected override void OnInitialized()
             new KnownProperty(KnownProperties.Resource.DisplayName, Loc[Resources.Resources.ResourcesDetailsDisplayNameProperty]),
             new KnownProperty(KnownProperties.Resource.State, Loc[Resources.Resources.ResourcesDetailsStateProperty]),
             new KnownProperty(KnownProperties.Resource.CreateTime, Loc[Resources.Resources.ResourcesDetailsStartTimeProperty]),
-            new KnownProperty(KnownProperties.Resource.ExitCode, Loc[Resources.Resources.ResourcesDetailsExitCodeProperty])
+            new KnownProperty(KnownProperties.Resource.ExitCode, Loc[Resources.Resources.ResourcesDetailsExitCodeProperty]),
+            new KnownProperty(KnownProperties.Resource.HealthState, Loc[Resources.Resources.ResourcesDetailsHealthStateProperty])
         ];
         _projectProperties =
         [

src/Aspire.Dashboard/Components/Pages/Resources.razor

@@ -94,7 +94,7 @@
                                 <AspireTemplateColumn ColumnId="@NameColumn" ColumnManager="@_manager" Title="@ControlsStringsLoc[nameof(ControlsStrings.NameColumnHeader)]" Sortable="true" SortBy="@_nameSort" Tooltip="true" TooltipText="@(c => GetResourceName(c))">
                                     <ResourceNameDisplay Resource="context" FilterText="@_filter" FormatName="GetResourceName" />
                                 </AspireTemplateColumn>
-                                <AspireTemplateColumn ColumnId="@StateColumn" ColumnManager="@_manager" Title="@Loc[nameof(Dashboard.Resources.Resources.ResourcesStateColumnHeader)]" Sortable="true" SortBy="@_stateSort" Tooltip="true" TooltipText="@(c => c.State.Humanize())">
+                                <AspireTemplateColumn ColumnId="@StateColumn" ColumnManager="@_manager" Title="@Loc[nameof(Dashboard.Resources.Resources.ResourcesStateColumnHeader)]" Sortable="true" SortBy="@_stateSort" Tooltip="true" TooltipText="@(c => GetResourceStateTooltip(c))">
                                     <StateColumnDisplay Resource="@context" UnviewedErrorCounts="@_applicationUnviewedErrorCounts" />
                                 </AspireTemplateColumn>
                                 <AspireTemplateColumn ColumnId="@StartTimeColumn" ColumnManager="@_manager" Title="@Loc[nameof(Dashboard.Resources.Resources.ResourcesStartTimeColumnHeader)]" Sortable="true" SortBy="@_startTimeSort" TooltipText="@(context => context.CreationTimeStamp != null ? FormatHelpers.FormatDateTime(TimeProvider, context.CreationTimeStamp.Value, MillisecondsDisplay.None, CultureInfo.CurrentCulture) : null)" Tooltip="true">

src/Aspire.Dashboard/Components/Pages/Resources.razor.cs

@@ -11,6 +11,7 @@
 using Aspire.Dashboard.Otlp.Storage;
 using Aspire.Dashboard.Resources;
 using Aspire.Dashboard.Utils;
+using Humanizer;
 using Microsoft.AspNetCore.Components;
 using Microsoft.AspNetCore.Components.Server.ProtectedBrowserStorage;
 using Microsoft.FluentUI.AspNetCore.Components;
@@ -331,6 +332,11 @@ private async Task ExecuteResourceCommandAsync(ResourceViewModel resource, Comma
         }
     }
 
+    private static string GetResourceStateTooltip(ResourceViewModel resource) =>
+        resource.ShowReadinessState() ?
+        $"{resource.State.Humanize()} ({resource.ReadinessState.Humanize()})"
+        : resource.State.Humanize();
+
     private static (string Value, string? ContentAfterValue, string ValueToCopy, string Tooltip)? GetSourceColumnValueAndTooltip(ResourceViewModel resource)
     {
         // NOTE projects are also executables, so we have to check for projects first

src/Aspire.Dashboard/Components/ResourcesGridColumns/StateColumnDisplay.razor

@@ -3,6 +3,7 @@
 @using Aspire.Dashboard.Otlp.Model
 @using Aspire.Dashboard.Otlp.Storage
 @using Aspire.Dashboard.Resources
+@using Microsoft.Extensions.Diagnostics.HealthChecks
 @using Humanizer
 
 @inject IStringLocalizer<Columns> Loc
@@ -78,9 +79,20 @@ else if (!string.IsNullOrEmpty(Resource.StateStyle))
 }
 else
 {
-    <FluentIcon Icon="Icons.Filled.Size16.CheckmarkCircle"
-                Color="Color.Success"
-                Class="severity-icon" />
+    switch (Resource.ReadinessState)
+    {
+        // Unknown state is treated as ready state (we don't know if it's ready or not)
+        case ReadinessState.Unknown or ReadinessState.Ready:
+            <FluentIcon Icon="Icons.Filled.Size16.CheckmarkCircle"
+                        Color="Color.Success"
+                        Class="severity-icon" />
+            break;
+        default:
+            <FluentIcon Icon="Icons.Regular.Size16.CheckmarkCircleWarning"
+                        Color="Color.Neutral"
+                        Class="severity-icon" />
+            break;
+    }
 }
 
 @if (Resource.HasNoState())
@@ -89,7 +101,14 @@ else
 }
 else
 {
-    <span>@Resource.State.Humanize()</span>
+    if (Resource.ShowReadinessState())
+    {
+        <span>@Resource.State.Humanize() (@Resource.ReadinessState.Humanize())</span>
+    }
+    else
+    {
+        <span>@Resource.State.Humanize()</span>
+    }
 }
 
 <UnreadLogErrorsBadge UnviewedErrorCounts="UnviewedErrorCounts" Resource="@Resource" />

src/Aspire.Dashboard/Extensions/ResourceViewModelExtensions.cs

@@ -33,4 +33,8 @@ public static bool IsStartingOrBuildingOrWaiting(this ResourceViewModel resource
     }
 
     public static bool HasNoState(this ResourceViewModel resource) => string.IsNullOrEmpty(resource.State);
+
+    // We only care about the readiness state if the resource is running
+    public static bool ShowReadinessState(this ResourceViewModel resource) =>
+        resource.IsRunningState() && resource.ReadinessState is ReadinessState.NotReady;
 }

src/Aspire.Dashboard/Model/ResourceViewModel.cs

@@ -20,6 +20,7 @@ public sealed class ResourceViewModel
     public required string Uid { get; init; }
     public required string? State { get; init; }
     public required string? StateStyle { get; init; }
+    public required ReadinessState ReadinessState { get; init; }
     public required DateTime? CreationTimeStamp { get; init; }
     public required ImmutableArray<EnvironmentVariableViewModel> Environment { get; init; }
     public required ImmutableArray<UrlViewModel> Urls { get; init; }
@@ -60,6 +61,13 @@ public static string GetResourceName(ResourceViewModel resource, IDictionary<str
     }
 }
 
+public enum ReadinessState
+{
+    Unknown,
+    NotReady,
+    Ready
+}
+
 [DebuggerDisplay("CommandType = {CommandType}, DisplayName = {DisplayName}")]
 public sealed class CommandViewModel
 {

src/Aspire.Dashboard/ResourceService/Partials.cs

@@ -31,6 +31,11 @@ public ResourceViewModel ToViewModel()
                 State = HasState ? State : null,
                 KnownState = HasState ? Enum.TryParse(State, out KnownResourceState knownState) ? knownState : null : null,
                 StateStyle = HasStateStyle ? StateStyle : null,
+                ReadinessState = HasHealthState ? HealthState switch
+                {
+                    HealthStateKind.Healthy => ReadinessState.Ready,
+                    _ => ReadinessState.NotReady,
+                } : ReadinessState.Unknown,
                 Commands = GetCommands()
             };
         }

src/Aspire.Dashboard/Resources/Resources.Designer.cs

@@ -232,4 +232,7 @@
   <data name="ResourceDetailsViewConsoleLogs" xml:space="preserve">
     <value>View console logs</value>
   </data>
+  <data name="ResourcesDetailsHealthStateProperty" xml:space="preserve">
+    <value>Health State</value>
+  </data>
 </root>