xenji / homee_exporter Goto Github PK

View Code? Open in Web Editor NEW

3.0 3.0 2.0 169 KB

An exporter for homee metrics to prometheus

License: MIT License

Kotlin 99.35% Dockerfile 0.65%

homee kotlin prometheus-exporter

homee_exporter's People

Contributors

Stargazers

Watchers

Forkers

stfnhmplr bioharz

homee_exporter's Issues

Enable export of light sensors

Light intensity

Export Homee's own status

As user I want to know in what state(Abwesend/Urlaub/Zuhause...) is

Document the requirements for running the exporter

JRE 1.8
Network connection to either the homee cube (local LAN) or WAN

Reissue access_token after the lifetime has expired

Current lifetime is one year. Although it is rather not to be expected that a homee exporter runs for one year without any update or restart, this is expected behavior and should therefore be possible.

Enable export of binary metrics

Switches
Door Sensors
Flood Sensors
Motion Sensors
Security Sensors

Are the currently used labels helpful?

Currently these labels are used:

private val energyGauge: Gauge = Gauge
    .build("current_energy", "Tracks the current energy level of a meter")
    .labelNames("node_id", "attribute_id", "name", "unit")
    .register()

private val statusGauge = Gauge
    .build("current_state", "Tracks the current state of a switch")
    .labelNames("node_id", "attribute_id", "name")
    .register()

private val temperatureGauge = Gauge
    .build("current_temperature", "Tracks the current state of a thermometer")
    .labelNames("node_id", "attribute_id", "name", "unit")
    .register()

Grouping of Sensors/Actors

As a user I want to be able to group sensors/actors that are exported, e.g. via a homee Group „Exporter“, where only those actors/sensors are exported that are a member of this group.

Compare the approach used by HomeKit-homee by Stefan Himpler.

Reopening of websocket does not work as expected due to websockets being not reusable

Mar 05 15:13:04 srv env[27516]:         at org.java_websocket.client.WebSocketClient.connect(WebSocketClient.java:166)
Mar 05 15:13:04 srv env[27516]:         at org.java_websocket.client.WebSocketClient.connectBlocking(WebSocketClient.java:177)
Mar 05 15:13:04 srv env[27516]:         at com.github.xenji.homee.api.HomeeWsClient.onClose(network.kt:53)
Mar 05 15:13:04 srv env[27516]:         at org.java_websocket.client.WebSocketClient.onWebsocketClose(WebSocketClient.java:391)
Mar 05 15:13:04 srv env[27516]:         at org.java_websocket.WebSocketImpl.closeConnection(WebSocketImpl.java:504)
Mar 05 15:13:04 srv env[27516]:         at org.java_websocket.WebSocketImpl.closeConnection(WebSocketImpl.java:515)
Mar 05 15:13:04 srv env[27516]:         at org.java_websocket.WebSocketImpl.eot(WebSocketImpl.java:563)
Mar 05 15:13:04 srv env[27516]:         at org.java_websocket.client.WebSocketClient.run(WebSocketClient.java:289)
Mar 05 15:13:04 srv env[27516]:         at java.lang.Thread.run(Thread.java:748)
Mar 05 15:13:06 srv env[27516]: 2018-03-05 15:13:06 [Thread-4] TRACE c.g.xenji.homee.api.HomeeWsClient - sending ping
Mar 05 15:13:06 srv env[27516]: Exception in thread "Thread-4" org.java_websocket.exceptions.WebsocketNotConnectedException
Mar 05 15:13:06 srv env[27516]:         at org.java_websocket.WebSocketImpl.send(WebSocketImpl.java:608)
Mar 05 15:13:06 srv env[27516]:         at org.java_websocket.WebSocketImpl.sendFrame(WebSocketImpl.java:634)
Mar 05 15:13:06 srv env[27516]:         at org.java_websocket.WebSocketImpl.sendPing(WebSocketImpl.java:641)
Mar 05 15:13:06 srv env[27516]:         at org.java_websocket.client.WebSocketClient.sendPing(WebSocketClient.java:237)
Mar 05 15:13:06 srv env[27516]:         at com.github.xenji.homee.api.HomeeWsClient$onOpen$1.invoke(network.kt:37)
Mar 05 15:13:06 srv env[27516]:         at com.github.xenji.homee.api.HomeeWsClient$onOpen$1.invoke(network.kt:23)
Mar 05 15:13:06 srv env[27516]:         at kotlin.concurrent.ThreadsKt$thread$thread$1.run(Thread.kt:18)
Mar 05 15:13:11 srv env[27516]: Exception in thread "Thread-5" org.java_websocket.exceptions.WebsocketNotConnectedException
Mar 05 15:13:11 srv env[27516]:         at org.java_websocket.WebSocketImpl.send(WebSocketImpl.java:608)
Mar 05 15:13:11 srv env[27516]:         at org.java_websocket.WebSocketImpl.send(WebSocketImpl.java:585)
Mar 05 15:13:11 srv env[27516]:         at org.java_websocket.client.WebSocketClient.send(WebSocketClient.java:207)
Mar 05 15:13:11 srv env[27516]:         at com.github.xenji.homee.ExporterKt$main$1$2$2.invoke(exporter.kt:29)
Mar 05 15:13:11 srv env[27516]:         at com.github.xenji.homee.ExporterKt$main$1$2$2.invoke(exporter.kt)
Mar 05 15:13:11 srv env[27516]:         at kotlin.concurrent.ThreadsKt$thread$thread$1.run(Thread.kt:18)```

Make debian package not always overwrite the systemd unit

Enable export of temperature sensors

Current temperature

Remove stats after configurable timeout

In order to put alerts on missing values, the exporter should remove metrics from the output that have not been changed for a potentially configurable period of time.

Auth request failure

I just get started with this exporter
I created a new user specially for this testing purpose but just receive
an auth error:

java -jar ./lib/homee_exporter.jar --username xxxx --password xxx --homee-id 000XXXXXX
Exception in thread "main" com.github.xenji.homee.api.AuthenticationException: Authentication request failure: 401
at com.github.xenji.homee.api.AuthenticationKt.homeeAccessToken(authentication.kt:59)
at com.github.xenji.homee.ExporterKt$main$1.invoke(exporter.kt:38)
at com.github.xenji.homee.ExporterKt$main$1.invoke(exporter.kt)
at com.xenomachina.argparser.SystemExitExceptionKt.mainBody(SystemExitException.kt:74)
at com.xenomachina.argparser.SystemExitExceptionKt.mainBody$default(SystemExitException.kt:72)
at com.github.xenji.homee.ExporterKt.main(exporter.kt:35)