The logbook component provides a different perspective on the history of your house by showing all the changes that happened to your house in reverse chronological order. See the demo for a live example. It depends on the
recorder component for storing the data. This means that if the
recorder component is set up to use e.g. MySQL or PostgreSQL as data store, the
logbook component does not use the default SQLite database to store data.
To enable the logbook in your installation, add the following to your
# Example configuration.yaml entry logbook:
- exclude (Optional): Configure which components should not create logbook entries.
- entities (Optional): The list of entity ids to be excluded from creating logbook entries.
- domains (Optional): The list of domains to be excluded from creating logbook entries.
- include (Optional): Configure which components should create logbook entries.
- entities (Optional): The list of entity ids to be included from creating logbook entries.
- domains (Optional): The list of domains to be included from creating logbook entries.
If you want to exclude messages of some entities or domains from the logbook just add the
exclude parameter like:
# Example of excluding domains and entities from the logbook logbook: exclude: entities: - sensor.last_boot - sensor.date domains: - sun - weblink
In case you just want to see messages from some specific entities or domains use the
# Example to show how to include only the listed domains and entities in the logbook logbook: include: domains: - sensor - switch - media_player
You can also use the
include list and filter out some entities or domains with an
exclude list. Usually this makes sense if you define domains on the include side and filter out some specific entities.
# Example of combining include and exclude configurations logbook: include: domains: - sensor - switch - media_player exclude: entities: - sensor.last_boot - sensor.date
Entities customized as hidden are excluded from the logbook by default, but sometimes you want to show the entity in the UI and not in the logbook. For instance you use the
sensor.dateto show the current date in the UI, but you do not want an logbook entry for that sensor every day.
To exclude these entities just add them to the
entities list in the configuration of the logbook.
To exclude all events from a whole domain add it to the
domain list. For instance you use the
sun domain only to trigger automations on the `azimuth attribute, then you possible are not interested in the logbook entries for sun rise and sun set.
It is possible to add custom entries to the logbook by using the script component to fire an event.
# Example configuration.yaml entry script: add_logbook_entry: alias: Add Logbook sequence: - service: logbook.log data_template: name: Kitchen message: is being used # Optional entity_id: light.kitchen domain: light