docs: explain how to add metrics to grafana #11875
Merged
Conversation
This file contains 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
Rjected
previously requested changes
Oct 18, 2024
etc/README.md
Outdated
Comment on lines
18
to
20
| Thank you for providing that context. I understand now that this text is already part of a subsection. I'll revise it to | ||
| fit better within that structure while still improving clarity and readability. | ||
|
|
etc/README.md
Outdated
Comment on lines
65
to
64
| 9. Update dashboard file: | ||
| - Replace the content of the corresponding file in the [dashboards folder](grafana/dashboards) with the exported | ||
| JSON |
There was a problem hiding this comment.
Suggested change
| 9. Update dashboard file: | |
| - Replace the content of the corresponding file in the [dashboards folder](grafana/dashboards) with the exported | |
| JSON | |
| 9. Update dashboard file: | |
| - Replace the content of the corresponding file in the [dashboards folder](./grafana/dashboards) with the exported | |
| JSON |
etc/README.md
Outdated
Comment on lines
30
to
36
| 2. Build the Reth image: | ||
| ```bash | ||
| docker build . -t reth:local | ||
| ``` | ||
| Modify the [docker-compose](docker-compose.yml) file to use your locally built image for the Reth service. | ||
|
|
||
| 3. Run Docker Compose: | ||
| ```bash | ||
| docker compose -f etc/docker-compose.yml -f etc/lighthouse.yml up -d | ||
| ``` |
There was a problem hiding this comment.
I don't think we should necessarily recommend using docker compose for this, let's just say that they should have a reth instance running, and a grafana instance running.
There was a problem hiding this comment.
hmmm these are docs written for a contributor no? personally found that docker was the easiest way for me to get everything up and running so that I could start adding a new panel
There was a problem hiding this comment.
Adding these as steps make it seem a bit like it's required, but I guess it's worth making a note that we have the docker compose. I personally find it a bit hard to work with, and like to just run reth outside of docker normally
etc/README.md
Outdated
| 6. Configure your metric panel: | ||
| - Set a panel title and description | ||
| - Select metric(s) from the `Metrics browser` or use the `PromQL` terminal | ||
| - Document your metric(s) by setting units, legends,... |
There was a problem hiding this comment.
Suggested change
| - Document your metric(s) by setting units, legends,... | |
| - Document your metric(s) by setting units, legends, etc. |
etc/README.md
Outdated
Comment on lines
71
to
74
| #### Import Grafana dashboards | ||
|
|
||
| Running Grafana in Docker makes it possible to import existing dashboards, refer | ||
| to [docs on how to run only Grafana in Docker](/book/installation/docker.md#using-docker-compose#run-only-grafana-in-docker). |
There was a problem hiding this comment.
This is also possible without using docker, we should just add some notes on how to import the dashboard after it changes on main
etc/README.md
Outdated
|
|
||
| #### Adding a new metric to Grafana | ||
|
|
||
| To set up a new metric in the Reth Grafana dashboard: |
There was a problem hiding this comment.
Suggested change
| To set up a new metric in the Reth Grafana dashboard: | |
| To set up a new metric in Reth and its Grafana dashboard: |
mattsse
added
the
A-observability
greged93
force-pushed
the
greged93/docs/grafana
branch
2 times, most recently
from
8650897 to
46c975c
Compare
greged93
force-pushed
the
greged93/docs/grafana
branch
from
46c975c to
8f67b3a
Compare
onbjerg
changed the title
onbjerg
changed the title
onbjerg
approved these changes
Oct 19, 2024
This was referenced Oct 24, 2024
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.
This PR adds documentation related to adding a new panel to Grafana and resolves #10794.