https://github.com/davidborzek/deconz-exporter

A Prometheus exporter for deCONZ
https://github.com/davidborzek/deconz-exporter

deconz docker hue metrics prometheus prometheus-exporter smarthome zigbee

Last synced: 2 months ago
JSON representation

A Prometheus exporter for deCONZ

• Host: GitHub
• URL: https://github.com/davidborzek/deconz-exporter
• Owner: davidborzek
• License: mit
• Created: 2022-11-13T16:22:50.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-16T17:36:43.000Z (8 months ago)
• Last Synced: 2024-05-16T22:47:02.652Z (8 months ago)
• Topics: deconz, docker, hue, metrics, prometheus, prometheus-exporter, smarthome, zigbee
• Language: Go
• Homepage:
• Size: 74.2 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://github.com/davidborzek/deconz-exporter/actions/workflows/docker.yml/badge.svg)](https://github.com/davidborzek/deconz-exporter/actions/workflows/docker.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/davidborzek/deconz-exporter)](https://goreportcard.com/report/github.com/davidborzek/deconz-exporter)

# deCONZ Prometheus Exporter

This is a Prometheus exporter for deCONZ / Phoscon.

## Installation

### Using Docker

```bash

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. 

```bash

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:

```yaml

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

```