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

Fix metrics descriptions: dupes and rates #92925

Open
andf-crl opened this issue Dec 2, 2022 · 0 comments
Open

Fix metrics descriptions: dupes and rates #92925

andf-crl opened this issue Dec 2, 2022 · 0 comments
Labels
C-bug Code not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior.

Comments

@andf-crl
Copy link

andf-crl commented Dec 2, 2022

Describe the problem

8 metrics have the word replica duplicated in the description. See To Reproduce.

This is important because DOCS will shortly be populating metrics descriptions exclusively from chartcatalog output i.e. verbatim from what you write.

While in there, please update any metrics descriptions that are rates but don't say so to say so, and audit other metrics within your purview for similar. I can help with this effort -- please ping me.

For starters:

range.snapshots.rebalancing.rcvd-bytes | Number of rebalancing snapshot bytes received
range.snapshots.rebalancing.sent-bytes | Number of rebalancing snapshot bytes sent
range.snapshots.recovery.rcvd-bytes | Number of recovery snapshot bytes received
range.snapshots.recovery.sent-bytes | Number of recovery snapshot bytes sent

These are all rates: number per second.

To Reproduce

curl -s http://localhost:8080/_admin/v1/chartcatalog | grep 'replica replica'

Expected behavior
Descriptions are as accurate as possible!

Environment:

  • CockroachDB v22.2.0-rc.3

Additional context
Thanks very much team! Happy to help audit any and all metrics descriptions, or to pair on this work with engineering.

Jira issue: CRDB-22056

@andf-crl andf-crl added the C-bug Code not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior. label Dec 2, 2022
@andf-crl andf-crl changed the title Duplicate words in metrics descriptions. Fix metrics descriptions: dupes and rates Dec 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Code not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior.
Projects
None yet
Development

No branches or pull requests

1 participant