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

Cleanly separate the documents metrics.md and metrics-reference.md #368

Closed
kvosper opened this issue Jan 3, 2019 · 2 comments
Closed

Cleanly separate the documents metrics.md and metrics-reference.md #368

kvosper opened this issue Jan 3, 2019 · 2 comments
Assignees
Labels

Comments

@kvosper
Copy link
Contributor

kvosper commented Jan 3, 2019

The problem

The purposes of the documents metrics.md and metrics-reference.md have become a little muddled. We are adding metrics in some places and not others and it's not clear which document to read.

Detailed description

metrics.md should be describing how a user can get information from our metrics, whereas metrics-reference.md is supposed to be an exhaustive list giving a description of each metric.

As well as filling in any gaps in metrics-reference.md, we should try to avoid just dumping the names of every metric into metrics.md, instead we should simply say which prefix to look under for particular categories of information and then point readers to metrics-reference.md for more details.

Acceptance criteria

  • Add any missing metrics to metrics-reference.md
  • Avoid describing exact metrics in metrics.md (exceptions can be made if it is necessary to illustrate an example, but we should avoid overdoing it)
@mikkokar
Copy link
Contributor

mikkokar commented Sep 19, 2019

Action point: Take a metrics dump from a running instance and update the metrics reference accordingly.

@mikkokar mikkokar added the P4 label Oct 4, 2019
@mikkokar mikkokar self-assigned this Oct 7, 2019
@mikkokar
Copy link
Contributor

mikkokar commented Oct 8, 2019

Fixed by #469

@mikkokar mikkokar closed this as completed Oct 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants