Logbook
The logbook integration provides a different perspective on the history of your
house by showing all the changes that happened to your house in reverse
chronological order. It depends on
the recorder
integration for storing the data. This means that if the
recorder
integration is set up to use e.g., MySQL or
PostgreSQL as data store, the logbook
integration does not use the default
SQLite database to store data.
This integration is by default enabled, unless you’ve disabled or removed the default_config:
line from your configuration. If that is the case, the following example shows you how to enable this integration manually:
# Example configuration.yaml entry
logbook:
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
In case you just want to see messages from some specific entities or domains use
the include
configuration:
# 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
Exclude Events
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.date
to show the current date in the UI,
but you do not want a logbook entry for that sensor every day.
To exclude these entities just add them to the exclude
> entities
list in
the configuration of the logbook.
To exclude all events from a whole domain add it to the exclude
> 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.
Custom Entries
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