Skip to content
This repository has been archived by the owner on Aug 23, 2023. It is now read-only.

Provide more structure to docs/metrics.md #1731

Closed
woodsaj opened this issue Mar 27, 2020 · 1 comment
Closed

Provide more structure to docs/metrics.md #1731

woodsaj opened this issue Mar 27, 2020 · 1 comment

Comments

@woodsaj
Copy link
Member

woodsaj commented Mar 27, 2020

Metrics2docs searches the code base for metric definitions and builds a docs page using the comments in the code.

In addition to having metrics for the core metrictank binary we also have metrics in other tooling that lives in cmd/*

To make things more clear, we should improve how the metrics are documented, grouping related metrics in separate sections in the current doc, or in individual doc files.

An alternative to the metrics2docs tool would be to embed an API endpoint within our binaries that returns descriptions of all of the metrics that have been registered, similar to the descriptions included when you scrape prometheus metrics.

@stale
Copy link

stale bot commented Jun 25, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jun 25, 2020
@stale stale bot closed this as completed Jul 2, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant