Log file/Easy

From Kodi
Jump to: navigation, search
Home icon grey.png   ▶ Troubleshooting ▶ HOW-TO:Submit a bug report ▶ Log file ▶ Easy


1 Instructions

Someone has asked you for a debug log (aka log file, kodi.log, xbmc.log, etc). This is what they want you to do:

1 Download the Debug log uploader add-on:
Inside of Kodi go into Programs → Get more... → Kodi Log Uploader and click on "Install"
2 Turn debugging on:
Inside of Kodi go into Settings → System → Debugging and turn on Enable debug logging. You will see some weird text pop up on the screen.
Note: Sometimes you might be asked to enable additional debug logging "components", which is an option in this same Settings/System/Debugging area. If you were not asked to enable anything extra, then don't worry about those additional settings.
3 Restart Kodi:
so that the log file records important startup information.
4 Reproduce whatever issue/bug you are reporting on.
If a bug happened when you played a movie, play a movie. If something weird popped up on the screen when you went into an add-on, go into that add-on. Etc. If the issue doesn't require action (the problem happens when you open Kodi, etc) then go to the next step.
5 If you use passwords or logins in add-ons:
You will probably need to edit your log before you upload it. Don't use the rest of the steps here and instead see here for further instructions.
6 Upload your debug log:
From Kodi's home screen, go into Programs → Kodi Log Uploader, enter your e-mail address (if you haven't used the add-on before) and press "Okay". Then it will ask you if you want to upload the debug log, press "Okay". You might also want to note the log ID code incase the e-mail doesn't go through.

Note: If you don't get the e-mail link, just use the URL http://xbmclogs.com/#### where "####" is your ID code from the popup window.

Note: If you don't get any e-mail link and no window pops up with an ID number, then the site xbmclogs.org might be down and you might need to manually copy/paste your log file to http://pastebin.com instead. See Log file/Advanced#Location for how to locate the log file manually.

If Kodi crashes:
If your issue involves Kodi crashing then you need to do an additional step. Go into Programs and just select the Log Uploader entry (don't enter it). Then bring up the context menu (press C on a keyboard or info on some remotes) and select "Add-on settings". Then uncheck "Always skip XBMC.old.log (log from previous run)". Now it will upload the debug log of when Kodi crashed (the previous run).

7 Copy the URL
from the e-mail you get and paste it to the forum post or give it to whoever asked you for the debug log. If Kodi had crashed during your log, be sure to include the URL for the "old log" file.
Note: Never copy/paste the log file itself into a forum post. Just post the URL.
8 You're done
You can turn off debugging now.

2 Removing passwords

Stop hand.png If you are posting logs to the Internet for others to see:

If you use passwords or login to an account in any add-ons then that password might be exposed in your log file. Most add-ons should not do this, but it's better to be safe than sorry, as you won't want that hanging out on the internet. If this applies to you then you will want to manually open your log file in a text editor and replace any mention of your passwords before putting them online.

This depends on the add-on, so if you see an add-on that exposes a password in the log, please inform the author of that add-on so that they can correct it.

Passwords for network shares like SMB/SAMBA, FTP, etc, will automatically be excluded from the debug log. You do not have to worry about those being exposed.

See Log file/Advanced#Location for how to locate the log file manually. Then just open that xbmc.log (or kodi.log) file in a text editor. If you do not see passwords in your log then you can keep using the instructions on this page for using the debug log uploader add-on. If you see passwords, remove them and then manually copy and paste the log onto a pastebin site, like http://xbmclogs.com or http://pastebin.com , and then give that URL to whoever you need to share your log with. (or see Log file/Advanced#So what do I do with this thing?)

3 If you cannot control Kodi or if it crashes before you can complete these steps

If you cannot control Kodi, such as a remote control not working, or if Kodi crashes before you can upload a log with the log uploader add-on, or can otherwise have issues following these steps, then you will need to manually enable debug logging and manually paste/upload a log to a pastebin-type website.

For enabling logging see: Log file/Advanced#advancedsettings.xml

For manually locating the log file (xbmc.log or kodi.log) file see: Log file/Advanced#Location

Then finally, see Log file/Advanced#So what do I do with this thing? for how to paste it to a pastebin-type website

4 An alternative way to manually copy the log files

See: Log file/File manager access

5 More info

For more info about the debug log see Log file/Advanced.

Personal tools

Wiki help