cockroachdb / cockroachdb/cockroach

dbconsole: improve mixed-version state reporting

Open
#110,320 0 comments 0 reactions 0 assignees View on GitHub
C-enhancement O-cct T-observability ui-design-needed
Dominant language
Go
Stars
32.5k
Forks
4.1k
PR merge metrics
PR metrics pending

Description

In [1], we added an alert to warn the user that a potentially long-running upgrade has not yet been finalized. However, this alert shows up only inside the `Overview` (panel) view. Furthermore, the user may inadvertently close the alert; subsequently, there is no other notification that the upgrade either has been finalized or continues to be running.

Meanwhile, the page header displays the cluster id and the _binary_ version without explicitly indicating that. The latter can be a source of confusion when the cluster remains in a mixed-version state. An average user may interpret the version `23.1.9` (see screenshot below) to mean that the cluster is on that version, especially when the alert isn't visible. Considering that the header (banner) has a lot of unused real-estate, there is an opportunity to make the version information more precise; e.g., it could say `23.1.9 (binary) -- upgrade not finalized`.

E.g., alert shows up only under `Overview` and not `Metrics`,

mixed_version_state_overview

mixed_version_state_metrics

[1] https://github.com/cockroachdb/cockroach/pull/104688

Jira issue: CRDB-31377

Contributor guide

Open the contributing guide

Research direction

Start in the dbconsole Overview and Metrics views and inspect how the mixed-version alert and page-header version are assembled. Done means the mixed-version status remains visible across these views and the header clearly labels the binary version and whether the upgrade is finalized.

Written by the indexing model from the issue text.

Assessment

Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.