Log file/Easy: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
Line 48: Line 48:
File:File manager.log file.04.png| {{large|'''Step 4:'''}} Type in, either using a keyboard or using the on-screen-keyboard, the following: '''<code>special://logpath</code>''' and then press '''Done'''.
File:File manager.log file.04.png| {{large|'''Step 4:'''}} Type in, either using a keyboard or using the on-screen-keyboard, the following: '''<code>special://logpath</code>''' and then press '''Done'''.
File:File manager.log file.05.png| {{large|'''Step 5:'''}} You can rename the source if you want, or just go down and press '''OK''' to finish adding the logpath as a source.
File:File manager.log file.05.png| {{large|'''Step 5:'''}} You can rename the source if you want, or just go down and press '''OK''' to finish adding the logpath as a source.
File:File manager.log file.06.png| {{large|'''Step 6:'''}}  
File:File manager.log file.06.png| {{large|'''Step 6:'''}} Now we want to add a location to save the log file to. Another [[media source]], such as a network file share, can be added here, or we can even just plug in a USB drive, which should automatically show up in the File manager. '''ADATAPRO''' in the screenshot is a USB flash drive for this example.
File:File manager.log file.07.png| {{large|'''Step 7:'''}}  
File:File manager.log file.07.png| {{large|'''Step 7:'''}} On Panel A: Open the '''logpath''' source. On Panel B: Open the source you added, either USB drive or other [[media source]] location. You can further navigate in Panel B to the exact folder you wish to copy the log file to.
File:File manager.log file.08.png| {{large|'''Step 8:'''}}  
File:File manager.log file.08.png| {{large|'''Step 8:'''}} Scroll down until you see '''xbmc.log''' (currently running log) or '''xbmc.old.log''' (log from the last time XBMC was open). Bring up the contextual menu ({{keypress|C}} on a keyboard or {{button|Menu}} on most remotes), and then select '''Copy'''.
File:File manager.log file.09.png| {{large|'''Step 9:'''}}  
File:File manager.log file.09.png| {{large|'''Step 9:'''}}  
File:File manager.log file.10.png| {{large|'''Step 10:'''}}  
File:File manager.log file.10.png| {{large|'''Step 10:'''}}  

Revision as of 21:21, 2 August 2013

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

1 Download the Debug log uploader add-on:
Inside of XBMC go into Programs → Get more... → XBMC Log Uploader and click on "Install"
2 Turn debugging on:
Inside of XBMC go into Settings → System → Debugging and turn on Enable debug logging. You will see some weird text pop up on the screen.
3 Restart XBMC:
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 XBMC, etc) then go to the next step.
5 If you use passwords for your network file sharing:
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 XBMC's home screen, go into Programs → XBMC 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 number (4-5 digits) incase the e-mail doesn't go through.


If XBMC crashes:
Go into Programs and just highlight the XBMC 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 XBMC 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. Never copy/paste the log file itself into a forum post.
8 You're done
You can turn off debugging now.

Removing passwords

Use these steps if you use sensitive passwords in your network shares:

This portion of the guide is still a work in progress. If you use passwords for your network file shares, then you might have to remove them from the debug log. This might not be the case for most people using SMB/Windows file sharing, even if you are using a password (XBMC should strip passwords out of the logs for SMB), but you might want to check the log file just to be safe.


The basic gist is you have to manually copy your debug log file (see here for location) and use a find/replace text editing tool to remove your password with something like a bunch of asterisks. Then just manually paste that onto a new paste file on http://xbmclogs.com and copy that URL to the forum post you posting in.

Alternative access

How to copy the log file to an easily accessible location using the File manager. Good for Android users without root and others.


VIdeo tutorial version of the above how-to

More info

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