Flow Playground

Monitoring Node Health


Logs are emitted to stdout as JSON formed strings. Where these logs are available on your system depends on how you launch your containers. On systemd systems for example, the logs will be sent to the system journal daemon journald. Other systems may log to /var/log.

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.

Host Metrics
The flow-go application doesn't expose any metrics from the underlying host such as CPU, network, or disk usages. It is recommended you collect these metrics in addition to the ones provided by flow using a tool like node exporter (https://github.com/prometheus/node_exporter)
  1. Copy the following Prometheus configuration into your current flow node

    scrape_interval: 15s # By default, scrape targets every 15 seconds.
     # 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
      - targets: ['localhost:8080']
  2. Start Prometheus server

   docker run \
   --network=host \
   -p 9090:9090 \
   -v /path/to/prometheus.yml:/etc/prometheus/prometheus.yml \
  1. (optional) Port forward to the node if you are not able to access port 9090 directly via the browser ssh -L 9090: YOUR_NODE

  2. 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

Metric NameDescription
go_*Go runtime metrics
consensus_finalized_blocksNumber of blocks this node has finalized
consensus_hotstuff_busy_durationHow long Hotstuff spends in a busy state before returning to idle
consensus_hostuff_busy_second_totalThe total time Hotstuff has spent in a busy state
consensus_hotstuff_view_of_newest_known_qcThe latest block known to Hotstuff
Edit on GitHub