Skip to content

Lite Network Health Monitor

Use the EthStats Lite Network Health Monitor to monitor the health of private networks by displaying real time and historical statistics about the network nodes.

The lite version supports in-memory persistence or using Redis to persist a fixed number of blocks (by default, 3000).

View the Network Health Monitor for the Ethereum MainNet.

Note

The EthStats Lite Block Explorer is an Alethio product.

Static local ports 80 and 3000 are used in the example of running the Lite Network Health Monitor for a Pantheon Node.

Statistics

Statistics displayed by the Network Health Monitor include:

  • Nodes in the network. Metrics for nodes include:
    • Information about the last received block such as block number, block hash, transaction count, uncle count, block time and propagation time
    • Connected peers, whether the node is mining, hash rate, latency, and uptime
  • Charts for Block Time, Block Difficulty, Block Gas Limit, Block Uncles, Block Transactions, Block Gas Used, Block Propagation Histogram, and Top Miners
  • IP based geolocation overview
  • Node logs. Node logs display the data sent by a node
  • Block history. Block history provides the ability to go back in time and playback the block propagation through the nodes

Components

The Network Health Monitor consists of:

  • Server. Consumes node data received from the client.

  • Client. A client must be started for each node in the network. The client extracts data from the node and sends it to the server

  • Dashboard. Dashboard displaying statistics.

Pre-requisities

Docker

Tip

The Network Health Monitor has a number of dependencies. Using Docker is the easiest way to demonstrate the using the Network Health Monitor with Pantheon. The EthStats CLI, EthStats Network Server, and EthStats Network Dashboard documentation describes how to install the Network Heath Explorer tools.

Running Lite Network Health Monitor for a Pantheon Node

This example describes how to run the Lite Network Heath Monitor for a single Pantheon node. To run the Lite Network Health Monitor for a network of nodes, a client must be started for each node.

1. Server

Start the server using in-memory persistence:

  1. Clone the server repository:

    git clone https://github.com/Alethio/ethstats-network-server.git
    
  2. Change into the /ethstats-network-server/docker/lite-mode/memory-persistence directory:

    cd ethstats-network-server/docker/lite-mode/memory-persistence
    
  3. Use the provided docker-compose file to start the server:

    docker-compose up -d
    

Tip

A docker-compose file is also provided in the ethstats-network-server/docker/lite-mode/redis-persistence directory to run the server using Redis to persist a fixed number of blocks (default is 3000).

2. Pantheon

Start Pantheon in development mode with Websockets enabled:

docker run --rm -p 8546:8546 pegasyseng/pantheon:latest --miner-enabled --miner-coinbase fe3b557e8fb62b89f4916b721be55ceb828dbd73 --rpc-http-cors-origins="all" --rpc-ws-enabled --network=dev

Where <pantheondata-path> is the volume to which the node data is saved.

3. Client

Start the client for the Pantheon node:

docker run -d --rm --net host alethio/ethstats-cli --register --account-email <email> --node-name <node_name> --server-url http://localhost:3000 --client-url ws://127.0.0.1:8546

Where:

  • --server-url specifies your server. The default is the server that consumes data for the Ethereum MainNet.
  • --register specifies the registration of the Pantheon node is done automatically with the specified <email> and <node_name>. Registering the node is only required the first time the client is started for the node.
  • --client-url specifies the WebSockets URL for the Pantheon node.

4. Dashboard

To display the Network Health Monitor dashboard, open localhost in your browser.

Stopping and Cleaning Up Resources

When you’ve finished running the Network Health Monitor:

  1. Stop Pantheon using Ctrl+C.

  2. Stop the server and remove containers and volumes:

    docker-compose down -v
    
  3. Obtain client container ID:

    docker ps 
    
  4. Stop the client and remove container:

    docker rm -f <id>
    
Questions or feedback? You can discuss issues and obtain free support on Pantheon Gitter channel.
For paid professional support by PegaSys, contact us at [email protected]