https://github.com/mayniklas/shelly-exporter
A Shelly power metrics exporter written in golang. Currently only tested for Shelly Plug S.
https://github.com/mayniklas/shelly-exporter
exporter grafana nix-flake power-meter prometheus prometheus-exporter prometheus-metrics shelly shelly-plug-s
Last synced: 10 months ago
JSON representation
A Shelly power metrics exporter written in golang. Currently only tested for Shelly Plug S.
- Host: GitHub
- URL: https://github.com/mayniklas/shelly-exporter
- Owner: MayNiklas
- Created: 2022-05-28T10:28:07.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-31T08:40:36.000Z (about 2 years ago)
- Last Synced: 2024-04-21T01:05:28.516Z (about 2 years ago)
- Topics: exporter, grafana, nix-flake, power-meter, prometheus, prometheus-exporter, prometheus-metrics, shelly, shelly-plug-s
- Language: Go
- Homepage:
- Size: 211 KB
- Stars: 11
- Watchers: 4
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# shelly-exporter
A Shelly power metrics exporter written in golang.
Currently only tested for Shelly Plug S.
[](https://github.com/MayNiklas/shelly-exporter/actions/workflows/go-tests.yml)
## Available metrics
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
## How to execute for development purposes
Metrics will be exposed on: http://localhost:8080/probe?target=http://
### Nix / NixOS
This repository contains a `flake.nix` file.
```sh
# run the package
nix run .#shelly_exporter
# build the package
nix build .#shelly_exporter
```
### General
Make sure [golang](https://go.dev) is installed.
```sh
# 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
```
## How to install
### NixOS
1. Add this repository to your `flake.nix`:
```nix
{
inputs.shelly-exporter = {
url = "github:MayNiklas/shelly-exporter";
inputs = { nixpkgs.follows = "nixpkgs"; };
};
}
```
2. Enable the service & the prometheus scraper in your configuration:
```nix
{ 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
Docker builds for this project are available on [Docker Hub](https://hub.docker.com/r/mayniki/shelly-exporter).
Currently amd64 and arm64 are supported.
The following environment variables are available:
* `listen` - The address to listen on. Defaults to `8080`
* `port` - The port to listen on. Defaults to `8080`
Of course, both parameters can be achieved by using a different port forwarding configuration.
```sh
docker run -d --rm -p 8080:8080 mayniki/shelly-exporter:v1.0.2
```
For docker-compose, the following configuration can be used:
```yml
version: "3.9"
services:
shelly-exporter:
image: mayniki/shelly-exporter:v1.0.2
container_name: shelly-exporter
restart: unless-stopped
ports:
- 8080:8080
```
After starting the container, all metrics will be available on `http://localhost:8080/probe?target=http://`.
Since the container itself is stateless, all configuration has to be done by your prometheus configuration:
```yml
- 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
```
### Libaries used
- https://github.com/prometheus/client_golang
### Libary documentation
- https://pkg.go.dev/github.com/prometheus/client_golang/prometheus
### API documentation
- https://shelly-api-docs.shelly.cloud/gen1/#shelly-plug-plugs-status