Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/topi314/shelly-exporter
Shelly Plug Prometheus Exporter
https://github.com/topi314/shelly-exporter
exporter grafana metrics power-meter prometheus-exporter shelly shelly-plug-s
Last synced: 5 days ago
JSON representation
Shelly Plug Prometheus Exporter
- Host: GitHub
- URL: https://github.com/topi314/shelly-exporter
- Owner: topi314
- License: apache-2.0
- Created: 2023-05-19T18:18:47.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-06-28T00:27:13.000Z (over 1 year ago)
- Last Synced: 2024-10-12T05:07:19.600Z (25 days ago)
- Topics: exporter, grafana, metrics, power-meter, prometheus-exporter, shelly, shelly-plug-s
- Language: Go
- Homepage:
- Size: 38.1 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/TopiSenpai/shelly-exporter)
[](https://golang.org/doc/devel/release.html)
[](LICENSE)
[](https://github.com/TopiSenpai/shelly-exporter/releases/latest)
[](https://github.com/TopiSenpai/shelly-exporter/actions/workflows/docker.yml)
[](https://discord.gg/sD3ABd5)
# shelly-exporter
Prometheus exporter for Shelly Plug S devices.
## Installation
You can either run the exporter directly or use the provided Docker image.
### Docker-Compose
```yaml
version: '3.7'
services:
prometheus:
image: prom/prometheus:latest
...
shelly-exporter:
image: ghcr.io/topisenpai/shelly-exporter:master
container_name: shelly-exporter
restart: unless-stopped
volumes:
- ./shelly.yml:/var/lib/shelly-collector/config.yml
expose:
- 2112
```
## Configuration
The exporter is configured via a YAML file. The default path is `/etc/shelly-exporter/config.yml` but you can change it
with the `--config` flag.
```yaml
global:
scrape_interval: 1m
scrape_timeout: 10s
log:
level: info
format: text
add_source: false
server:
listen_addr: :2112
endpoint: /metrics
configs:
- name: Plug1
address: 123.456.789.123:80
secure: false
username: admin
password: admin
interval: 1m
timeout: 10s
```
## Metrics
Shelly Exporter exposes the following metrics:
| Metric | Description | Labels |
|--------------------------|---------------------------------------------------------------------------|-----------------|
| `shellyplug_power` | Current real AC power being drawn, in Watts | `name`, `meter` |
| `shellyplug_power_valid` | Whether power metering self-checks OK (0.0 = not OK, 1.0 = OK) | `name`, `meter` |
| `shellyplug_overpower` | Value in Watts, on which an overpower condition is detected | `name`, `meter` |
| `shellyplug_total_power` | Total energy consumed by the attached electrical appliance in Watt-minute | `name`, `meter` |
| `shellyplug_temperature` | PlugS only internal device temperature in °C | `name` |
| `shellyplug_uptime` | Seconds elapsed since boot | `name` |
| `shellyplug_has_update` | Whether an update is available (0.0 = no update, 1.0 = update) | `name` |
## Details
The exporter uses the Shelly API to get the current power consumption of the devices. You can find more information [here](https://shelly-api-docs.shelly.cloud/gen1/#status) and [here](https://shelly-api-docs.shelly.cloud/gen1/#shelly-plug-plugs-status)
## License
Shelly Exporter is licensed under the [Apache License 2.0](/LICENSE).
## Contributing
Contributions are always welcome! Just open a pull request or discussion and I will take a look at it.
## Contact
- [Discord](https://discord.gg/sD3ABd5)
- [Twitter](https://twitter.com/TopiSenpai)
- [Email](mailto:[email protected])