1.6 KiB
| title | description | ha_category | ha_iot_class | ha_release | ha_domain | ha_integration_type | related | ha_quality_scale | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| StatsD | Record events in StatsD. |
|
Local Push | 0.12 | statsd | integration |
|
legacy |
The statsd {% term integration %} makes it possible to transfer all state changes to an external StatsD instance.
To use the statsd {% term integration %} in your installation, add the following to your {% term "configuration.yaml" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
# Example configuration.yaml entry
statsd:
{% configuration %}
host:
description: "IP address of your StatsD host, e.g., 192.168.1.10."
required: true
default: localhost
type: string
port:
description: Port to use.
required: false
default: 8125
type: integer
prefix:
description: Prefix to use.
required: false
default: "hass"
type: string
rate:
description: The sample rate.
required: false
default: 1
type: integer
log_attributes:
description: Log state and attribute changes. This changes the default stats path.
required: false
default: false
type: boolean
value_mapping:
description: Map non-numerical values to numerical ones.
required: false
type: list
{% endconfiguration %}
Full example:
# Example configuration.yaml entry
statsd:
prefix: home
rate: 5
value_mapping:
cooling: 1
heating: 10
StatsD supports various backends.