paradigmxyz / reth

Modular, contributor-friendly and blazing-fast implementation of the Ethereum protocol, in Rust
https://reth.rs/
Apache License 2.0
3.94k stars 1.17k forks source link

Create guide on how to add and update grafana panels #10794

Closed Rjected closed 2 weeks ago

Rjected commented 1 month ago

It's extremely easy to add new metrics (example: https://github.com/paradigmxyz/reth/pull/10728), and it's also generally very useful.

However, we often have grafana panels that become out of date, or we add new metrics without adding panels, which hurts observability for us, and for users.

To add to this, the grafana panel json objects have lots of different fields that are usually generated, making it difficult to contribute to the dashboard by manually editing the dashboard json.

The recommended way, then, is to use the grafana GUI to create new panels. Creating new panels is fairly easy as long as there is a grafana instance running! This has a few problems however:

We need to create a small tutorial on how to add panels, with the following details:

  1. How to set up a grafana instance, assuming a node with the metrics is running
  2. How to add a panel using the GUI, and visualize a new metric
  3. How to export the panel and prepare a PR
0xkrane commented 1 month ago

can take this on

Rjected commented 1 month ago

@0xkrane assigned!

greged93 commented 3 weeks ago

hey @0xkrane were you able to work on this or could I take over?

greged93 commented 2 weeks ago

@Rjected let me know if I can take over

Rjected commented 2 weeks ago

@greged93 assigned!