A custom Prometheus exporter for exporting metrics from korto.ee residence management system.
It allows an apartment resident to export their apartment utility meter readings and invoice data as Prometheus metrics.
This is designed to be run in a Docker container. Deploy it to your Docker platform of choice.
The exporter will listen on port 8080. You need to specify required environment variables (see below).
$ docker run -p 8080:8080 -e KORTO_AUTH_TOKEN=xxxxx -e KORTO_APARTMENT_ID=xxxx anroots/korto-exporterConfigure a new Prometheus target to scrape the exposed endpoint. As (regardless of what one might expect) the Korto system is not really real-time automagical, it doesn't make sense to configure scraping frequency of more than once or twice a day (or week).
scrape_configs:
- job_name: 'korto'
scrape_interval: 24h
static_configs:
- targets:
- korto-exporter:8080
The following metrics will be saved:
# HELP korto_meter_reading Reading value of a single utility meter
# TYPE korto_meter_reading gauge
korto_meter_reading{apartment_id="123456",meter_id="123456",reading_date="2019-12-31",reading_origin="MANUAL",type="Cold water",unit="m³"} 3.0
# HELP korto_meter_consumption Consumption value of a single utility meter
# TYPE korto_meter_consumption gauge
korto_meter_consumption{apartment_id="123456",meter_id="123456",type="Cold water",unit="m³"} 1.4
# HELP korto_meter_reading Reading value of a single utility meter
# TYPE korto_meter_reading gauge
korto_meter_reading{apartment_id="123456",meter_id="222222",reading_date="2019-12-31",reading_origin="MANUAL",type="Hot water",unit="m³"} 1.0
# HELP korto_meter_consumption Consumption value of a single utility meter
# TYPE korto_meter_consumption gauge
korto_meter_consumption{apartment_id="123456",meter_id="222222",type="Hot water",unit="m³"} 0.6
# HELP korto_meter_reading Reading value of a single utility meter
# TYPE korto_meter_reading gauge
korto_meter_reading{apartment_id="123456",meter_id="333333",reading_date="2019-12-31",reading_origin="MANUAL",type="Electricity (day)",unit="kWh"} 44.0
# HELP korto_meter_consumption Consumption value of a single utility meter
# TYPE korto_meter_consumption gauge
korto_meter_consumption{apartment_id="123456",meter_id="333333",type="Electricity (day)",unit="kWh"} 21.0
# HELP korto_meter_reading Reading value of a single utility meter
# TYPE korto_meter_reading gauge
korto_meter_reading{apartment_id="123456",meter_id="444444",reading_date="2019-12-31",reading_origin="MANUAL",type="Electricity (night)",unit="kWh"} 50.0
# HELP korto_meter_consumption Consumption value of a single utility meter
# TYPE korto_meter_consumption gauge
korto_meter_consumption{apartment_id="123456",meter_id="444444",type="Electricity (night)",unit="kWh"} 43.04
# HELP korto_apartment_balance Balance of the apartment in EUR
# TYPE korto_apartment_balance gauge
korto_apartment_balance{apartment_id="123456",date="2019-12-16"} 160.97
# HELP korto_apartment_last_payment Last payment value in EUR
# TYPE korto_apartment_last_payment gauge
korto_apartment_last_payment{apartment_id="123456",date="1970-01-01"} 0.0
Available meters and their actual update frequency depend on your apartment. Note that remote-readable meters apparently don't meant their refresh rate is >1 per month. 😠
| Variable name | Description | Default value | Required |
|---|---|---|---|
| KORTO_AUTH_TOKEN | JWT token to access the Korto API. Log in via the korto.ee web interface, open browser dev tools -> Application -> Cookies; value of auth_token cookie |
None |
Yes |
| KORTO_APARTMENT_ID | Your apartment ID in the Korto system. You can only view apartments belonging to you; this exporter currently only supports a single apartment ID at a time. Get it from browser dev tools -> Application -> Local Storage -> currentObjectId value |
None |
Yes |
| KORTO_API_URL | HTTPS URL to the korto.ee API endpoint | https://pro.korto.ee/api/ |
No |
| LOG_LEVEL | Exporter log level (to stdout) | INFO |
No |
Use the included docker-compose.yml file for development..
$ export KORTO_APARTMENT_ID=xxxxx
$ export KORTO_AUTH_TOKEN=xxxxxx
$ docker-compose up...or install dependencies to Python venv, and debug locally:
$ pip install -r requirements.txt
$ KORTO_APARTMENT_ID=xxxx KORTO_AUTH_TOKEN=xxxx python src/collector.pyKorto auth token is a JWT without expire time (hmmm, interesting... 😱). The auth_token cookie has a long expiry time
of about a year.