Access and Maintenance

How to Find and Read Home Assistant Logs

Find Home Assistant logs in Settings, pick the right source, read each line, turn on debug logging for one integration, and share logs safely.

On this page
  1. Quick answer
  2. Open the logs page
  3. Pick the right source
  4. Read a log line
  5. Log levels
  6. Turn on debug logging for one integration
  7. Read logs from the command line or Docker
  8. Log files on disk
  9. Logs, traces and history are different
  10. Share logs safely

Quick answer

Open Settings > System > Logs. For most problems, start with the Core source and the warnings and errors view. If you need to share the details, download the full log.

Open the logs page

The default view is a condensed list of warnings and errors, with repeated messages combined. To see every line, switch to the full or raw view. The wording varies by version, for example “Show full logs” or “Show raw logs”. Select Download to save a copy as a file.

Pick the right source

The source dropdown at the top right switches between:

  • Core: Home Assistant itself and its integrations. Start here.
  • Supervisor: the management layer on Home Assistant OS and Supervised installs.
  • Host: the operating system underneath.
  • DNS, Audio and Multicast: the network and audio services.
  • Each app: one entry for every installed app, such as the Samba share app.

Read a log line

A typical line contains:

  • A timestamp
  • A level, such as WARNING or ERROR
  • The thread, in some versions
  • A logger name, such as homeassistant.components.zha
  • The message

The logger name tells you which part of Home Assistant wrote the line. Custom integrations show up with names like custom_components.<name>, which points you to the integration to check or update.

Log levels

From lowest to highest, the levels are debug, info, warning, error and critical. The default is warning, so you see warnings and above. Not every error is serious. A device that is briefly offline often logs an error and then recovers by itself.

Turn on debug logging for one integration

Debug logging is verbose, so turn it on only for the integration you are investigating.

  • From the UI: open the integration’s page, select the three dots, and choose Enable debug logging. When you turn it off, Home Assistant downloads the debug log.
  • For a temporary change: call the logger.set_level action, for example with homeassistant.components.zha: debug. It takes effect without a restart.
  • For a permanent change: add a logger: block to configuration.yaml. Changes made in YAML apply when Home Assistant restarts.
logger:
  default: warning
  logs:
    homeassistant.components.mqtt: debug

Remove the debug line when you have finished. Debug logging left on makes the logs large and can slow the system down.

Read logs from the command line or Docker

On Home Assistant OS, use the ha command in the console or the SSH app:

  • ha core logs for Core
  • ha supervisor logs for Supervisor
  • ha host logs for the operating system
  • ha addons logs <slug> for one app. Newer releases may name this ha apps logs.

For a Docker install, follow the container log:

docker logs -f homeassistant

The -f flag keeps the output open and shows new lines as they arrive. Replace homeassistant with your container’s name if it is different.

Log files on disk

Home Assistant writes home-assistant.log in your configuration folder, and keeps the previous run as home-assistant.log.1. On Home Assistant OS, some setups use the system journal instead, so check where your version writes its logs.

Logs, traces and history are different

  • Logs show what Home Assistant and its integrations report, including errors.
  • Automation traces show each step of an automation’s last runs. Open the automation and select Traces.
  • Logbook and History show entity changes, such as a light turning on. They are not error logs.
  • Repairs (Settings > System > Repairs) lists problems Home Assistant has found, many of them from log entries.

Share logs safely

Before you post a log publicly, remove or replace:

  • Access tokens and passwords
  • IP addresses and hostnames
  • Location data, such as GPS coordinates or your home address

Post the lines around the error rather than the whole file, unless someone asks for more.

For connection problems that show up in the logs, see why you can’t connect to your Home Assistant.

The complete guide to access and maintenance

How to Access Home Assistant: URLs, Default Login, Tokens and SSO
Read the guide

Keep exploring

Guides from other topics

All topics →