Richard Cox 16280723e7 Adding statsd mapping (#3010)
* Adding statsd mapping

* Keep the default configuration sample minimized
2017-07-27 13:40:31 +02:00

1.2 KiB

layout title description date sidebar comments sharing logo footer ha_category ha_release
page StatsD Record events in StatsD. 2016-01-25 08:00 true false true statsd.png true History 0.12

The statsd component makes it possible to transfer all state changes to an external StatsD instance.

To use the statsd component in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
statsd:

Configuration variables:

  • host (Optional): IP address of your StatsD host, eg. 192.168.1.10. Defaults to localhost.
  • port (Optional): Port to use. Defaults to 8125.
  • prefix (Optional): Prefix to use. Defaults to hass.
  • rate (Optional): The sample rate. Defaults to 1.
  • log_attributes (Optional): Log state and attribute changes. This changes the default stats path.
  • value_mapping (Optional): Map non-numerical values to numerical ones.

Full example:

# Example configuration.yaml entry
statsd:
  prefix: home
  rate: 5
  value_mapping:
    cooling: 1
    heating: 10

StatsD supports various backends.