https://github.com/smartcontractkit/blockchain-rpc-exporter
Prometheus exporter for EVM compatible RPC endpoints.
https://github.com/smartcontractkit/blockchain-rpc-exporter
blockchain prometheus python rpc
Last synced: 19 days ago
JSON representation
Prometheus exporter for EVM compatible RPC endpoints.
- Host: GitHub
- URL: https://github.com/smartcontractkit/blockchain-rpc-exporter
- Owner: smartcontractkit
- License: mit
- Created: 2022-04-27T06:16:41.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-21T15:26:19.000Z (4 months ago)
- Last Synced: 2025-04-19T08:10:42.268Z (about 1 month ago)
- Topics: blockchain, prometheus, python, rpc
- Language: Python
- Homepage:
- Size: 163 KB
- Stars: 23
- Watchers: 15
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Blockchain RPC Exporter
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.
## Metrics
Exporter currently supports all EVM-compatible chains. In addition, there is limited support for the following chains:
- Cardano (wss)
- Conflux (wss)
- Solana (https & wss)
- Bitcoin (https)
- Dogecoin (https)
- Filecoin (https)
- Starknet (https)
## Available Metrics
# Disclaimer
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.
## Development
You should install [pre-commit](https://pre-commit.com/) so that automated linting and formatting checks are performed before each commit.
Run:
```bash
pip install pre-commit
pre-commit install
```
### Running locally
1. Make sure you have python3 installed (>3.11)
2. Set up your python environment
```bash
pip3 install virtualenv
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -r requirements-dev.txt
```
1. Generate valid exporter config and validation file. For example see [config example](config/exporter_example/config.yml) and [validation example](config/exporter_example/validation.yml).
2. Export paths of generated configuration files relative to `src/exporter.py`:
```bash
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
```
3. Finally you can run the exporter
```bash
python exporter.py
```
### Run with docker-compose
1. Generate valid exporter config and validation file. For example see [config example](config/exporter_example/config.yml) and [validation example](config/exporter_example/validation.yml).
2. Export paths of generated configuration files relative to `docker-compose.yml`:
```bash
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
```
3. Execute
```bash
docker-compose build
docker-compose up
curl localhost:8000/metrics # Exporter
curl localhost:3000 # Grafana
curl localhost:9090 # Prometheus
```
### Testing
Testing is performed using [pytest](https://docs.pytest.org/) run by [coverage.py](https://coverage.readthedocs.io/) to generate test coverage reporting.
[pylint](https://pylint.readthedocs.io/) is used to lint the pyhton code.
These dependencies can be found in the [requirements-dev.txt](requirements-dev.txt) file. Unit testing and linting is performed on every commit push to the repository. 90% test coverage and no linter errors/warnings are a requirement for the tests to pass.
#### Testing Locally (venv)
Tests can be run locally in the virtual environment.
1. Run the unit tests with coverage.py from within the `src` directory.
```bash
coverage run --branch -m pytest
```
2. Generate the coverage report. To view the report open the generated `index.html` file in a browser.
```bash
coverage html
```
3. Run the linter to find any errors/warnings.
```bash
pylint src/*py
```
#### Testing Locally (docker)
The tests and linter can be run using docker by building the `test` docker stage.
1. Build the `test` stage in the `Dockerfile`.
```bash
docker build --target test .
```