shellyplug-exporter (v1.11.3)

Prometheus exporter for Shelly plugs model S written in Crystal.

Note It uses the api provided by the plug, it does not use the MQTT protocol

🚀 Suggestions for new improvements are welcome in the issue tracker.

Installation and Usage

The SHELLYPLUG_HOST environment variable is required to retrieve information from the plug, SHELLYPLUG_PORT is optional (default 80). Authentication variables SHELLYPLUG_AUTH_USERNAME and SHELLYPLUG_AUTH_PASSWORD depend on whether http authentication is enabled on the plug.

The shellyplug-exporter listens on HTTP port 5000 by default. See the environment variable EXPORTER_PORT to change this behavior.

Docker

With docker run command :

docker run -d \
  -p 8080:5000 \
  -e SHELLYPLUG_HOST="shelly-plug-hostname-or-ip" \
  -e SHELLYPLUG_PORT="80" \
  -e SHELLYPLUG_AUTH_USERNAME="username-for-http-auth" \
  -e SHELLYPLUG_AUTH_PASSWORD="password-for-http-auth" \
  -e EXPORTER_PORT=5000 \
  ghcr.io/d1ceward/shellyplug-exporter:latest # Or with Docker Hub: d1ceward/shellyplug-exporter:latest

With docker-compose file :

---
services:
  plug_exporter:
    image: ghcr.io/d1ceward/shellyplug-exporter:latest # Or with Docker Hub: d1ceward/shellyplug-exporter:latest
    restart: unless-stopped
    ports:
      - 8080:5000
    environment:
      SHELLYPLUG_HOST: shelly-plug-hostname-or-ip
      SHELLYPLUG_PORT: 80
      SHELLYPLUG_AUTH_USERNAME: username-for-http-auth
      SHELLYPLUG_AUTH_PASSWORD: password-for-http-auth
      EXPORTER_PORT: 5000

Linux

Download the executable file :

wget --no-verbose -O shellyplug-exporter https://github.com/d1ceward/shellyplug-exporter/releases/download/v1.11.3/shellyplug-exporter-linux-amd64

Modify the executable's permissions :

chmod +x shellyplug-exporter

Execution example :

shellyplug-exporter run \
  --plug-host=shelly-plug-hostname-or-ip \
  --plug-port=80 \
  --plug-auth-username=username-for-http-auth \
  --plug-auth-password=password-for-http-auth \
  --port 5000

Documentation available here : https://d1ceward.github.io/shellyplug-exporter/

Metrics

Base path: /metrics

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/d1ceward/shellyplug-exporter. By contributing you agree to abide by the Code of Merit.

1. Fork it (https://github.com/d1ceward/shellyplug-exporter/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Development building and running

1. Install corresponding version of Crystal lang (cf: .crystal-version file)
2. Install Crystal dependencies with shards install
3. Build with shards build

The newly created binary should be at bin/shellyplug-exporter

Running tests

crystal spec

Contributors

• d1ceward - creator and maintainer