docs(l1): document our grafana dashboard #5146
Open
+130
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rodrigo-o
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the Ethrex L1 Performance Dashboard along with supporting screenshots. The documentation describes how to use the Grafana dashboard and explains each panel's purpose.
- Added new
dashboards.mdfile with detailed documentation of dashboard panels and their usage - Added 10 PNG screenshot files to illustrate various dashboard components
- Updated the L1 documentation index to include the new dashboards page
Reviewed Changes
Copilot reviewed 2 out of 25 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/developers/l1/introduction.md | Added link to new dashboards documentation |
| docs/developers/l1/dashboards.md | New comprehensive dashboard documentation with panel descriptions |
| docs/developers/l1/img/*.png | Screenshot images supporting the dashboard documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
We want to have documentation about the current state of our grafana dashboard.
Description
This PR documents the dashboard in general and go panel by panel adding images and a small description for each.
It also documents the limitations found with the Ggas/s by block panel.
Closes #5048