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: document each metrics on UI page #28379

Closed
robert-s-lee opened this issue Aug 8, 2018 · 6 comments
Closed

ui: document each metrics on UI page #28379

robert-s-lee opened this issue Aug 8, 2018 · 6 comments
Labels
A-docs C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) no-issue-activity X-stale

Comments

@robert-s-lee
Copy link
Contributor

Follow up from #28377

@piyush-singh consistency checker does not have the information icon that provides a context of how to interpret this metric. Any thought on providing context based on this and other related issues to provide general guidance.

@jess-edwards Any thoughts on how to structure document of these metrics one by one organically. This will be important to enable self-service diagnostics and scale the adoption.

@jess-edwards
Copy link
Contributor

@jseldess I think this one's for you.

@jseldess
Copy link
Contributor

jseldess commented Aug 8, 2018

Thanks, @jess-edwards. @Amruta-Ranade is really the right person here.

Our current admin UI docs claim:

The Admin UI also provides details about the way data is Distributed, the state of specific Queues, and metrics for Slow Queries, but these details are largely internal and intended for use by CockroachDB developers.

If this isn't accurate anymore, and users do need to look at these dashboards, we should both add tooltips and add explicit pages. @Amruta-Ranade, @robert-s-lee, thoughts?

@Amruta-Ranade
Copy link
Contributor

I agree. If users need to look at these dashboards, we should add tooltips and docs for them. Will take this up next week (post-Docs 2.1 week), if that's okay.

@robert-s-lee
Copy link
Contributor Author

CockroachDB customers tend to be sophisticated. Performance, Scalability, Troubleshooting can be aided by understanding how to interpret these metrics. Post doc 2.1 would be good to re-visit and determine the next steps.

@Amruta-Ranade
Copy link
Contributor

Definitely. I am working on a similar project - will put something on the calendar to discuss the next steps.

@knz knz added A-docs C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) labels Sep 17, 2018
@github-actions
Copy link

github-actions bot commented Jun 6, 2021

We have marked this issue as stale because it has been inactive for
18 months. If this issue is still relevant, removing the stale label
or adding a comment will keep it active. Otherwise, we'll close it in
5 days to keep the issue queue tidy. Thank you for your contribution
to CockroachDB!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) no-issue-activity X-stale
Projects
None yet
Development

No branches or pull requests

5 participants