feat: add Grafana tutorial and templates #675
Conversation
|
@rjan90 : would it be helpful for me to review so this can land? |
|
I think the progress on this PR stopped, when I mentally expanded the scope of this work by trying to write up "how to setup Graphing on a remote machine", but for now I think setting it up locally is just fine. I will look at doing a cleanup of this PR on 2024-09-30 |
Adding Grafana dashboard tutorial
Update weights across tutorial section
rjan90
force-pushed
the
feat/add-grafana-tutorial
branch
from
ffbb6fb to
856ccc3
Compare
chore: update Grafana tutorial
There was a problem hiding this comment.
I trust your judgement here, but I would look at how to reduce the duplication between this and filecoin-project/lotus#12934 . Ideally we're doing more pointing from one to the other than copy/pasting
| brew install prometheus | ||
|
|
||
| # start prometheus | ||
| prometheus --config.file=lotus/metrics/prometheus.yml |
There was a problem hiding this comment.
Where does lotus/metrics/prometheus.yml live? In the Lotus repo right? How come we don't need to do this on the Linux side? Maybe use a variable to represent the lotus directory so it's clear that everyone needs to set it for themselves?
|
|
||
| **Note:** These instructions have been tested on Ubuntu 23.04 and on Mac M1. | ||
|
|
||
| ## Install and start Prometheus |
There was a problem hiding this comment.
Nice thing about this is that it is complete for someone, but the downside is we have a snapshot in time for how to install. Pointing to install docs of the respective project are more likely to stay updated. Your call.
|
|
||
| 1. Log in to Grafana using the web interface. | ||
| 2. Navigate to "Home" > "Dashboards" > Click the drop down menu in the "New" button and select "Import" | ||
| 3. Paste any of the existing dashboards in lotus/metrics/grafana into the "Import via panel json" panel. |
There was a problem hiding this comment.
| 3. Paste any of the existing dashboards in lotus/metrics/grafana into the "Import via panel json" panel. | |
| 3. Paste any of the existing dashboards in `lotus/metrics/grafana` into the "Import via panel json" panel. |
There was a problem hiding this comment.
There's a lot of duplication between this and what's in https://github.com/filecoin-project/lotus/blob/master/metrics/README.md . Do we just want to have one point to the other for those parts?
| 5. Select the Prometheus datasource you created earlier | ||
| 6. Click "Import" | ||
|
|
||
| ### Available Dashboards |
There was a problem hiding this comment.
github-project-automation
bot
moved this from 🔎 Awaiting Review
to ✔️ Approved by reviewer
in FilOz
Porting over the Grafana dashboard tutorial from here: filecoin-project/lotus#11276 and updated in: filecoin-project/lotus#12934.
Can be merged once 12934 lands