Apache Kafka
The apache_kafka
integration sends all state changes to a
Apache Kafka topic.
Apache Kafka is a real-time data pipeline that can read and write streams of data. It stores its data safely in a distributed, replicated, fault-tolerant cluster.
To use the apache_kafka
integration in your installation, add the following to your
configuration.yaml
file:
apache_kafka:
ip_address: localhost
port: 9092
topic: home_assistant_1
Configuration Variables
The protocol used to communicate with brokers. Use SASL_SSL
for authentication.
Filters for entities to be included/excluded. (Configure Filter)
Configure Filter
By default, no entity will be excluded. To limit which entities are being exposed to Apache Kafka
, you can use the filter
parameter.
# Example filter to include specified domains and exclude specified entities
apache_kafka:
ip_address: localhost
port: 9092
topic: home_assistant_1
filter:
include_domains:
- alarm_control_panel
- light
include_entity_globs:
- binary_sensor.*_occupancy
exclude_entities:
- light.kitchen_light
Filters are applied as follows:
- No includes or excludes - pass all entities
- Includes, no excludes - only include specified entities
- Excludes, no includes - only exclude specified entities
- Both includes and excludes:
- Include domain and/or glob patterns specified
- If domain is included, and entity not excluded or match exclude glob pattern, pass
- If entity matches include glob pattern, and entity does not match any exclude criteria (domain, glob pattern or listed), pass
- If domain is not included, glob pattern does not match, and entity not included, fail
- Exclude domain and/or glob patterns specified and include does not list domains or glob patterns
- If domain is excluded and entity not included, fail
- If entity matches exclude glob pattern and entity not included, fail
- If entity does not match any exclude criteria (domain, glob pattern or listed), pass
- Neither include or exclude specifies domains or glob patterns
- If entity is included, pass (as #2 above)
- If entity include and exclude, the entity exclude is ignored
- Include domain and/or glob patterns specified
Help us to improve our documentation
Suggest an edit to this page, or provide/view feedback for this page.
Suggest an edit to this page, or provide/view feedback for this page.