This is an script that runs periodically to multiple data from PLS and stores it into an Influx Database
-
Assuming you have a properly running InfluxDB instance, create a bucket(
pls) and a token with write access. -
git clone this repo.
-
create a
docker-compose.ymlbased on thedocker-compose.sample.yml. Customize it changing the following variables:
INFLUX_HOST_PORT- The host where your InfluxDB is runningINFLUX_ORG- The organization where you created the bucket and tokenINFLUX_BUCKET- The bucket where you want to store the data, default isplsINFLUX_KEY- The token with write access to the bucketPLS_PRICE_URI- URL to get price data, Default is CoinMarketCap API.PLS_PRICE_API_KEY- ApiKey obtained from CoinMarketCap (use free version)PLS_LAUNCH_URI- URL where PLS staking, validator and APR resides. Default is PLS launchpad site.CRON_SCHEDULE- Cron configuration, uses std cron format. Default is every hour. (Please don't abuse the API and sites)CRON_PRICE- Cron configuration, uses std cron format. Default is every 5 minutes. (Please don't abuse the API and sites)
-
Run with
docker-compose.yml build && docker-compose.yml up -d. Please be patient, it takes a while, because it has to install some packages and, since it depends on Selenium, it has to download the browser and the driver. -
You can see the logs with
docker-compose.yml logs -f
There is a dashboard called pls_network_dashboard.json so you can import into your Grafana instance. It requires the following:
- An InfluxDB datasource with a bucket called
pls(the same you use for data store with the script, but use a token with read access only.) - A Prometheus datasource that has your node's metrics.
You can do it manually (taking container down, pull and rebuild), but, for your convenience, there is a script that does it for you. Just run ./restart_plsgrabber.sh and it will do it for you. Just remember to give it execution permissions with chmod +x restart_plsgrabber.sh.
It's mostly self explanatory. The idea is this container will run every hour, grab the data from the API and the website and store it into InfluxDB. Then you can use Grafana to visualize it.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.