-
Notifications
You must be signed in to change notification settings - Fork 37
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
feat(grafana): add grafana support #137
base: main
Are you sure you want to change the base?
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.
I won't leave an Approval here, since I am very inexperienced with Kurtosis &co, but looking over the premise, this seems to be what we want, a grafana deployment that comes up just after prometheus, and uses some existing dashboard definition.
Left minor comments, but generally excited for this one!
496a732
to
b38742b
Compare
is the link https://github.com/ethereum-optimism/grafana-dashboards valid? it returns 404 for me |
Description
This PR builds on the previously-added Prometheus support to add Grafana support by:
grafana_params
section to the top-levelobservability
parameter sectionThe
grafana
module from theethereum-package
package was used as inspiration, but modified to simplify devX by removing support for inline dashboards and improving remote dashboard source support.Additionally, this PR implements API provisioning using the official grizzly tool, over the existing file-based provisioning approach to simplify the process of keeping Kurtosis Grafana in-sync with hosted Grafana. To this end, a new
grafana-dashboards
repository has been created, with the intention of tracking extant dashboards in hosted Grafana. This repository is currently set to internal visibility, and must be approved for open-sourcing prior to this PR being merged.This PR has been tested and successfully deploys a Grafana server with including all dashboards present on our hosted Grafana instance, organized into the same folder structure:
Not all dashboards are yet at full parity, but a fair number of them do show data:
If you want to try this out locally, add the following snippet to your params file:
Note that
dashboard_sources
is currently pointed at https://github.com/edobry/grafana-dashboards as a temporary measure until I get admin approval to publicize theethereum-optimism
repo.Remaining work:
grafana-dashboards
repository