Difference between revisions of "Log file/Easy"

From Official Kodi Wiki
Jump to navigation Jump to search
m (remove ubuntu paste)
 
(46 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{mininav|[[Troubleshooting]]|[[Log file]]}}
{{mininav| [[Troubleshooting]] | [[Log file]] }}
__FORCETOC__


<span style="font-size:2em;line-height:100%;">Someone has asked you for a debug log (aka log file, XBMC.log, etc). This is what they want you to do:</span>


{| class="prettytable" style="font-size:1.5em;line-height:150%;"
= Introduction =
<section begin="intro" />This method assumes you are able to navigate the menu system of {{kodi}}. If you cannot gain access to the menu system, then you will need to follow the '''''[[Log_file/Advanced|Advanced Method]]'''''.<section end="intro" />
 
 
 
= Steps =
Ensure you follow each step in the displayed order.
 
'''Note:''' If you intend to use the '''''[[Add-on:Kodi_Logfile_Uploader| Kodi Logfile Uploader Add-on]]''''' install the add-on '''now''' before commencing the steps.
 
 
{| class="prettytable" style="width:70%"
|-
|-
! style="font-size:2.5em;" | 1
! scope="row" ! style="background-color:#b8ecff; text-align:left;"|1. Enable Debug Mode by using one of the following methods:
| '''Download the Debug log uploader add-on:'''<br /> Inside of XBMC go into {{highlight|bordered=yes|Programs → Get more... → XBMC Log Uploader}} and click on "Install"
|}
<section begin="EnableDebugMode" />:* Enable the setting '''Enable debug logging''' in the settings page located at '''''[[Settings/System/Logging#Debug|Settings > System Settings > Logging]]'''''
:* Pressing {{keypress|ctrl|shift|d}} on a keyboard
:* Create an entry in the '''''[[Advancedsettings.xml#loglevel|advancedsettings.xml]]''''' file. See: '''''[[Log_file/Advanced|Advanced Method]]'''''<section end="EnableDebugMode" />
 
:If you have been asked to enable component specific logging see '''''[[Log_file/Easy#Enable_component-specific_logging|Enable component-specific logging]]''''' section below.
 
 
{| class="prettytable" style="width:70%"
|-
|-
! style="font-size:2.5em;" | 2
! scope="row" ! style="background-color:#b8ecff; text-align:left;"|2. Restart {{Kodi}} using one of the options in the {{kodi}} Power Menu.
| '''Turn debugging on:'''<br /> Inside of XBMC go into {{highlight|bordered=yes|Settings → System → Debugging}} and turn on {{highlight|bordered=yes|Enable debug logging}}. You will see some weird text pop up on the screen.
|}
:Do not simply disconnect the power. Doing this may prevent saving the changes you made in the Settings page when you enabled Debug Mode.
 
:When you restart, you should see counters displayed in the top left corner of the screen. If you do not see these counters, then debug mode is not enabled.
 
:Restarting has the following effect:
:* Reduce the size of the log by clearing it and starting fresh
:* It captures the startup that can reveal critical information about the installation. eg graphics cards, audio drivers, versions etc
 
 
{| class="prettytable" style="width:70%"
|-
|-
! style="font-size:2.5em;" | 3
! scope="row" ! style="background-color:#b8ecff; text-align:left;"|3. It is important that you now replicate the problem while the log is running. Do whatever you did previously when you experienced the problem.
| '''Restart XBMC:'''<br /> so that the log file records important startup information.
|}
:For example...
 
:* If you are having problems scraping, then run an Update Library
:* If you are having problems with playback, then try playing the problematic video or music file
:* If you cannot install add-ons, then try installing the add-on.
 
 
{| class="prettytable" style="width:70%"
|-
|-
! style="font-size:2.5em;" | 4
! scope="row" ! style="background-color:#b8ecff; text-align:left;"|4. The log must now be uploaded to a [[w:Pastebin|Pastebin]] type site using one of the methods in the next section:
| '''Reproduce whatever issue/bug you are reporting on.'''<br /> 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.
|}
 
 
= Uploading Methods =
Choose one of these methods to upload the log.
 
<div style="margin-left: 4em;">
== Add-on Kodi Logfile Uploader ==
:If you are using this method to upload the log, you may run it now. Once you upload the logfile, you must post the provided url into a post on the forum. Without it, we will be unable to locate your logfile.
 
:By default the add-on only uploads the current ''kodi.log'' file. If you need to upload the ''kodi.old.log'', ensure the setting is enabled in the add-ons setting page. Once enabled, you will need to upload the current ''kodi.log'', then upload the ''kodi.old.log''
 
::'''''See: [[Add-on:Kodi_Logfile_Uploader| Kodi Logfile Uploader Add-on]]'''''
 
 
== File Manager ==
{{list|Log file/File manager access}}
:Once you have obtained the log, use the Copy and Paste method to upload the log.
::'''''See: [[Log_file/File_manager_access| Kodi Logfile Uploader Add-on]]'''''
</div>
 
 
<div style="margin-left: 4em;">
== Copy and Paste ==
<section begin="CopyAndPaste" />:If you are using a desktop operating system, such as Windows, then you can simply navigate to the Debug Log using the File Manager of the operating system.
 
:Once you find the log...
:#Open it with any text editor and copy the contents of the file.
:#Paste the contents to a paste site like '''''http://paste.kodi.tv/''''', and press the ''Save'' icon.
:#For very large logs, you may need to split the log into two or more pastes.
:#When the screen refreshes with your paste, '''copy the entire address in the address bar and paste it into a new message in your post'''.
 
:Logs are located in the following locations: <section end="CopyAndPaste" />
 
:{{LogfilePath}}
</div>
 
 
 
<div style="margin-left: 4em;">
== iOS Native Sharing ==
From Kodi v19, accessing the {{Kodi}} log file on your iOS device has become a whole lot simpler.
::'''''See: [[Log_file/iOS_native_sharing | iOS native sharing]]'''''
</div>
 
 
 
= Enable component-specific logging =
'''Only enable this if you have been specifically asked to enable it.'''
 
For more extensive logging, several system components can be selected to put in more detailed debug messages in Kodi's log file. Multiple components can be selected.
 
Enable the setting '''''Enable component-specific logging''''' in '''''[[Settings/System/Logging#Debug|Settings > System Settings > Logging]]'''''.
 
Select '''''Specify component-specific logging''''' and select the required components.
 
<gallery mode="packed" widths="600px" heights="384px">
File:Settings-System-Logging-01.jpg
File:Component-logging-selection.jpg
</gallery>
 
'''The following components are available, depending upon your hardware.'''
<section begin="ComponentValues" />
{| class="prettytable"
! scope="row" ! style="width:270px; | GUI name || ! scope="row" ! style="width:250px; | <setextraloglevel> code
|-
| The SMB library || style="text-align:center;" | 32
|-
| The libcURL library (HTTP(S), DAV) || style="text-align:center;" | 64
|-
| The FFmpeg libraries || style="text-align:center;" | 128
|-
| JSON-RPC requests || style="text-align:center;" | 1024
|-
| The Audio component || style="text-align:center;" | 2048
|-
| The Airtunes library || style="text-align:center;" | 4096
|-
| The UPnP components || style="text-align:center;" | 8192
|-
| The libCEC library || style="text-align:center;" | 16384
|-
| The Video component || style="text-align:center;" | 32768
|-
| The Webserver component || style="text-align:center;" | 65536
|-
|-
! style="font-size:2.5em;" | 5
| The Database component || style="text-align:center;" | 131072
| '''If you use passwords or logins in add-ons:'''<br /> You will probably need to edit your log before you upload it. Don't use the rest of the steps here and instead see '''[[#Removing passwords|here]]''' for further instructions.
|-
|-
! style="font-size:2.5em;" | 6
| audio/video timing information || style="text-align:center;" | 262144
| '''Upload your debug log:'''<br /> From XBMC's home screen, go into {{highlight|bordered=yes|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.
|-
 
| Windowing component || style="text-align:center;" | 524288
 
|-
'''If XBMC crashes:'''<br /> Go into {{highlight|bordered=yes|Programs}} and just highlight the XBMC Log Uploader entry (don't enter it). Then bring up the context menu (press {{keypress|C}} on a keyboard or {{button|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).
| PVR component || style="text-align:center;" | 1048576
|-
| EPG component || style="text-align:center;" | 2097152
|-
|-
! style="font-size:2.5em;" | 7
| Announce Logging || style="text-align:center;" | 4194304
| '''Copy the URL'''<br /> from the e-mail you get and paste it to the forum post or give it to whoever asked you for the debug log. {{note|Never copy/paste the log file itself into a forum post. Just post the URL.}}
|-
|-
! style="font-size:2.5em;" | 8
| WS-Discovery component || style="text-align:center;" | 8388608
| '''You're done'''<br /> You can turn off debugging now.
|}
|}
<section end="ComponentValues" />


== Removing passwords ==
{{log file password warning}}


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, 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.


==Alternative access==
{{see|Log file/File manager access}}


== More info ==
{{Top}}
For more info about the debug log see '''[[Log file/Advanced]]'''.
{{updated|19}}
{{gotham updated}}


[[Category:XBMC Manual]]
[[Category:Karellen]]
[[Category:Troubleshooting]]
[[Category:Troubleshooting]]

Latest revision as of 23:00, 4 January 2022

Home icon grey.png   ▶ Troubleshooting ▶ Log file ▶ Easy


1 Introduction

This method assumes you are able to navigate the menu system of Kodi. If you cannot gain access to the menu system, then you will need to follow the Advanced Method.


2 Steps

Ensure you follow each step in the displayed order.

Note: If you intend to use the Kodi Logfile Uploader Add-on install the add-on now before commencing the steps.


1. Enable Debug Mode by using one of the following methods:
If you have been asked to enable component specific logging see Enable component-specific logging section below.


2. Restart Kodi using one of the options in the Kodi Power Menu.
Do not simply disconnect the power. Doing this may prevent saving the changes you made in the Settings page when you enabled Debug Mode.
When you restart, you should see counters displayed in the top left corner of the screen. If you do not see these counters, then debug mode is not enabled.
Restarting has the following effect:
  • Reduce the size of the log by clearing it and starting fresh
  • It captures the startup that can reveal critical information about the installation. eg graphics cards, audio drivers, versions etc


3. It is important that you now replicate the problem while the log is running. Do whatever you did previously when you experienced the problem.
For example...
  • If you are having problems scraping, then run an Update Library
  • If you are having problems with playback, then try playing the problematic video or music file
  • If you cannot install add-ons, then try installing the add-on.


4. The log must now be uploaded to a Pastebin type site using one of the methods in the next section:


3 Uploading Methods

Choose one of these methods to upload the log.

3.1 Add-on Kodi Logfile Uploader

If you are using this method to upload the log, you may run it now. Once you upload the logfile, you must post the provided url into a post on the forum. Without it, we will be unable to locate your logfile.
By default the add-on only uploads the current kodi.log file. If you need to upload the kodi.old.log, ensure the setting is enabled in the add-ons setting page. Once enabled, you will need to upload the current kodi.log, then upload the kodi.old.log
See: Kodi Logfile Uploader Add-on


3.2 File Manager

Log file/File manager access
This page describes another method to access the log file using the Kodi File manager. This method can be used as the fallback option if the Kodi Logfile Uploader is not functioning on your installation. If you are using a desktop type operating system such as Windows, using the Kodi File Manager is not necessary as all files can be accessed through the file browser of the operating system.
Once you have obtained the log, use the Copy and Paste method to upload the log.
See: Kodi Logfile Uploader Add-on


3.3 Copy and Paste

If you are using a desktop operating system, such as Windows, then you can simply navigate to the Debug Log using the File Manager of the operating system.
Once you find the log...
  1. Open it with any text editor and copy the contents of the file.
  2. Paste the contents to a paste site like http://paste.kodi.tv/, and press the Save icon.
  3. For very large logs, you may need to split the log into two or more pastes.
  4. When the screen refreshes with your paste, copy the entire address in the address bar and paste it into a new message in your post.
Logs are located in the following locations:
Operating System File/Folder Path
Android The folder may differ depending on the device:
  • /data/org.xbmc.kodi/cache/temp/kodi.log
  • /sdcard/Android/data/org.xbmc.kodi/files/.kodi/temp/kodi.log
  • /storage/emulated/0/Android/data/org.xbmc.kodi/files/.kodi/temp/kodi.log
CoreELEC /storage/.kodi/temp/kodi.log
iOS/tvOS /private/var/mobile/Library/Preferences/kodi.log
LibreElec /storage/.kodi/temp/kodi.log
Linux $HOME/.kodi/temp/kodi.log
macOS /Users/<username>/Library/Logs/kodi.log
Nvidia Shield (SMB) smb://<nvidiashieldurl>/internal/Android/data/org.xbmc.kodi/files/.kodi/temp/kodi.log
OSMC /home/osmc/.kodi/temp/kodi.log
Windows %APPDATA%\Kodi\kodi.log
Windows Portable <Install location chosen by you>\portable_data\
Windows (UWP) %LOCALAPPDATA%\Packages\XBMCFoundation.Kodi_4n2hpmxwrvr6p\LocalCache\Roaming\Kodi\kodi.log
Special protocol special://logpath (this can be used by scripts)


3.4 iOS Native Sharing

From Kodi v19, accessing the Kodi log file on your iOS device has become a whole lot simpler.

See: iOS native sharing


4 Enable component-specific logging

Only enable this if you have been specifically asked to enable it.

For more extensive logging, several system components can be selected to put in more detailed debug messages in Kodi's log file. Multiple components can be selected.

Enable the setting Enable component-specific logging in Settings > System Settings > Logging.

Select Specify component-specific logging and select the required components.

The following components are available, depending upon your hardware.

GUI name <setextraloglevel> code
The SMB library 32
The libcURL library (HTTP(S), DAV) 64
The FFmpeg libraries 128
JSON-RPC requests 1024
The Audio component 2048
The Airtunes library 4096
The UPnP components 8192
The libCEC library 16384
The Video component 32768
The Webserver component 65536
The Database component 131072
audio/video timing information 262144
Windowing component 524288
PVR component 1048576
EPG component 2097152
Announce Logging 4194304
WS-Discovery component 8388608





Return to top