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.

Sign up for GitHub

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

Jump to bottom

Auto-generate Prometheus metric docs #213

Closed
2 tasks
tanveergill opened this issue Aug 28, 2022 · 1 comment
Closed
2 tasks

Auto-generate Prometheus metric docs #213

tanveergill opened this issue Aug 28, 2022 · 1 comment
Assignees
@seunghyupoh3517
Labels
Documentation

Comments

@tanveergill
Copy link
Contributor

Describe the solution you'd like

  • Auto-generate documentation for Prometheus metrics using golang code annotations:
@tanveergill
Copy link
Contributor Author

Decided to create the docs manually: #720

Rationale: Takes the same manual effort to create annotation via generators. Manual catalog is less effort overall. And works for both Prometheus and OLAP Flow events

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@seunghyupoh3517 seunghyupoh3517

Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tanveergill @seunghyupoh3517