Home Assistant

StatsD

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

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

# Example configuration.yaml entry
statsd:

Configuration Variables

Looking for your configuration file?
host string Required, default: localhost

IP address of your StatsD host, e.g., 192.168.1.10.

port integer (Optional, default: 8125)

Port to use.

prefix string (Optional, default: hass)

Prefix to use.

rate integer (Optional, default: 1)

The sample rate.

log_attributes boolean (Optional, default: false)

Log state and attribute changes. This changes the default stats path.

value_mapping list (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.