pvpc-exporter

Bash script that uploads the PVPC €/MWh data from REData API to influxdb on a daily basis

Dependencies

• bash
• coreutils (date)
• curl
• gzip
• influxdb v2+
• jq
• systemd
• Optional:
  • make - for automatic installation support
  • docker

Relevant documentation

• REData API
• InfluxDB API
• Systemd Timers
• reddec/compose-scheduler

Installation

With Docker

docker-compose

1. Configure pvpc_exporter.conf (see the configuration section below).

2. Run it.

   docker compose up --detach

docker build & run

1. Build the docker image.

   docker build . --tag pvpc-exporter

2. Configure pvpc_exporter.conf (see the configuration section below).

3. Run it.

   docker run --rm --init --tty --interactive --volume $(pwd):/app localhost/pvpc-exporter

With the Makefile

For convenience, you can install this exporter with the following command or follow the manual process described in the next paragraph.

make install
$EDITOR $HOME/.config/pvpc_exporter.conf

Manually

1. Copy pvpc_exporter.sh to $HOME/.local/bin/ and make it executable.

2. Copy pvpc_exporter.conf to $HOME/.config/, configure it (see the configuration section below) and make it read only.

3. Copy the systemd unit and timer to $HOME/.config/systemd/user/:

cp pvpc-exporter.* $HOME/.config/systemd/user/

5. and run the following command to activate the timer:

systemctl --user enable --now pvpc-exporter.timer

It's possible to trigger the execution by running manually:

systemctl --user start pvpc-exporter.service

Config file

The config file has a few options:

INFLUXDB_HOST='influxdb.example.com'
INFLUXDB_API_TOKEN='ZXhhbXBsZXRva2VuZXhhcXdzZGFzZGptcW9kcXdvZGptcXdvZHF3b2RqbXF3ZHFhc2RhCg=='
ORG='home'
BUCKET='pvpc'

• INFLUXDB_HOST should be the FQDN of the influxdb server.
• ORG should be the name of the influxdb organization that contains the pvpc price data bucket defined below.
• BUCKET should be the name of the influxdb bucket that will hold the pvpc price data.
• INFLUXDB_API_TOKEN should be the influxdb API token value.
  • This token should have write access to the BUCKET defined above.

Exporting prices for dates in the past

If the script is passed a number as the first argument, it will query the REData API for an interval in the past instead of the default date of "today".

This argument should correspond to the number of days in the past relative to the current date. Take into account that the REData API doesn't allow queries for dates prior to 2014-01-01.

Example:

~/.local/bin/pvpc_exporter.sh 30

A simple bash loop can be used to query the API with an interval between "today" and 15 days ago:

for i in {0..15}; do echo "Exporting data from $(date -I -d "$i days ago")" && ~/.local/bin/pvpc_exporter.sh "$i"; done

Troubleshooting

Run the script manually with bash set to trace:

bash -x $HOME/.local/bin/pvpc_exporter.sh

Check the systemd service logs and timer info with:

journalctl --user --unit pvpc-exporter.service
systemctl --user list-timers

Exported metrics

• price: The pvpc price in €/MWh

Exported metrics example

pvpc_price price=63.54 1672610400

Example grafana dashboard

In pvpc-dashboard.json there is an example of the kind of dashboard that can be built with pvpc-exporter data:

Import it by doing the following:

1. Create a dashboard
2. Click the dashboard's settings button on the top right.
3. Go to JSON Model and then paste there the content of the pvpc-dashboard.json file.

Uninstallation

With the Makefile

For convenience, you can uninstall this exporter with the following command or follow the process described in the next paragraph.

make uninstall

Manually

Run the following command to deactivate the timer:

systemctl --user disable --now pvpc-exporter.timer

Delete the following files:

~/.local/bin/pvpc_exporter.sh
~/.config/pvpc_exporter.conf
~/.config/systemd/user/pvpc-exporter.timer
~/.config/systemd/user/pvpc-exporter.service

Credits

• reddec/compose-scheduler

This project takes inspiration from the following:

• rare-magma/pbs-exporter
• mad-ady/prometheus-borg-exporter
• OVYA/prometheus-borg-exporter