Add doc for new ignore_attributes option (#13981)

Added documentation for new config options added with https://github.com/home-assistant/core/pull/37747
This commit is contained in:
mdegat01 2020-07-16 04:03:59 -04:00 committed by GitHub
parent e5a72cb93a
commit f0509a8422
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -148,6 +148,10 @@ tags_attributes:
description: The list of attribute names which should be reported as tags and not fields to InfluxDB. For example, if set to `friendly_name`, it will be possible to group by entities' friendly names as well, in addition to their ids. description: The list of attribute names which should be reported as tags and not fields to InfluxDB. For example, if set to `friendly_name`, it will be possible to group by entities' friendly names as well, in addition to their ids.
required: false required: false
default: 0 default: 0
ignore_attributes:
type: [string, list]
description: The list of attribute names to ignore when reporting to InfluxDB. This can be used to filter out attributes that either don't change or don't matter to you in order to reduce the amount of data stored in InfluxDB.
required: false
component_config: component_config:
type: string type: string
required: false required: false
@ -157,6 +161,10 @@ component_config:
type: string type: string
description: Measurement name to use instead of a unit or default measurement. This will store all data points in a single measurement. description: Measurement name to use instead of a unit or default measurement. This will store all data points in a single measurement.
required: false required: false
ignore_attributes:
type: [string, list]
description: The list of attribute names to ignore when reporting to InfluxDB. Will be merged with the default `ignore_attributes` list when processing a state change event for a particular entity.
required: false
component_config_domain: component_config_domain:
type: string type: string
required: false required: false
@ -166,6 +174,10 @@ component_config_domain:
type: string type: string
description: Measurement name to use instead of a unit or default measurement. This will store all data points in a single measurement. description: Measurement name to use instead of a unit or default measurement. This will store all data points in a single measurement.
required: false required: false
ignore_attributes:
type: [string, list]
description: The list of attribute names to ignore when reporting to InfluxDB. Will be merged with the default `ignore_attributes` list when processing a state change event for a particular entity.
required: false
component_config_glob: component_config_glob:
type: string type: string
required: false required: false
@ -175,6 +187,10 @@ component_config_glob:
type: string type: string
description: Measurement name to use instead of unit or default measurement. This will store all data points in a single measurement. description: Measurement name to use instead of unit or default measurement. This will store all data points in a single measurement.
required: false required: false
ignore_attributes:
type: [string, list]
description: The list of attribute names to ignore when reporting to InfluxDB. Will be merged with the default `ignore_attributes` list when processing a state change event for a particular entity.
required: false
{% endconfiguration %} {% endconfiguration %}
## Configure Filter ## Configure Filter