Page MenuHomeElementl

[dagit] RFC: Instance status dot in left nav
ClosedPublic

Authored by dish on Feb 10 2021, 3:28 PM.

Details

Summary

Add a "status dot" to the Instance status left nav item in the updated nav. Worth discussing a bit to figure out how to make this appropriately useful.

  • It would be good to make the repository error display less prominent in the new navigation. (https://github.com/dagster-io/dagster/issues/3490) The dot will ideally provide a summary of error/warning state that is noticeable but also easy to disregard if the user doesn't need to care about it.
  • When the status is still loading, show it as "gray".
  • Currently, "green" means that there are no repo errors and that all daemons are healthy. Anything else is "yellow".
    • More ideally, we would know whether Dagit is being run in a dev or prod mode, so we could be clearer about what's truly an error state. For instance, in prod, it may be that any daemon error should be surfaced as a "red" state, but this is a "yellow" state in dev. We don't have such a flag right now.
  • I renamed the left nav item from "Status" to "Instance". I don't know if this is the right thing to do.

I'm thinking it might also be useful to show an Alert on the top of the "Instance status" page to give a bit more context about /why/ the status dot is what it is when first coming to the page.

Test Plan

Toggle left nav changes on. Verify status dot behavior.

Diff Detail

Repository
R1 dagster
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

dish requested review of this revision.Feb 10 2021, 3:36 PM

I'll let other folks weigh in but the JS for this looks great. I think that you're right - the dot should either display detailed info when you hover over it (as opposed to Warnings found) or they should be in a consolidated spot on the instance tab (or maybe each tab of the instance UI gets it's own yellow dot so you can click into the right tab? Probably overkill...)

We use status dots in a lot of places - what if we made this one a little rounded yellow triangle and hide it when instance status is OK? That might help disambiguate it from the websocket connectivity one. (edit: Actually, did we get rid of that one? This one polls rather than checking the websocket?)

image.png (364×426 px, 13 KB)

<?xml version="1.0" encoding="UTF-8"?>
<svg width="22px" height="20px" viewBox="-10 -9 65 54" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
    <path d="M22,-0.00388780924 L43.0599353,36.5 L0.940064725,36.5 L22,-0.00388780924 Z" stroke-linejoin="round" stroke="#FFB500" stroke-width="20" fill="#FFB500"></path>
</svg>
This revision is now accepted and ready to land.Feb 15 2021, 4:53 PM

We use status dots in a lot of places - what if we made this one a little rounded yellow triangle and hide it when instance status is OK? That might help disambiguate it from the websocket connectivity one. (edit: Actually, did we get rid of that one? This one polls rather than checking the websocket?)

Yeah, I like the triangle.

I haven't added the websocket status back in -- it's separate, and on my todo list.

Use triangle icon, and only display anything when there are warnings.

This revision was automatically updated to reflect the committed changes.