The NuCypher Monitor collects data about the NuCypher Network via the Crawler
and displays this information in a UI via the Dashboard.
$ pip install -e . -r requirements.txt$ pip install -e . -r dev-requirements.txt-
Installation of InfluxDB
The Monitor
Crawlerstores network blockchain information in anInfluxDBtime-series instance. The default connection is made to a local instance. -
Installation of Geth Ethereum Node
The Monitor needs a Web3 node provider to obtain blockchain data.
$ nucypher-monitor --help
Usage: nucypher-monitor [OPTIONS] COMMAND [ARGS]...
Options:
--nucypher-version Echo the nucypher version
--help Show this message and exit.
Commands:
crawl Gather NuCypher network information.
dashboard Run UI dashboard of NuCypher network.- Run InfluxDB
$ sudo influxd
8888888 .d888 888 8888888b. 888888b.
888 d88P" 888 888 "Y88b 888 "88b
888 888 888 888 888 888 .88P
888 88888b. 888888 888 888 888 888 888 888 888 8888888K.
888 888 "88b 888 888 888 888 Y8bd8P' 888 888 888 "Y88b
888 888 888 888 888 888 888 X88K 888 888 888 888
888 888 888 888 888 Y88b 888 .d8""8b. 888 .d88P 888 d88P
8888888 888 888 888 888 "Y88888 888 888 8888888P" 8888888P"
2020-01-29T19:07:09.671836Z info InfluxDB starting {"log_id": "0Kdg2Tul000", "version": "1.7.8", "branch": "1.7", "commit": "ff383cdc0420217e3460dabe17db54f8557d95b6"}
...
- Run Geth node as a Web3 node provider (or use Infura)
$ geth --goerli --nousb
INFO [01-29|11:06:06.816] Maximum peer count ETH=50 LES=0 total=50
...
INFO [01-29|11:06:09.046] Started P2P networking self=enode://1eb7c99106888c206583abc63fc58da1c202965b32486115575d27e03aba0e0c1be433f0a7060da3ecc95afbbce845a7d3df703307d94fe328602c3d105daf36@127.0.0.1:30303
INFO [01-29|11:06:09.048] IPC endpoint opened url=/home/k/.ethereum/goerli/geth.ipc- Run the
Crawler
$ nucypher-monitor crawl --provider <YOUR_WEB3_PROVIDER_URI> --network <NETWORK NAME>
| |___ ___|_| |_ ___ ___
| | | | . | | | _| . | _|
|_|_|_|___|_|_|_|_| |___|_|
========= Crawler =========
Connecting to preferred teacher nodes...
Network: <NETWORK NAME>
InfluxDB: 0.0.0.0:8086
Provider: ...
Refresh Rate: 60s
Running Nucypher Crawler JSON endpoint at http://localhost:9555/stats- Run the
Dashboard
$ nucypher-monitor dashboard --provider <YOUR WEB3 PROVIDER URI> --network <NETWORK NAME>
_____ _ _
| |___ ___|_| |_ ___ ___
| | | | . | | | _| . | _|
|_|_|_|___|_|_|_|_| |___|_|
========= Dashboard =========
Network: <NETWORK NAME>
Crawler: localhost:9555
InfluxDB: localhost:8086
Provider: ...
Running Monitor Dashboard - https://127.0.0.1:12500
- The
DashboardUI is available at https://127.0.0.1:12500.
Docker Compose will start InfluxDB, Crawler, and Dashboard containers, and no installation of the monitor is required.
- Set required environment variables
-
Web3 Provider URI environment variable
NOTE: local ipc is not supported when running via Docker
export WEB3_PROVIDER_URI=<YOUR WEB3 PROVIDER URI>- Network Name environment variable
export NUCYPHER_NETWORK=<NETWORK NAME>- Let's Encrypt certificates location
export NUCYPHER_LETSENCRYPT_DIR=<DIRECTORY LOCATION>You can create certificates for localhost using openssl command:
openssl req -x509 -out fullchain.pem -keyout key.pem \
-newkey rsa:2048 -nodes -sha256 \
-subj '/CN=localhost' -extensions EXT -config <( \
printf "[dn]\nCN=localhost\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltName=DNS:localhost\nkeyUsage=digitalSignature\nextendedKeyUsage=serverAuth")
- Run Docker Compose
docker-compose -f deploy/docker-compose.yml upAlternatively, you can run the services individually
docker-compose -f deploy/docker-compose.yml up -d influxdb
docker-compose -f deploy/docker-compose.yml up -d crawler
docker-compose -f deploy/docker-compose.yml up -d webNOTE: If the --poa flag is required, the deploy/docker-compose.yml file should be modified to append the --poa flag to the command entries for the crawler and web services
- View Docker compose logs
docker-compose -f deploy/docker-compose.yml logs -fAlternatively, to view logs for a specific service
docker-compose -f deploy/docker-compose.yml logs -f <SERVICE_NAME>- The
DashboardUI is available on port 12500.