https://github.com/eskoltech/ethstats-server
Ethereum network stats server
https://github.com/eskoltech/ethstats-server
blockchain ethereum ethstats geth parity
Last synced: 3 days ago
JSON representation
Ethereum network stats server
- Host: GitHub
- URL: https://github.com/eskoltech/ethstats-server
- Owner: eskoltech
- License: gpl-3.0
- Created: 2019-02-03T23:07:39.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-17T12:04:44.000Z (about 7 years ago)
- Last Synced: 2025-12-19T02:22:08.456Z (4 months ago)
- Topics: blockchain, ethereum, ethstats, geth, parity
- Language: Go
- Size: 1.15 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ethstats server
[](https://www.gnu.org/licenses/gpl-3.0)
>**Note**: in early development, not production ready!
Websocket server to report Ethereum node stats.
## Build
If you want to build the `ethstats` server by yourself or start hacking on it,
just install this repo using the command:
```bash
$ go get -v github.com/eskoltech/ethstats-server
```
Also, you can use the `make` utility to build an executable. Using `make b` will
compile it, and the resulting binary can be found in the `build/bin/` directory.
## Running
In order to start the `ethstats` server, you need to provide a `secret`. This secret will
be used to authorize nodes to report stats to this server. Note that if the Ethereum node
can't be logged into the server, the server can't receive any notifications from any node.
For example, to start a server with default network options and a weak secret, just execute:
```bash
$ ethstats-server --secret 1234
```
>**Note** that for default, the server is started at `localhost:3000` when is not started using `make start`
You can view the default network options using the `-h` flag, and customize it for
your requirements. Also, you can start the server using the `make start` command, and customize
the `make` flags to adapt it to your needs. You can modify this flags:
| **Variable** | **Description** | **Default** |
|-------------- |----------------- |--------------------- |
| `ADDR` | Server address | `192.168.0.20:3000` |
| `SECRET` | Server secret | `123456789` |
>If you want to update the `ADDR` variable, execute the make task like `make start ADDR=10.0.0.15:3000`
If all is right, you will see some like this:
```
__ .__ __ __
_____/ |_| |__ _______/ |______ _/ |_ ______
_/ __ \ __\ | \ / ___/\ __\__ \\ __\/ ___/
\ ___/| | | Y \\___ \ | | / __ \| | \___ \
\___ >__| |___| /____ > |__| (____ /__| /____ >
\/ \/ \/ \/ \/ v0.1.0
INFO[2019-02-10T17:19:23+01:00] Starting websocket server in 192.168.0.15:3000
INFO[2019-02-10T17:19:23+01:00] Node relay started successfully
INFO[2019-02-10T17:19:23+01:00] Server started successfully
```
Now you can attach nodes to report stats to this server using the address and port where
the server is listening.
>**Docker fans**: you can build and run `ethstats` server using docker. Just execute the task `make docker-start`
and you are ready to go!