diff --git a/README.md b/README.md index f6ac75932..57a59f70c 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,8 @@ Note: The default branch `master` is the dev branch where the latest new feature 6. You should now have Lotus installed. You can now [start the Lotus daemon and sync the chain](https://lotus.filecoin.io/lotus/install/linux/#start-the-lotus-daemon-and-sync-the-chain). +7. (Optional) Follow the [Setting Up Prometheus and Grafana](https://github.com/filecoin-project/lotus/tree/master/metrics/README.md) guide for detailed instructions on setting up a working monitoring system running against a local running lotus node. + ## License Dual-licensed under [MIT](https://github.com/filecoin-project/lotus/blob/master/LICENSE-MIT) + [Apache 2.0](https://github.com/filecoin-project/lotus/blob/master/LICENSE-APACHE) diff --git a/metrics/README.md b/metrics/README.md index 1d3950881..a8865d3bd 100644 --- a/metrics/README.md +++ b/metrics/README.md @@ -12,6 +12,8 @@ Lotus supports exporting a wide range of metrics, enabling users to gain insight - You have root access to install software - You have lotus node already running +**Note:** These instructions have been tested on Ubuntu 23.04 and on Mac M1. + ## Install and start Prometheus ### On Ubuntu: @@ -71,7 +73,7 @@ brew install grafana brew services start grafana ``` -You should now have Prometheus and Grafana running on your machine where Promotheus is already collecting metrics from your running Lotus node and saving it to a database. +You should now have Prometheus and Grafana running on your machine where Promotheus is already collecting metrics from your Lotus node (if its running) and saving it to a database. You can confirm everything is setup correctly by visiting: - Prometheus (http://localhost:9090): You can open the metric explorer and view any of the aggregated metrics scraped from Lotus @@ -102,7 +104,6 @@ Although Lotus includes many useful metrics it does not include system metrics s ## Install node_exporter If you have followed this guide so far and have Prometheus and Grafana already running, you can run the following commands to also aggregate the system metrics: - Ubuntu: ```