Logging and debugging

Logging and debugging

TubeSync outputs useful logs, errors and debugging information to the console.

Tip

Even more detailed logs are displayed on the console when the environment variable TUBESYNC_DEBUG is set to True.

Important

TubeSync is only a stand-in for your actual container name or identifier. You should adjust this value, as needed, for your environment.

You can view the console logs with:

$ docker logs --follow TubeSync

To include logs with an issue report, please extract a file and attach it to the issue. The command below creates the TubeSync.logs.txt file with the logs from the console of the TubeSync container instance:

docker logs -t TubeSync > TubeSync.logs.txt 2>&1

Tip

Log files are highly compressible. You can place any combination of files into a .zip archive to save space and make them easier to attach to an issue.

hat-syslog

Important

Only available with v0.18.0 and newer versions.

Access to the historical and live logs is available from a web browser at: http://HOSTNAME_OR_IP:4848/web-logs/index.html

Note

Whichever value the TUBESYNC_DEBUG environment variable was set to, the more detailed logs will remain available from the /web-logs/index.html page.

It is possible to copy the logs database (stored at /config/state/hat/syslog.db) or the web logs (stored at /run/app/log/messages) from a container using the docker container cp command.

You can also create flat files from your current syslog database using the tools included inside the container (as of 7f50278):

docker exec -it TubeSync /usr/bin/env \
    bash -c 'python3 /app/hat-syslog_tool.py --export --out "$(mktemp -d /downloads/cache/live-logs-XXXXXXX)/exported" /config/state/hat/syslog.db'

After that export has completed, you can access the files any way that you prefer.

Viewing those logs can be done with less:

docker exec -t TubeSync /usr/bin/env \
    bash -c 'cat /downloads/cache/live-logs-*/exported/messages.log' | \
    less

These exported logs typically include more information than is shown in the console logs.