Polkadot Observer

This project aims to provide a robust solution for observing the Polkadot network and detecting when a specific account fund goes under a user-defined threshold. The system is designed to be deployed on a Kubernetes platform and offers features like Prometheus queryable metrics, making it suitable for monitoring and alerting purposes.

Architecture Overview

EXPLANATION VIDEO

You can find a link to the video on my youtube channel, in the video you will find about this repo:

How to run locally.
Repo structure.
Showcase Features.

How to run

Docker-compose

OPTIONAL: Open the file ./dev/docker-compose.yaml, you need to change 2 environment variables
- Looking at service backend_monitor, you can change the env 'CHAIN_URI' to one of the node endpoints offered at this link to choose at which network you wanna listen to.
- If you want to send the alert to Discord, it needs to know the webhook url, so go to service alert_manager, and you will find:
```
        receivers:
            - name: discord
            discord_configs:
                - webhook_url: 'TO-CHANGE'
```
From the terminal, go in the folder ./dev and run:

docker-compose up --build
Wait until all the services are up and running and you can connect to the system: http://localhost:3000/, from there you can insert the addresses to monitor and the thresholds

NOTE: If you do not want to add the list manually from the frontend, you can do so through .csv file that is pre-loaded once the service backendMonitor is started, go in the folder backendMonitor and edit the file 'addresses.csv', with the format 'address,threshold', for instance: 14gAowz3LaAqYkRjqUZkjZUxKFUzLtN2oZJSfr3ziHBRhwgc,2

Run K8S locally

OPTIONAL:
- In the folder ./k8s, in the file monitoring-deployment.yaml at service called alert-manager-container, If you want to send the alert to discord, it needs to know the webhook url (how to set a webhook), so go at service alert_manager, and you will find:
```
            receivers:
              - name: discord
                discord_configs:
                  - webhook_url: 'TO-CHANGE'
```
- In the file backend-monitor-deployment:
```
name: CHAIN_URI
              value: TO-CHANGE
```
  you can change the env 'CHAIN_URI' to one of the node endpoints offered at this link to choose at which network you wanna listen.
  
  If you want to make use of the addresses.csv in backendMonitor, you can change this env with your absolute path to this file:
```
      - name: local-files
          hostPath:
            path: TO_CHANGE
```
After the env are set, you need to install Ingress-Nginx-Controller

Type from terminal:

helm upgrade mongodb-query-exporter --install oci://ghcr.io/raffis/charts/mongodb-query-exporter --set 'mongodb[0]=mongodb://mongodb-cluster-ip-service:27017' --set 'service.enabled=true' --set-file config=./mongoExporter/config.yaml

Type: kubectl apply -f ./k8s
WAIT A MINUTE OR MORE, THE SERVICES NEED TO START (It requires more time if is the first time you have installed Ingress-Nginx-Controller ).
Now if you have docker desktop you can access localhost:80 and see the dashboard otherwise type minikube ip to retrieve the IP and type it in your browser. If doesn't work, try to restart the cluster or docker desktop.

Threshold Format

What format am I expecting from the threshold input?

I am expecting the same format as on the dashboard platform, for instance what you retrieve from the chain as 664707494049 converted to unit in 0.6647 (once the account becomes for instance 660007494049, the threshold wiill be triggered) . So on the frontend or csv I expect you to write: 0.6647 for that.

armando1514 / polkadot-observer Goto Github PK