The exporter is used to scrape metrics from blockchain RPC endpoints. The purpose of this exporter is to perform black-box testing on RPC endpoints.
Exporter currently supports all EVM-compatible chains. In addition, there is limited support for the following chains:
- Cardano
- Conflux
- Solana
Please note that this tool is in the early development stage and should not be used to influence critical business decisions. The project in its current form suits our short-term needs and will receive limited support. We encourage you to fork the project and extend it with additional functionality you might need.
You should install pre-commit so that automated linting and formatting checks are performed before each commit.
Run:
pip install pre-commit
pre-commit install- Make sure you have python3 installed (>3.9.10)
- Set up your python environment
pip3 install virtualenv
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt- Generate valid exporter config and validation file. For example see config example and validation example.
- Export paths of generated configuration files relative to
src/exporter.py:
export VALIDATION_FILE_PATH="validation.yml" # For example if we saved validation config file in src/validation.yml
export CONFIG_FILE_PATH="config.yml" # For example if we saved config file in src/config.yml- Finally you can run the exporter
python exporter.py- Generate valid exporter config and validation file. For example see config example and validation example.
- Export paths of generated configuration files relative to
docker-compose.yml:
export VALIDATION_FILE_PATH="src/validation.yml" # For example if we saved validation config file in src/validation.yml
export CONFIG_FILE_PATH="src/config.yml" # For example if we saved config file in src/config.yml- Execute
docker-compose build
docker-compose-up
curl localhost:8000/metrics # Exporter
curl localhost:3000 # Grafana
curl localhost:9090 # Prometheus