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

ui: remove unnecessary metric name prefixes #129149

Merged

Conversation

dhartunian
Copy link
Collaborator

Metrics keyed by nodeID and prefixed with long strings become very difficult to read on the dashboard pages since they take up too much horizontal space. In all of these cases, the context provided by the graph title and Y axis label provide enough context to omit verbose legend labels.

Resolves: #128046

Release note (ui change): some metric charts on the overview and replication pages have more terse legends to facilitate easier browsing.

@dhartunian dhartunian added backport-23.2.x Flags PRs that need to be backported to 23.2. backport-24.1.x Flags PRs that need to be backported to 24.1. backport-24.2.x Flags PRs that need to be backported to 24.2 labels Aug 16, 2024
@dhartunian dhartunian requested a review from a team as a code owner August 16, 2024 20:40
@dhartunian dhartunian requested review from kyle-a-wong and removed request for a team August 16, 2024 20:40
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@dhartunian
Copy link
Collaborator Author

Some before/after screenshots. Old view is on the left. New one is on the right.

Screenshot 2024-08-16 at 16 31 40 Screenshot 2024-08-16 at 16 33 38 Screenshot 2024-08-16 at 16 33 55 Screenshot 2024-08-16 at 16 34 06 Screenshot 2024-08-16 at 16 35 20 Screenshot 2024-08-16 at 16 37 00 Screenshot 2024-08-16 at 16 37 11 Screenshot 2024-08-16 at 16 37 22

Copy link
Collaborator

@aadityasondhi aadityasondhi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thanks for doing this! Just a minor comment.

:lgtm:

Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @dhartunian and @kyle-a-wong)


pkg/ui/workspaces/db-console/src/views/cluster/containers/nodeGraphs/dashboards/overload.tsx line 205 at r1 (raw file):

              name="cr.node.admission.wait_durations.elastic-stores-p99"
              title={
                "Elastic (Background)" +

We could make do without the (Background), since we have used elastic several times on this page now.

Metrics keyed by nodeID and prefixed with long strings become very
difficult to read on the dashboard pages since they take up too much
horizontal space. In all of these cases, the context provided by the
graph title and Y axis label provide enough context to omit verbose
legend labels.

Resolves: cockroachdb#128046

Release note (ui change): some metric charts on the overview and
replication pages have more terse legends to facilitate easier
browsing.
@dhartunian dhartunian force-pushed the remove-unnecessary-metric-prefixes branch from 84f6a4f to 1c75c25 Compare August 19, 2024 15:18
Copy link
Collaborator Author

@dhartunian dhartunian left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (and 1 stale) (waiting on @aadityasondhi and @kyle-a-wong)


pkg/ui/workspaces/db-console/src/views/cluster/containers/nodeGraphs/dashboards/overload.tsx line 205 at r1 (raw file):

Previously, aadityasondhi (Aaditya Sondhi) wrote…

We could make do without the (Background), since we have used elastic several times on this page now.

Done.

@dhartunian
Copy link
Collaborator Author

TFTR!

bors r=aadityasondhi

@craig craig bot merged commit ebefe41 into cockroachdb:master Aug 20, 2024
22 of 23 checks passed
Copy link

blathers-crl bot commented Aug 20, 2024

Based on the specified backports for this PR, I applied new labels to the following linked issue(s). Please adjust the labels as needed to match the branches actually affected by the issue(s), including adding any known older branches.


Issue #128046: branch-release-23.2, branch-release-24.1, branch-release-24.2.


🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.

Copy link

blathers-crl bot commented Aug 20, 2024

Encountered an error creating backports. Some common things that can go wrong:

  1. The backport branch might have already existed.
  2. There was a merge conflict.
  3. The backport branch contained merge commits.

You might need to create your backport manually using the backport tool.


error creating merge commit from 1c75c25 to blathers/backport-release-23.2-129149: POST https://api.github.com/repos/cockroachdb/cockroach/merges: 409 Merge conflict []

you may need to manually resolve merge conflicts with the backport tool.

Backport to branch 23.2.x failed. See errors above.


🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-23.2.x Flags PRs that need to be backported to 23.2. backport-24.1.x Flags PRs that need to be backported to 24.1. backport-24.2.x Flags PRs that need to be backported to 24.2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ui: remove common prefixes from metric graphs when they're identical
3 participants