eth-state-metrics/README.md
Jonathan Face 5464674d9d
Some checks failed
Docker Compose Build / Run docker build (push) Failing after 26s
testing webhook
2024-02-28 12:13:33 -06:00

36 lines
781 B
Markdown

# 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
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
# edit it and set Etherscan API Key and Database Credentials
# run server
node src/index.js
```
And then open in browser `http://172.17.0.2:3000/metrics`
### Docker
```
docker run \
-e SERVER_HOST=0.0.0.0 \
-e ETHERSCAN_API_KEY="https://api.etherscan.io" \
-e ETHERSCAN_API_KEY=*** \
-e STATEDIFF_PG_HOST=*** \
-d vulcanize/eth-state-metrics
```