retiready-exporter

I wish I had not needed to create this repo but Retiready has no graphs which allowed me track how my pension was doing.

This repo allows people to run a simple webapp which publishes metrics which can be scraped by Prometheus and then displayed through Grafana.

Prerequisites

1. Login credentials for https://retiready.co.uk/public/sign-in.html
2. An API key for https://2captcha.com. I wish this was not needed but I am not aware of any developer API key access for Retiready.
3. Docker
4. An instance of Grafana & Prometheus. Here are some options for running your own:
   • On a Raspberry Pi
   • AWS Prometheus. Be careful to stay within the free tier limits.
   • Grafana Cloud. Only has 14 days free retention.

How to Run

1. Create an env file for credentials cp .env.example .env
2. Add Retiready + 2captcha credentials to .env
3. Run with Docker:

docker run -p 9292:9292 --restart always -d --env-file .env --name retiready-exporter retiready-exporter

Running locally

The docker-compose.yaml in this repo will run an instance of Grafana, Prometheus and the retiready-exporter.

After setting up your .env you only need to run the following:

docker-compose run -P grafana

You will then be able to see your metrics at http://localhost:3000/dashboards