Skip to content

Add include configuration to logbook #1157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Oct 8, 2016
38 changes: 35 additions & 3 deletions source/_components/logbook.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,17 @@ logbook:

Configuration variables:

- **exclude** (*Optional*): Configure which components should **not** create logbook enties.
- **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.
- **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:

```yaml
# Example of excluding domains and entities from the logbook
logbook:
exclude:
entities:
Expand All @@ -39,6 +43,34 @@ logbook:
- weblink
```

In case you just want to see messages from some specific entities or domains use the `include` configuration:

```yaml
# 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.

```yaml
# Example of combining include and exclude configurations
logbook:
include:
domains:
- sensor
- switch
- media_player
exclude:
entities:
- sensor.last_boot
- sensor.date
```

### {% linkable_title 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 an logbook entry for that sensor every day.
Expand Down