2024.11.2
Home ▸ Integrations ▸

StatsD

The statsd integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] makes it possible to transfer all state changes to an external StatsD instance.

To use the statsd integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] in your installation, add the following to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes.

# 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.

Related topics