Skip to content

HomePlug Power Line Communication statistics exporter for Prometheus

License

Notifications You must be signed in to change notification settings

brandond/homeplug_exporter

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HomePlug Power Line Communication Exporter for Prometheus

Exports HomePlug PLC network and station statistics via HTTP for Prometheus consumption.

Help on flags:

usage: homeplug_exporter [<flags>]

Flags:
  -h, --help                   Show context-sensitive help (also try --help-long and --help-man).
      --telemetry.address=":9702"
                               Address on which to expose metrics.
      --telemetry.endpoint="/metrics"
                               Path under which to expose metrics.
      --interface=INTERFACE    Interface to search for Homeplug devices.
      --destaddr=00B052000001  Destination MAC address for Homeplug devices.
      --log.level="info"       Only log messages with the given severity or above. Valid levels: [debug, info, warn, error, fatal]
      --log.format="logger:stderr"
                               Set the log target and format. Example: "logger:syslog?appname=bob&local=7" or "logger:stdout?json=true"
      --version                Show application version.

Tested with TP-Link TL-PA4010, but should work with any device that supports HomePlug AV or better.

The default destination MAC address will elicit a response from any HomePlug devices on the local Layer 2 network segment. This will NOT find devices on the far side of a Power Line bridge. If you know the MAC address of a device, including a device on the far side of a Power Line bridge, you may override the destination address.

Running

Using Docker

NOTE: The HomePlug protocol uses raw ethernet frames, and must be run with --net=host on the same Layer 2 network segment as at least one HomePlug device.

docker run --rm --detach --name=homeplug_exporter --net=host brandond/homeplug_exporter

Details

Collectors

# HELP homeplug_exporter_build_info A metric with a constant '1' value labeled by version, revision, branch, and goversion from which homeplug_exporter was built.
# TYPE homeplug_exporter_build_info gauge
# HELP homeplug_network_id Logical network information
# TYPE homeplug_network_id gauge
# HELP homeplug_station_rx_rate_bytes Average PHY Rx data rate
# TYPE homeplug_station_rx_rate_bytes gauge
# HELP homeplug_station_tx_rate_bytes Average PHY Tx data rate
# TYPE homeplug_station_tx_rate_bytes gauge

About

HomePlug Power Line Communication statistics exporter for Prometheus

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 82.1%
  • Makefile 14.1%
  • Dockerfile 2.3%
  • Shell 1.5%