microsoft / microsoft/aspire

Add health check status to the dashboard

Open
#889 10 comments 16 reactions 0 assignees View on GitHub
area-app-model area-dashboard
Dominant language
C#
Stars
6.3k
Forks
991
Avg merge
2d 15h
Merged PRs (30d)
196

Description

The .NET Aspire ServiceDefaults project defaults to configuring health check endpoints for service projects. Similarly, .NET Aspire components default to registering health checks for the dependencies they integrate with. Currently, the status of these health checks is not visible anywhere by default. We should consider adding UI to the dashboard (add potentially [concepts to the AppHost app model](https://github.com/dotnet/aspire/issues/890)) to display the status of resources' health checks.

I can imagine a few click-stops:

1. Show last known status of health check endpoints, i.e. healthy, degraded, unhealthy, at a glance, perhaps on the relevant resources summary page, e.g. a column with a status indicator icon on the projects page. The interval the health check endpoints are inspected would default to something reasonable (e.g. 10 seconds) and perhaps be configurable either in the dashboard UI and/or in the AppHost app model.
2. Tracking of health check status changes over time, so that in addition to the last status, a history of status requests and their result could be viewed, e.g. clicking on the last known status indicator in the summary would open a view that shows the history of all status checks.
3. A detailed view of all the individual health checks that contribute to the overall status reported for a given health checks endpoint (similar to https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks#HealthCheckUI, perhaps we consider how we might just integrate that given that we're already depending on the individual health checks from this project from the relevant Aspire component packages)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.