A Shelly power metrics exporter written in golang. Currently only tested for Shelly Plug S.
| Name | Description |
|---|---|
| shelly_power_current | Current real AC power being drawn, in Watts |
| shelly_power_total | Total energy consumed by the attached electrical appliance in Watt-minute |
| shelly_temperature | internal device temperature in °C |
| shelly_update_available | Info whether newer firmware version is available |
| shelly_uptime | Seconds elapsed since boot |
All metrics include the following labels:
- device IP
- device name
- device hostname
Metrics will be exposed on: http://localhost:8080/probe?target=http://<shelly_ip>
This repository contains a flake.nix file.
# run the package
nix run .#shelly_exporter
# build the package
nix build .#shelly_exporterMake sure golang is installed.
# run application
go run .
# build application
go build
# execute tests
go test -v ./...
# show test coverage
go test -covermode=count -coverpkg=./... -coverprofile cover.out -v ./...
go tool cover -html cover.out -o cover.html- Add this repository to your
flake.nix:
{
inputs.shelly-exporter = {
url = "github:MayNiklas/shelly-exporter";
inputs = { nixpkgs.follows = "nixpkgs"; };
};
}- Enable the service & the prometheus scraper in your configuration:
{ shelly-exporter, ... }: {
imports = [ shelly-exporter.nixosModules.default ];
services.shelly-exporter = {
enable = true;
port = "8080";
listen = "localhost";
user = "shelly-exporter";
group = "shelly-exporter";
configure-prometheus = true;
targets = [
"http://192.168.0.2"
"http://192.168.0.3"
"http://192.168.0.4"
"http://192.168.0.5"
"http://192.168.0.6"
"http://192.168.0.7"
];
};
}Docker builds for this project are available on Docker Hub. Currently amd64 and arm64 are supported.
The following environment variables are available:
listen- The address to listen on. Defaults to8080port- The port to listen on. Defaults to8080
Of course, both parameters can be achieved by using a different port forwarding configuration.
docker run -d --rm -p 8080:8080 mayniki/shelly-exporter:v1.0.2For docker-compose, the following configuration can be used:
version: "3.9"
services:
shelly-exporter:
image: mayniki/shelly-exporter:v1.0.2
container_name: shelly-exporter
restart: unless-stopped
ports:
- 8080:8080After starting the container, all metrics will be available on http://localhost:8080/probe?target=http://<shelly_ip>.
Since the container itself is stateless, all configuration has to be done by your prometheus configuration:
- job_name: shelly
scrape_interval: 15s
scrape_timeout: 10s
metrics_path: /probe
scheme: http
relabel_configs:
- source_labels: [__address__]
separator: ;
regex: (.*)
target_label: __param_target
replacement: $1
action: replace
- source_labels: [__param_target]
separator: ;
regex: (.*)
target_label: instance
replacement: $1
action: replace
- separator: ;
regex: (.*)
target_label: __address__
replacement: 127.0.0.1:8080
action: replace
static_configs:
- targets:
- http://192.168.0.2
- http://192.168.0.3
- http://192.168.0.4
- http://192.168.0.5
- http://192.168.0.6
- http://192.168.0.7