promobee

A Prometheus exporter for ecobee data written in the Go programming language.

promobee exports a list of known thermostat identifiers at /thermostats. The list of identifiers can be used for target discovery purposes.

Metrics for a given thermostat are retrieved from /thermostat?id=$THERMOSTAT_ID.

Usage

You will need an API key. Read the Reference API App documentation from Ecobee to understand how to get one of these.

Creating a Token Store

Once you have an API key, promobee requires you to add the application to your account, and that you have configured a Token Store. Use the register subcommand to create one:

$ promobee \
    --api_key $ECOBEE_API_KEY \
    --store /path/to/store \
  register
Register with this PIN: abc9
Press any key to continue when done.

Once you have a code, go to the Ecobee website, log in, navigate to My Apps and click Add Application. When prompted, enter the code from above and click Validate, and then click Add Application when prompted.

Once this is done, press any key in the terminal to finish registration. You will see the following output:

Created persistent store at /path/to/store

If anything happens to the token store, you will need to re-add the application to your Ecobee account!

Runing the `promobee` exporter

Now, you can run promobee:

$ promobee \
    --api_key $ECOBEE_API_KEY \
    --store /path/to/store
2019/07/10 12:04:10 Starting on :8080

Running from Docker

You can either build the container yourself, or use mine. I recommend creating a named Docker volume.

$ docker volume create promobee-datastore
$ docker run -d \
    --name promobee \
    -p 8080:8080 \
    --mount source=promobee-datastore,target=/var/run/promobee \
    cfunkhouser/promobee:latest \
    -- $ECOBEE_API_KEY

This will fail, because the data store doesn't exist in the container. That's okay. Use docker cp to get the datastore you created above into the container.

$ docker cp /path/to/store promobee:/var/run/promobee/promobee.store

Then docker start your container. It should now work fine.

Monitoring

Once promobee is configured and running, you can point Prometheus at it with a configuration like:

scrape_configs:
  - job_name: "promobee"
    metrics_path: /thermostat
    # The Ecobee API recommends not polling their API more than once every 3
    # minutes, which Promobee respects. Poll twice that often to help reduce
    # chances of missing an interesting point. Polling the metric endpoint does
    # not cause an API request.
    scrape_interval: 90s
    static_configs:
        - targets:
            # These are the themostat IDs as exported by the /thermostats
            # endpoint.
            - 123456789098
            - 123456789099
    relabel_configs:
            - source_labels: [__address__]
              target_label: __param_id
            - source_labels: [__param_id]
              target_label: thermostat
            - target_label: __address__
              # Replace this host:port with the location of promobee.
              replacement: 10.42.18.11:8080