Skip to content

Gnarflord/prometheus-shelly-exporter

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

prometheus-shelly-exporter

Prometheus Exporter for Shelly devices

If you want support for another device, or metrics for an existing device are missing, please open an issue or PR. I only implemented for the devices I personally have.

Help

usage: shelly_exporter.py [-h] [-l LISTEN_IP] [-p LISTEN_PORT]
                          [-s STATIC_TARGETS] [-U USERNAME] [-P PASSWORD]

Prometheus Exporter for Shelly devices.

This exporter will scrape the API endpoints of Shelly devices.
Device-specific metrics are auto-discovered based on the 'type' value of the '/shelly' endpoint.

2 endpoints are provided:
  * The '/probe' endpoint will do a single scrape of the target specified
    with the 'target' URL parameter.
    'username' and 'password' parameters can optionally be added if authentication is required.
  * The '/metrics' endpoint will scrape all devices specified at startup
    with the '-s|--static-targets' option.
    Other relevant flags are '-U|--username' and '-P|--password'.

options:
  -h, --help            show this help message and exit
  -l LISTEN_IP, --listen-ip LISTEN_IP
                        IP address for the exporter to listen on. Default:
                        0.0.0.0
  -p LISTEN_PORT, --listen-port LISTEN_PORT
                        Port for the exporter to listen on. Default: 9686
  -s STATIC_TARGETS, --static-targets STATIC_TARGETS
                        Comma-separated list of static targets to scrape when
                        querying /metrics
  -U USERNAME, --username USERNAME
                        Username for the static targets (same for all)
  -P PASSWORD, --password PASSWORD
                        Password for the static targets (same for all)

All parameters can be supplied as env vars in 'SHELLY_<LONG_ARG>' form (e.g. 'SHELLY_LISTEN_PORT')

About

Prometheus Exporter for Shelly products

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%