Skip to content

Commit

Permalink
Update alethio ethstats and explorer docs (PegaSysEng#1532)
Browse files Browse the repository at this point in the history
  • Loading branch information
NicolasMassart authored and iikirilov committed Jun 8, 2019
1 parent 4b9cd81 commit 5e27190
Show file tree
Hide file tree
Showing 7 changed files with 111 additions and 70 deletions.
Original file line number Diff line number Diff line change
@@ -1,25 +1,29 @@
description: Ethereum Lite Explorer
<!--- END of page meta data -->

# Ethereum Lite Explorer
# Alethio Ethereum Lite Explorer

Use the [Ethereum Lite Explorer](https://lite-explorer.aleth.io/) to explore blockchain data at the block, transaction,
and account level.
Use the [Alethio Ethereum Lite Explorer](https://lite-explorer.aleth.io/) to explore blockchain data
at the block, transaction, and account level.

The Ethereum Lite Explorer is a client-side only web application that connects to any Ethereum
JSON RPC enabled node. No server, hosting, or trusting third parties to display the blockchain data is
required.
The Alethio Ethereum Lite Explorer is a web application that connects to any Ethereum
JSON-RPC enabled node. No online server, hosting, or trusting third parties to display the blockchain
data is required.

!!! note
The Ethereum Lite Explorer is an [Alethio product](https://aleth.io/).
The Alethio Ethereum Lite Explorer is an [Alethio product](https://company.aleth.io/developers).

## Prerequisites

[Docker](https://docs.docker.com/install/) or [npm](https://www.npmjs.com/get-npm)
[Docker](https://docs.docker.com/install/) or [Node.js](https://nodejs.org/)

!!! tip
Using Docker is the easiest way to get started using the Ethereum Lite Explorer with Pantheon if you
do not have Node.js installed.

## Run Using Docker

To run the Lite Explorer using the Docker image:
To run the Ethereum Lite Explorer using the Docker image:

1. Start Pantheon with the [`--rpc-http-enabled`](../Reference/Pantheon-CLI-Syntax.md#rpc-http-enabled) option.

Expand All @@ -31,15 +35,22 @@ To run the Lite Explorer using the Docker image:
pantheon --network=dev --miner-enabled --miner-coinbase=0xfe3b557e8fb62b89f4916b721be55ceb828dbd73 --rpc-http-cors-origins="all" --host-whitelist=* --rpc-http-enabled --data-path=/tmp/tmpDatdir
```

1. Run the `alethio/ethereum-lite-explorer` Docker image specifying the RPC HTTP URL (`http://localhost:8545` in this example):
1. Run the `alethio/ethereum-lite-explorer` Docker image specifying the JSON-RPC HTTP URL (`http://localhost:8545` in this example):

```bash
docker run -p 80:80 -e NODE_URL=http://localhost:8545 alethio/ethereum-lite-explorer
docker run --rm -p 8080:80 -e APP_NODE_URL=http://localhost:8545 alethio/ethereum-lite-explorer
```

1. Open [localhost](http://localhost) in your browser to view the Lite Explorer.
1. Open [http://localhost:8080](http://localhost) in your browser to view the Lite Explorer.

![Ethereum Lite Explorer](explorer.png)

!!! note "Default HTTP port"
We are using port 8080 to run the Ethereum Lite Explorer so
the [Lite Network Monitor](Lite-Network-Monitor.md) can use port 80. You can then run
both at the same time.

## Install and Run
## Install and Run with Node.js

1. Clone the `ethereum-lite-explorer` repository:

Expand All @@ -66,7 +77,7 @@ To run the Lite Explorer using the Docker image:

1. Update the `config.dev.json` file:

* Set `APP_NODE_URL` to the RPC HTTP URL of your node (`http://localhost:8545` in this example)
* Set `APP_NODE_URL` to the JSON-RPC HTTP URL of your node (`http://localhost:8545` in this example)

* Remove other environment variables.

Expand All @@ -87,7 +98,7 @@ To run the Lite Explorer using the Docker image:
npm run start
```

1. A browser windows should open displaying the Ethereum Lite Explorer (http://localhost:3000/)
1. A browser window displays the Ethereum Lite Explorer (http://localhost:3000/).

## Lite Block Explorer Documentation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
description: Lite Network Health Monitor
description: Alethio EthStats Lite Network Monitor
<!--- END of page meta data -->

# Lite Network Health Monitor
# Alethio EthStats Lite Network 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.
Use the [Alethio EthStats Lite Network Monitor](https://github.com/Alethio?utf8=%E2%9C%93&q=ethstats&type=&language=javascript)
to have a live view of private network health by displaying real time and historical statistics
about the network and nodes.

The lite version supports in-memory persistence or using Redis to persist a fixed number of blocks (by default,
3000).
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](https://net.ethstats.io).
You can also use a full online version of EthStats Network Monitor for the [Ethereum MainNet](https://ethstats.io).

!!! note
The EthStats Lite Block Explorer is an [Alethio product](https://aleth.io/).

Static local ports 80 and 3000 are used in the example of [running the Lite Network Health Monitor
for a Pantheon Node](#running-lite-network-health-monitor-for-a-pantheon-node).
The Alethio EthStats Lite Network Monitor is an [Alethio product](https://company.aleth.io/developers).

!!! tip
Static local ports 80 and 3000 are used in the example [running the Lite Network Monitor
for a Pantheon Node](#running-lite-network-monitor-for-a-pantheon-node).

## Statistics

Statistics displayed by the Network Health Monitor include:
Statistics displayed by the Network Monitor include:

* Nodes in the network. Metrics for nodes include:
- Information about the last received block such as block number,
Expand All @@ -34,7 +36,7 @@ Block Propagation Histogram, and Top Miners

## Components

The Network Health Monitor consists of:
The Network Monitor consists of:

* [Server](https://github.com/Alethio/ethstats-network-server). Consumes node data received from the
client.
Expand All @@ -49,16 +51,19 @@ The client extracts data from the node and sends it to the server
[Docker](https://docs.docker.com/install/)

!!! 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](https://github.com/Alethio/ethstats-cli),
The Network Monitor has a number of dependencies. Using Docker is the easiest way to
use the Network Monitor with Pantheon.

The [EthStats CLI](https://github.com/Alethio/ethstats-cli),
[EthStats Network Server](https://github.com/Alethio/ethstats-network-server), and [EthStats Network
Dashboard](https://github.com/Alethio/ethstats-network-dashboard) documentation describes how to install
the Network Heath Explorer tools.
Dashboard](https://github.com/Alethio/ethstats-network-dashboard) documentation describes how to
install the Network Monitor tools.

## Running Lite Network Health Monitor for a Pantheon Node
## Running Lite Network 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](#3-client) must be started for each node.
!!! important
This example describes how to run the Lite Network Monitor for a single Pantheon node. To run the
Lite Network Monitor for a network of nodes, a [client](#3-client) must be started for each node.

### 1. Server

Expand All @@ -70,20 +75,29 @@ Start the server using in-memory persistence:
git clone https://github.com/Alethio/ethstats-network-server.git
```

2. Change into the `/ethstats-network-server/docker/lite-mode/memory-persistence` directory:
1. Change into the `/ethstats-network-server/docker/lite-mode/memory-persistence` directory:

```bash
cd ethstats-network-server/docker/lite-mode/memory-persistence
```

3. Use the provided `docker-compose` file to start the server:
1. Update the `docker-compose.yml` file to your Pantheon [network ID](../Configuring-Pantheon/NetworkID-And-ChainID.md):

```yaml
- NETWORK_ID=2018
- NETWORK_NAME=mynetwork
```

In this example we are using the `dev` Pantheon network with a network ID of `2018`.

1. Start the server using Docker compose:

```bash
docker-compose up -d
```

!!! tip
A `docker-compose` file is also provided in the `ethstats-network-server/docker/lite-mode/redis-persistence`
A `docker-compose` file is 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
Expand All @@ -101,7 +115,7 @@ Where `<pantheondata-path>` is the volume to which the node data is saved.
Start the client for the Pantheon node:

```bash
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
docker run -d --rm --name ethstats-client --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:
Expand All @@ -113,11 +127,29 @@ Registering the node is only required the first time the client is started for t

### 4. Dashboard

To display the Network Health Monitor dashboard, open [`localhost`](http://localhost) in your browser.
To display the Network Monitor dashboard, open [http://localhost](http://localhost) in your browser.

![Alethio EthStats Light Network Monitor Dashboard](ethstats.png)

!!! note "Default HTTP port"
We are using the default HTTP port (80) to run the Lite Network Monitor. The [Lite Block Explorer](Lite-Block-Explorer.md)
example uses port 8080. You can then run both at the same time.

To change the port, update the `docker-compose.yml` file:
```yaml
ports:
- 127.0.0.1:80:80
```

Update the first 80 to the required port:
```yaml
ports:
- 127.0.0.1:8081:80
```

### Stopping and Cleaning Up Resources

When you've finished running the Network Health Monitor:
When you've finished running the Network Monitor:
1. Stop Pantheon using ++ctrl+c++.
Expand All @@ -126,15 +158,12 @@ When you've finished running the Network Health Monitor:
```bash
docker-compose down -v
```
1. Obtain client container ID:
```bash
docker ps
```
1. Stop the client and remove container:
1. Stop the client:
```bash
docker rm -f <id>
```
docker stop ethstats-client
```
!!! tip
The client container is automatically removed because we used the `--rm` option.
17 changes: 17 additions & 0 deletions docs/Alethio/Overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
description: Alethio Overview
<!--- END of page meta data -->

# Alethio

Alethio offers a set of tools including the [Block Explorer](https://aleth.io/) and
[Network Monitor](https://ethstats.io/). The Alethio tools are developed by [Alethio](https://company.aleth.io/).

The Block Explorer and Network Monitor provide a comprehensive view into the activity in a
public or private Enterprise Ethereum network. The statistics are at the network level
and the block, transaction, and account level.

To use the Block Explorer and Network Monitor for testing and private networks, run the the [Lite Block
Explorer](Lite-Block-Explorer.md) and [Lite Network Monitor](Lite-Network-Monitor.md).

Contact [Alethio](https://company.aleth.io/) at [[email protected]](mailto:[email protected]) for
details about the full versions and enterprise solutions.
Binary file added docs/Alethio/ethstats.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Alethio/explorer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 0 additions & 16 deletions docs/EthStats/Overview.md

This file was deleted.

8 changes: 4 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,10 @@ nav:
- Mining: Using-Pantheon/Mining.md
- Monitoring Pantheon: Using-Pantheon/Monitoring.md
- Monitoring Pantheon:
- EthStats:
- Overview: EthStats/Overview.md
- Lite Block Explorer: EthStats/Lite-Block-Explorer.md
- Lite Network Health Monitor: EthStats/Lite-Network-Health-Monitor.md
- Alethio:
- Overview: Alethio/Overview.md
- Ethereum Lite Explorer: Alethio/Lite-Block-Explorer.md
- EthStats Lite Network Monitor: Alethio/Lite-Network-Monitor.md
- Troubleshooting:
- Troubleshooting: Troubleshooting/Troubleshooting.md
- Reference:
Expand Down

0 comments on commit 5e27190

Please sign in to comment.