Skip to main content

Making a log file

About

Kodi writes its log to the kodi.log file in its temporary directory. The location of that directory depends on the platform, and can differ even on the same platform. See where to find it.

Preparation

By default, the log contains only errors and a few notable events. To find the cause of an issue, we need the full log, so enable debug logging in Kodi and in Elementum:

  • Open Kodi System settings. Kodi System settings
  • Switch the settings level to Expert. Expert settings level
  • Enable debug logging. Enable debug logging
  • That’s it for Kodi! Debug logging also shows CPU usage and other information on screen. To hide it, create an advancedsettings.xml file in Kodi’s userdata folder with this content:
    <?xml version="1.0" ?>
    <advancedsettings>
        <loglevel>2</loglevel>
        <debug>
            <extralogging>true</extralogging>
            <showloginfo>false</showloginfo>
        </debug>
    </advancedsettings>
    It enables debug logging and hides the on-screen information.
  • In Elementum: open the add-on settings, go to the Advanced tab and set Log level to Debug. Enable debug logging in Elementum

Kodi now writes everything to the log file.

Debug pages

Elementum has a few HTTP pages with information about torrents, the system, and timings of common operations (very useful for developers):

  • /debug/bundle has all the debug information and the kodi.log file. It is the most complete log, and what we need to find a problem.
  • /debug/all has all the debug information without kodi.log: the system and the torrent engine, but not Kodi.

To find the address of these pages:

  • Open the Elementum add-on and choose Status. Elementum Status
  • The table shows the address, which can also be opened from other devices (if Kodi runs on another device in your network). Status output

Two ways to get a log file

The easy way

Use this if Elementum starts and you can browse it. Otherwise, see the manual way.

Elementum can upload the /debug/bundle or /debug/all log to a pastebin service:

  • Open the Elementum settings, go to the Advanced tab and find the Logging section with the upload options. Elementum settings, Advanced tab
  • Elementum shows the URL of the uploaded log. Add it to your issue.

The manual way

It takes a few more steps, at least the first time. Follow Kodi’s guide: install the log uploader add-on and run it to get a link to the uploaded log. Or find the log file yourself and attach it to the issue.