hue_exporter/README.md
2020-12-22 18:30:48 +01:00

48 lines
1.6 KiB
Markdown

# Philips Hue statistics exporter for prometheus
This exporter exports some variables from Philips Hue Bridge
(https://www.philips-hue.com)
to prometheus.
## Building
go get github.com/aexel90/hue_exporter/
cd $GOPATH/src/github.com/aexel90/hue_exporter
go install
## Running
How to create a user for your bridge is described here: https://developers.meethue.com/develop/get-started-2/
Usage:
$GOPATH/bin/hue_exporter -h
Usage of ./hue_exporter:
-hue-url string
The URL of the bridge
-listen-address string
The address to listen on for HTTP requests. (default "127.0.0.1:9773")
-test
test configured metrics
-username string
The username token having bridge access
## Example execution
### Running within prometheus:
$GOPATH/bin/hue_exporter -hue_url 192.168.xxx.xxx -username ZlEH24zabK2jTpJ...
# HELP hue_light_status status of lights registered at hue bridge
# TYPE hue_light_status gauge
hue_light_status{manufacturer_name="...",model_id="...",name="...",state_alert="...",state_bri="...",state_ct="...",state_on="...",state_reachable="...",state_saturation="...",sw_version="...",type="...",unique_id="..."} 1
hue_light_status{manufacturer_name="...",model_id="...",name="...",state_alert="...",state_bri="...",state_ct="...",state_on="...",state_reachable="...",state_saturation="...",sw_version="...",type="...",unique_id="..."} 0
...
### Test exporter:
$GOPATH/bin/hue_exporter -hue_url 192.168.xxx.xxx -username ZlEH24zabK2jTpJ... -test
## Grafana Dashboard