cerc-io/eth-state-metrics
16
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 3 Wiki Activity

updated readme
Some checks failed
Docker Compose Build / Run docker build (push) Failing after 30s
Details

Browse Source
This commit is contained in:
Jonathan Face 2024-02-28 12:07:11 -06:00
parent e043ed10f8
commit bf5b04d706
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,14 +1,16 @@
# Prometheus Metrics for Geth-Statediff
Server exposes `/metrics` endpoint with Prometheus metrics:
* `eth_state_metrics_etherscan` - latest block from Etherscan
* `eth_state_metrics_statediff_db` - latest block from Statediff Database
- `eth_state_metrics_etherscan` - latest block from Etherscan
- `eth_state_metrics_statediff_db` - latest block from Statediff Database
StateDiff DB is not strictly required to be available if all you care about is etherscanning
## How to run
### Locally
```
# copy config template
cp .env.example .env
@ -16,11 +18,12 @@ cp .env.example .env
# edit it and set Etherscan API Key and Database Credentials
# run server
node src/index.js
node src/index.js
```
And then open in browser `http://172.17.0.2:3000/metrics`
### Docker
### Docker
```
docker run \
@ -29,4 +32,4 @@ docker run \
-e ETHERSCAN_API_KEY=*** \
-e STATEDIFF_PG_HOST=*** \
-d vulcanize/eth-state-metrics
```
```