deconz-exporter

deCONZ Prometheus Exporter

This is a Prometheus exporter for deCONZ / Phoscon.

Installation

Using Docker

docker run \
  -e 'DECONZ_URL=http://127.0.0.1' \
  -e 'DECONZ_API_KEY=mykey' \
  -p 8080:8080 \
  ghcr.io/davidborzek/deconz-exporter:latest

Obtaining an deCONZ API Key

You can use the auth command to acquire a new key.

The DECONZ_URL specifies the url of your deCONZ server.

You can optionally provide DECONZ_USERNAME to set a custom key with a minimum length of 10 and a maximum length of 40.

docker run \
  -e 'DECONZ_URL=http://127.0.0.1' \
  ghcr.io/davidborzek/deconz-exporter:latest auth

Prometheus config

Once you have configured deconz-exporter update your prometheus.yml scrape config:

scrape_configs:
  - job_name: 'deconz'
    static_configs:
      - targets: ['localhost:8080']

Exported Metrics

Currently the exporter exports all numeric and boolean states of a sensor into its own gauge:

# HELP deconz_sensor_state Sensor state value
# TYPE deconz_sensor_state gauge
deconz_sensor_state{manufacturername,modelid,name,sensor,state,type}

The gauge has multiple labels to identify the sensor and state.

Additionally a counter of errors during scraping the metrics gets exported:

# HELP deconz_scrape_errors_total Total errors during collecting metrics
# TYPE deconz_scrape_errors_total counter
deconz_scrape_errors_total 0