Skip to content

Latest commit

 

History

History
14 lines (12 loc) · 1.29 KB

GET-LOGS.md

File metadata and controls

14 lines (12 loc) · 1.29 KB

Gathering logs in Home Assistant OS

When submitting a bug report one item of critical importance is gathering proper, full logs. While Home Assistant OS does show addon logs in the web interface it is only the most recent lines and misses critical information, such as the data logged at startup, that is useful for understanding the overall environment. The steps below can be used to gather a full set of logs from the startup of the docker container to shutdown:

  1. Install the excellent SSH & Web Terminal addon (available in the Community addons section - search "Web Terminal")
  2. Configure the addon with an SSH password (strong password) or public key
  3. Disable "Protection mode" in the addon, this is required to access docker commands in Home Assistant OS
  4. Start the addon and connect to the system via SSH or the web terminal
  5. In the terminal copy and paste the following command to dump the current addon logs to a compressed file:
docker logs addon_03cabcc9_ring_mqtt 2>&1 | gzip > ring-mqtt.log.gz
  1. Using a tool like WinSCP, an addon like File Editor, or any other method you prefer, to copy/download the ring-mqtt.log.gz file to your computer
  2. Delete the ring-mqtt.log.gz file on your Home Assistant instance before exiting SSH