ianunruh / shelly-exporter

Prometheus exporter for Shelly Cloud devices

shelly-exporter

Prometheus multi-target exporter that collects status data from the Shelly device API.

Tested with the Shelly Plug US.

Example metrics

Features

• Handles multiple devices with a single exporter, multiple relays per device
• Lightweight Docker image (less than 15MB)

Usage

# Only required if device has restricted login
export SHELLY_USERNAME="admin"
export SHELLY_PASSWORD="changeme"

docker compose up -d --build
docker compose ps
docker compose logs exporter

curl -s "http://localhost:9090/probe?target=192.168.1.x"

Deployment

Use Kustomize to deploy the exporter to a Kubernetes cluster.

kubectl -n monitoring create secret generic shelly-exporter \
    --from-literal=SHELLY_USERNAME=${SHELLY_USERNAME} \
    --from-literal=SHELLY_PASSWORD=${SHELLY_PASSWORD}

kubectl kustomize "https://github.com/ianunruh/shelly-exporter.git/deploy/basic?ref=v1.0.1" | \
    kubectl apply -n monitoring -f-

Refer to the target overlay to learn how to configure the targets for this exporter.

Security

There are two security considerations to make when deploying this exporter.

1. When using authentication, the exporter acts as an authenticated proxy to any web server that is passed in the "target" param. This could result in the auth credentials being exposed. This means the exporter should be locked down with an ingress NetworkPolicy to prevent access to clients other than Prometheus.

2. Any service monitors should have a namespace selector specified to prevent unauthorized services from being used to configure Prometheus to scrape them. The monitors provided in the basic deployment are locked down to the monitoring namespace, for example.