diff --git a/etc/README.md b/etc/README.md index 4d9f9bb1f23b..0d9d663691da 100644 --- a/etc/README.md +++ b/etc/README.md @@ -25,36 +25,44 @@ To set up a new metric Reth and its Grafana dashboard: documentation. 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. + + ```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 - ``` + + ```bash + docker compose -f etc/docker-compose.yml -f etc/lighthouse.yml up -d + ``` 4. Access Grafana: + - Open `http://localhost:3000/` in a browser - Log in with username and password `admin` - Navigate to the `Dashboards` tab 5. Create or modify a dashboard: + - Select an existing dashboard or create a new one - Click `Add` > `Visualization` to create a new panel 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, etc. - When adding multiple metrics, use field overwrites if needed 7. Save and arrange: + - Click `Apply` to save the panel - Drag the panel to desired position on the dashboard 8. Export the dashboard: + - Click `Share` > `Export` - Toggle `Export for sharing externally` - Click `Save to file`