- Notifications
You must be signed in to change notification settings - Fork929
Description
Would be awesome if the product could immediately tell users if there is a severe issue with their deployment, and how to fix it. For example, an unreachable access URL, DERP errors, WebSockets are disabled, etc. This will require collaboration with@bpmct,@kylecarbs, or@ericpaulsen who can help with wording and writing docs around how to resolve these issues.
It feels like we should show this as a service banner on all pages sincepass: false
indicates a major issue. The goal of this is to allow users to self-diagnose issues quickly instead of them having to spend hours debugging themselves and then contacting us for help (where we may tell them to navigate to a specific page or endpoint to reveal errors).
Acceptance criteria
Avoiding false positives: A non-dismissable banner may be frustrating if the deployment is, in fact, healthy, despite a failed health check. If we can think of common cases where this would happen, we should ideally fix our health check logic. However, I don't think this needs a ton of testing. If necessary, we could always revert or make the warning dismissable.
Performance: We should run basic performance tests or make design decisions to ensure this does not significantly slow down page loads.
Visibility: Since this banner will only show up during major issues, I don't have strong opinions on whether users should see the banner or only admins. I'm not super concerned about the banner disrupting UX since Coder would be unusable at that point and users seeing it may lead to a quicker resolution time from an admin.
CLI: I don't think this necessarily has to show up as CLI errors, but it would be nice (e.g. similar to a warning that Coder is out of date)
To avoid doing a bunch of calculations on the front, this feels like its partially blocked by#7745 (top-level fail reason)