diff --git a/source/_components/logger.markdown b/source/_components/logger.markdown index 2f89e090967a..d3cef23a0137 100644 --- a/source/_components/logger.markdown +++ b/source/_components/logger.markdown @@ -11,15 +11,16 @@ logo: home-assistant.png ha_category: "Utility" --- -The logger component lets you define the level of logging activities in Home Assistant. +The `logger` component lets you define the level of logging activities in Home Assistant. -To enable the logger in your installation, add the following to your `configuration.yaml` file: +To enable the `logger` component in your installation, add the following to your `configuration.yaml` file: -To have a full log and log everything only this entry is needed (without any qualifier): ```yaml +# Example configuration.yaml entry logger: ``` -To log all messages and ignore events lower than critical for specified components. + +To log all messages and ignore events lower than critical for specified components: ```yaml # Example configuration.yaml entry @@ -30,7 +31,7 @@ logger: homeassistant.components.camera: critical ``` -To ignore all messages lower than critical and log event for specified components. +To ignore all messages lower than critical and log event for specified components: ```yaml # Example configuration.yaml entry @@ -43,7 +44,25 @@ logger: homeassistant.components.camera: critical ``` -Possible log severities are: +{% configuration %} + default: + description: Default log level. + required: false + type: '[log_level](#log-levels)' + default: debug + logs: + description: List of components and their log level. + required: false + type: map + keys: + '<component_namespace>': + description: Logger namespace of the component. + type: '[log_level](#log-levels)' +{% endconfiguration %} + +### {% linkable_title Log Levels %} + +Possible log severity levels are: - critical - fatal @@ -53,11 +72,26 @@ Possible log severities are: - info - debug - notset - + +## {% linkable_title Services %} + +### {% linkable_title Service `set_default_level` %} + +You can alter the default log level (for components without a specified log +level) using the service `logger.set_default_level`. + +An example call might look like this: + +```yaml +service: logger.set_default_level +data: + level: info +``` + ### {% linkable_title Service `set_level` %} You can alter log level for one or several components using the service -``logger.set_level``. It accepts the same format as ``logs`` in the configuration. +`logger.set_level`. It accepts the same format as `logs` in the configuration. An example call might look like this: @@ -68,7 +102,9 @@ data: homeassistant.components.media_player.yamaha: debug ``` -The log information are stored in the [configuration directory](/docs/configuration/) as `home-assistant.log` and you can read it with the command-line tool `cat` or follow it dynamically with `tail -f`. +The log information are stored in the [configuration directory](/docs/configuration/) +as `home-assistant.log` and you can read it with the command-line tool `cat` or +follow it dynamically with `tail -f`. If you are a Hassbian user you can use the example below: @@ -76,7 +112,8 @@ If you are a Hassbian user you can use the example below: $ tail -f /home/homeassistant/.homeassistant/home-assistant.log ``` -If you are a Hass.io user you can use the example below, whenlogged in through the ssh addon: +If you are a Hass.io user, you can use the example below, when logged in through +the [SSH add-on](/addons/ssh/): ```bash $ tail -f /config/home-assistant.log