Innitial commit

Author: namikmesic

.github/dependabot.yml

@@ -0,0 +1,21 @@
+# Basic dependabot.yml file with
+# minimum configuration for two package managers
+
+version: 2
+updates:
+  # Enable version updates for pip (Python)
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    # Only allow updates to the lockfile for pip and
+    # ignore any version updates that affect the manifest
+    versioning-strategy: lockfile-only
+
+  # Enable version updates for Docker
+  - package-ecosystem: "docker"
+    # Look for a `Dockerfile` in the `root` directory
+    directory: "/"
+    # Check for updates once a week
+    schedule:
+      interval: "weekly"

.github/workflows/publish.yaml

@@ -0,0 +1,50 @@
+name: publish
+on:
+  push:
+    tags:
+       - 'v*'
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create GitHub release
+        uses: Roang-zero1/github-create-release-action@master
+        with:
+          version_regex: ^v[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -0,0 +1,16 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+local*
+
+# Dependency directories (remove the comment below to include it)
+# vendor/

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+    -   id: check-ast

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v1.0.0
+
+Innitial release

Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3.9.10 AS build
+COPY requirements.txt .
+RUN pip install -r ./requirements.txt
+
+FROM gcr.io/distroless/python3:nonroot
+
+COPY --from=build /usr/local/lib/python3.9/site-packages/ \
+ /usr/lib/python3.9/.
+
+ENV LC_ALL C.UTF-8
+WORKDIR /usr/src/app
+COPY src/*.py .
+
+# https://github.com/GoogleContainerTools/distroless/blob/main/experimental/python3/BUILD#L77
+USER nonroot
+CMD ["exporter.py"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Chainlink Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,52 @@
+# EVM RPC Websocket Exporter
+Simple exporter used to scrape different metrics from EVM compatible websocket RPCs.
+
+## Metrics
+For list of metrics and explanations please check [collect method](src/exporter.py#L42-L79) in exporter source-code.
+For available labels please see [metric_labels](src/exporter.py#L37-L40) list in exporter source-code.
+
+# Disclaimer
+Please note that this tool is in early development stage, and as such should not be used to influence business crictical decisions.
+The project in it's 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.
+This project was inspired by [blackbox-websocket-exporter](https://github.com/smohsensh/blackbox-websocket-exporter)
+
+## Development
+It is recommended that you 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.9.10)
+1. Set-up your python environment
+```bash
+pip3 install virtualenv
+virtualenv venv
+source venv/bin/activate
+pip install -r requirements.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).
+1. 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
+```
+1. 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).
+1. 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
+```
+1. Execute
+```bash
+docker-compose build
+docker-compose-up
+curl localhost:8000/metrics # Exporter
+curl localhost:3000         # Grafana
+curl localhost:9090         # Prometheus
+```

config/exporter_example/config.yml

@@ -0,0 +1,22 @@
+blockchain: "Example Chain"             # Name of blockchain i.e "Ethereum"
+chain_id: 1                             # Chain ID, can be found at https://chainlist.org/
+network_name: "Example"                 # Name of the blokckchain network i.e Rinkeby
+network_type: "Example"                 # Type of the blockchain network, only two values allowed (Mainnet|Testnet)
+connection_timeout_seconds : 5          # Amount in seconds before websocket client drops a connection that has not finished connection handshake and labels the RPC node as unhealhty.
+slo:                                    # Metrics below 'slo' will only affect `ws_rpc_sla_compliant` metric. In case any of the threshold are breached, this metric will be set to 0 for that perticular RPC endpoint.
+  max_pool_deviation_block_count: 10    # Threshold for max allowed deviation in block height, compared to the node with the highest block count in the pool.
+  max_response_latency_miliseconds: 500 # Threshold for max allowed latency.
+validation:                             # Validation section makes sure that "endpoints" can only be added with specific providers / chain. This is done to make sure labels in metrics are consistent.
+  providers:
+    - Provider1
+    - Provider2
+    - Provider3
+  blockchains:
+    - "Example Chain"
+endpoints:                              # List of endpoints with their metadata.
+  - url: wss://example-rpc-1.com/ws     # RPC Endpoint (Must start with wss://)
+    provider: Provider1                 # Provider (Must be present in allowed providers list. Please check src/settings.py line 24) The purpose is to make sure we do not have same providers spelled differently
+  - url: wss://example-rpc-2.com/ws
+    provider: Provider2
+  - url: wss://example-rpc-3.com/ws
+    provider: Provider3

config/exporter_example/validation.yml

@@ -0,0 +1,9 @@
+# To enforce uniform labels in your metrics, we need to limit what providers and blockchains users can specify in their exporter configuration.
+allowed_providers: # When adding endpoints, these are the only values you will be able to add as providers. Otherwise program will exit with error.
+  - Provider1
+  - Provider2
+  - Provider3
+allowed_blockchains: # When setting Blockchain key in your config file, it will be validate against this list.`
+  - Example Chain
+  - Example Chain2
+  - Example Chain3