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

Document Prometheus metrics #5196

Open
2 tasks
LesnyRumcajs opened this issue Jan 29, 2025 · 2 comments
Open
2 tasks

Document Prometheus metrics #5196

LesnyRumcajs opened this issue Jan 29, 2025 · 2 comments
Assignees
@lemmih
Labels
Type: Documentation Create or update documentation Type: Task Discrete task to implement

Comments

@LesnyRumcajs
Copy link
Member

LesnyRumcajs commented Jan 29, 2025 •
edited
Loading

Summary

Something like this: https://docs.nethermind.io/monitoring/metrics/

It can be difficult to understand which metrics are relevant and what they all mean. Good docs can improve the NO experience.

Completion Criteria

  • Prometheus metrics are documented in user docs
  • Ideally, the metrics docs should be auto-generated, just like the CLI docs.

Additional Links & Resources

Migrated from https://github.com/ChainSafe/forest-docs-v2/issues/70
@LesnyRumcajs LesnyRumcajs added Type: Documentation Create or update documentation Type: Task Discrete task to implement labels Jan 29, 2025
@LesnyRumcajs LesnyRumcajs moved this from New to Ready in Forest Backlog 🌲 Feb 3, 2025
@LesnyRumcajs
Copy link
Member Author

And remove unnecessary ones!

@LesnyRumcajs
Copy link
Member Author

@lemmih For the removal of unnecessary ones, please see #3509.

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

@lemmih lemmih

Labels
Type: Documentation Create or update documentation Type: Task Discrete task to implement
Projects
Forest Backlog 🌲
Status: Ready
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lemmih @LesnyRumcajs