-
Notifications
You must be signed in to change notification settings - Fork 131
docs(l1): update dashboard documentation #5334
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the L1 dashboard documentation by adding detailed descriptions for monitoring panels. The changes expand the existing "Block execution breakdown" section and introduce two new major sections covering Engine API and RPC API monitoring capabilities.
- Adds comprehensive documentation for multiple dashboard panels and their limitations
- Includes new image references for visual aids
- Provides clearer explanations of metrics and their use cases
Reviewed Changes
Copilot reviewed 1 out of 15 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/developers/l1/dashboards.md | Expands dashboard documentation with detailed panel descriptions for block execution, Engine API, and RPC API monitoring sections |
| docs/developers/l1/img/*.png | Adds new screenshot images to illustrate dashboard panels (binary files) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Motivation
Document the new execution breakdown and RPC panels in the dashboard as well as other metric related docs
Description
This PR documents both #5220 and #5311 additions, so we might want to merge #5311 first.
It updates the gap analysis, the actual dashboard doc and some metrics related docs. It also sets prometheus scrape to 5s as already done today on our centralized grafana instance.
Quick link to check the updated dashboard doc out with the viewer