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.

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

Expose health check status in the dashboard #5569

Closed
4 tasks done
mitchdenny opened this issue Sep 6, 2024 · 8 comments · Fixed by #6069
Closed
4 tasks done

Expose health check status in the dashboard #5569

mitchdenny opened this issue Sep 6, 2024 · 8 comments · Fixed by #6069
Assignees
Labels
area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication area-dashboard
Milestone

Comments

@mitchdenny
Copy link
Member

mitchdenny commented Sep 6, 2024

In #5515 we are introducing health checks into resources so that when WaitFor is used and a health check is associated with a resource it blocks dependent resources from starting up until the check enters either a terminal state or is healthy.

We want to light up this feature in the dashboard so that developers can reason why a particular resource is not healthy. The key features are:

  1. The status on each resource should have its status and its health status ... e.g. Running (Healthy) or Running (Unhealthy). If the resource does not have any health checks associated with it then the health status can be ommitted.
  2. If the status is unhealthy, the text Unhealthy should be a hyperlink that brings up the resource details panel and displays the health checks section.
  3. The health checks section in the panel should list all the checks in the resource (typically just one but there can be more).
  4. The health check will need to show not just the health check entry status, but also any messag/exception details.
@mitchdenny mitchdenny added the area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication label Sep 6, 2024
@mitchdenny mitchdenny added this to the 9.0 milestone Sep 6, 2024
@drewnoakes
Copy link
Member

In the dashboard we can show them as another section in the Resource Details view, along with properties, endpoints and env vars.

I assume we won't need the ability to mask these values. They don't seem like sensitive information.

@davidfowl
Copy link
Member

davidfowl commented Sep 6, 2024

cc @leslierichardson95 this is part of the 9.0 work.

@joperezr
Copy link
Member

Next steps: Agree on what the UI will be and what the contract is between App Model and Dashboard. This is part of the WaitFor story.

@joperezr
Copy link
Member

cc: @samsp-msft @leslierichardson95

@davidfowl
Copy link
Member

I've done the first bullet (which I think is the min bar for 9). We can attempt to design the health checks panel or expand the existing details view to add health checks there.

Thoughts?

@davidfowl davidfowl assigned drewnoakes and unassigned davidfowl Sep 24, 2024
@drewnoakes
Copy link
Member

I'm working on showing these in the details area.

image

If there's a description or exception, they'll be displayed. I haven't seen an example of either in practice though, so am not sure what formatting they might need. For example, should the exception be displayed in monospace, preformatted?

While here I've also added details about "Waits For":

image

If the status is unhealthy, the text Unhealthy should be a hyperlink that brings up the resource details panel and displays the health checks section.

We don't currently have a way to navigate to a section in the details pane. We could collapse all other sections and force the details view to be open.

@mitchdenny
Copy link
Member Author

For the exception we'll probably want to be able to bring it up in its own window like we can with some of the other values in the dashboard (although it is fine to get to that via the panel here). People will probably want it to be preformatted text (see how it looks?).

@mitchdenny
Copy link
Member Author

When I say people ... I'm using my sample size of one :)

@github-actions github-actions bot locked and limited conversation to collaborators Nov 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-app-model Issues pertaining to the APIs in Aspire.Hosting, e.g. DistributedApplication area-dashboard
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants