This repository is forked off of [anclrii/Storj-Exporter]((https://github.com/anclrii/Storj-Exporter), which unfortunately has gone quiet. This repository was created to fix bugs and add additional features. All original work is credited to anclrii (Thank you!).
Storj exporter for Prometheus written in python. It pulls information from storj node api for node, satellite and payout metrics.
Also check out Storj-Exporter-dashboard for Grafana to visualise metrics for multiple storj nodes.
- Exporter can be installed as a docker container, a systemd service or a standalone script
- Make sure you have
-p 127.0.0.1:14002:14002in storagenode container docker run command to allow local connections to storj node api storagenodeis the default value forSTORJ_HOST_ADDRESSenvironment variable that sets the address of the storage node container used to link exporter to the api- If you storagenode container has a different name it needs to be set with both
--link=<storagenode-name-here>and-e STORJ_HOST_ADDRESS=<storagenode-name-here>on the docker command
Run latest build from DockerHub (easiest option, assuming storagenode is the name of the storagenode container)
docker run -d --link=storagenode --name=storj-exporter -p 9651:9651 -e STORJ_HOST_ADDRESS=storagenode thechristech/storj-exporter:latest
Docker image supports linux/386,linux/amd64,linux/arm64,linux/arm/v6,linux/arm/v7,linux/arm/v8 platforms.
In this example storagenode1, storagenode2, storagenode3 are the names of storagenode containers runnin on the same host. The docker commands would be:
docker run -d --link=storagenode1 --name=storj-exporter1 -p 9651:9651 -e STORJ_HOST_ADDRESS=storagenode1 thechristech/storj-exporter:latest
docker run -d --link=storagenode2 --name=storj-exporter2 -p 9652:9651 -e STORJ_HOST_ADDRESS=storagenode2 thechristech/storj-exporter:latest
docker run -d --link=storagenode3 --name=storj-exporter3 -p 9653:9651 -e STORJ_HOST_ADDRESS=storagenode3 thechristech/storj-exporter:latest
useradd --no-create-home --shell /bin/false storj_exporter
Dependencies: python3 python3-pip
pip3 install --no-cache-dir -r /requirements.txt
mv storj_exporter/ /opt/
chown storj_exporter:storj_exporter /opt/storj_exporter/
cp storj_exporter.service /etc/systemd/system/
systemctl daemon-reload
systemctl restart storj_exporter
systemctl enable storj_exporter
python3 /path/to/storj_exporter/
You can find some installation notes and guides in dashboard README, also see quick-start guide to set up the whole stack using docker-compose.
Following environment variables are available:
| Variable name | Description | Docker default | Standalone default |
|---|---|---|---|
| STORJ_HOST_ADDRESS | Address of the storage node | storagenode | 127.0.0.1 |
| STORJ_API_PORT | Storage node api port | 14002 | 14002 |
| STORJ_API_TIMEOUT | Storage node api timeout | 90 | 90 |
| STORJ_EXPORTER_ADDRESS | Address to expose metrics on - useful for reverse proxy | 127.0.0.1 | 127.0.0.1 |
| STORJ_EXPORTER_PORT | A port that exporter opens to expose metrics on | 9651 | 9651 |
| STORJ_COLLECTORS | A list of collectors | payout sat | payout sat |
By default exporter collects node, payout and satellite data from api. Satellite data is particularly expensive on cpu resources and disabling it might be useful on smaller systems
For users that use Netdata: Netdata by default has a prometheus plugin enabled, which pulls all the data from the exporter every 5 seconds. This results in high CPU spikes on the storagenode. It is therefore advisable to disable the prometheus plugin of Netdata:
cd /etc/netdata
sudo ./edit-config go.d.conf
Then under "modules:" uncomment "prometheus" and change its value to "no":
modules:
# activemq: yes
[...]
# powerdns_recursor: yes
prometheus: no
After that restart the netdata service:
sudo systemctl restart netdata