Monitoring Node Health

Flow nodes produce health metrics in the form of Prometheus metrics, exposed from the node software on /metrics.

If you wish to make use of these metrics, you'll need to set up a Prometheus server to scrape your Nodes. Alternatively, you can deploy the Prometheus Server on top of your current Flow node to see the metrics without creating an additional server.

1. Copy the following Prometheus configuration into your current flow node

   prometheus.yml
   Copy

   global:
   scrape_interval: 15s # By default, scrape targets every 15 seconds.
   
   scrape_configs:
    # The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
    - job_name: 'prometheus'
   
    # Override the global default and scrape targets from this job every 5 seconds.
    scrape_interval: 5s
   
    static_configs:
     - targets: ['localhost:8080']
   

2. Start Prometheus server

   docker run \
   --network=host \
   -p 9090:9090 \
   -v /path/to/prometheus.yml:/etc/prometheus/prometheus.yml \
   prom/prometheus"

3. (optional) Port forward to the node if you are not able to access port 9090 directly via the browser ssh -L 9090:127.0.0.1:9090 YOUR_NODE

4. Open your browser and go to the URL http://localhost:9090/graph to load the Prometheus Dashboard

Key Metric Overview

The following are some important metrics produced by the node