goerli / ethstats-client Goto Github PK

Ethereum Network Intelligence API a.k.a. "ethstats"

License: GNU General Public License v3.0

Dockerfile 7.12% JavaScript 77.80% Shell 15.09%

ethstats-client's Introduction

Ethereum Network Intelligence API

This is the backend service which runs along with ethereum nodes and tracks the network status, fetches information through JSON-RPC and connects through WebSockets to an ethstats-server to feed information.

Available dashboards

Prerequisite

client: geth, besu, nethermind, or openethereum
reporting: node js, npm, and pm2

Installation

Clone the repository, install node dependencies, and run the pm2 daemon.

git clone https://github.com/goerli/ethstats-client.git
cd ethstats-client/
npm install
sudo npm install -g pm2

Configuration

Configure the app modifying app.json.

[
  {
    "name"              : "besu-goerli",
    "script"            : "app.js",
    "log_date_format"   : "YYYY-MM-DD HH:mm Z",
    "merge_logs"        : false,
    "watch"             : false,
    "max_restarts"      : 10,
    "exec_interpreter"  : "node",
    "exec_mode"         : "fork_mode",
    "env":
    {
      "NODE_ENV"        : "production",
      "RPC_HOST"        : "localhost",
      "RPC_PORT"        : "8545",
      "LISTENING_PORT"  : "30303",
      "INSTANCE_NAME"   : "My Besu Goerli Node 1337",
      "CONTACT_DETAILS" : "[email protected]",
      "WS_SERVER"       : "ws://stats.goerli.net:3000",
      "WS_SECRET"       : "XXXXXXXXXX",
      "VERBOSITY"       : 2
    }
  }
]

Ask in Gitter for the secret: https://gitter.im/goerli/testnet

Available Websockets:

ws://ethstats.net:3000
ws://stats.goerli.net:3000
ws://kotti.goerli.net:3000
ws://mordor.dash.fault.dev:3000
ws://classic.dash.fault.dev:3000

The secrets for Mordor, Kotti, Goerli, and Classic are the same. The Ethereum mainnet secret is different.

Run

Run it using pm2:

pm2 start app.json

ethstats-client's People

Contributors

Stargazers

Watchers

ethstats-client's Issues

Running ethstats-client on sealer nodes

In the newer versions of geth ~1.9.5, --unlock could no longer be used if rpc / ws was opened on the geth node. Thus for us, the sealer nodes no longer expose an rpc node.

As of now ethstats-client doesn't support using an ipc path to connect to web3 but on https://stats.goerli.net/ we still see some sealers running the newer geth versions reporting their metrics.

For a testnet chain (stats.mosaicdao.org), we want our sealers also to be visible on ethstats-server we host, how can we achieve that ?

Automated Docker hub build

As someone who runs this in Docker, it'd be nice to have an automated Docker build in the hub so I don't need to create a repo myself and then re-build when any changes happen.

Can you set this up?

Work with Erigon?

I don't know if this is an issue with ethstats-client or erigon but it would be nice if someone could figure out how to make this work with Erigon...

erigontech/erigon#2004

stats.goerli.net shows Service Unavailable - add Backup Dashboard to processes.json?

Hello, thanks for the great effort here at Goerli! Right now, https://stats.goerli.net/ is down and reporting Service Unavailable and the backup Dashboard at http://ethstats.goerli.ethberl.in:3000/ is not showing any active nodes. What is the procedure to add both the primary and backup dashboards to the ethtstats-client? Ideally, both Dashboards will be fed information and service will remain visible via the secondary dashboard in the case of primary dashboard failure, as is the case right now.

Looking forward to a response and to contributing!