Official Kodi Wiki - User contributions [en]

Log file/Advanced

2014-12-31T17:22:53Z

Bs27975:

{{mininav| [[Troubleshooting]] | [[HOW-TO:Submit a bug report]] | [[Log file]] }}

:{{bigger|''Not sure what to do, but someone just asked you for a "log file", "debug log", or "xbmc.log"? '''[[Log file/Easy|Click here]].'''''}}

<section being="intro" />At some point during your foray into {{kodi}}, you will likely come up against a problem that isn't made 100% clear from errors in the GUI. This is where the log file comes into play. {{kodi}} writes all sorts of useful stuff to its log, which is why it should be included with every bug/problem report. Don't be afraid of its contents! Often a quick glance through the log will turn up a simple typo or missing file which you can easily fix on your own.<section end="intro" />

{{Log file password warning}}

= Enable debugging = 
If someone asks for a debug log then debugging needs to be enabled. There are three ways to do this:

# Select the enable debug options in the '''[[#GUI settings|GUI settings]]'''
# Use an '''[[#advancedsettings.xml|advancedsettings.xml]]''' file
# Toggle debug logging with a '''[[#Keyboard or remote shortcut|keyboard or remote shortcut]]'''

== GUI settings ==
Most users only need to enable debug logging in the GUI.

In {{highlight|bordered=yes|[[Settings/System#Debugging|Settings -> System -> Debugging]]}} toggle the '''''Enable debug logging''''' setting.

{{#lst:Settings/System|debugging}}

== advancedsettings.xml ==
{{helix note|Some of this might only apply to the future version, Kodi v14 "Helix".}}

You can manually enable debug logging directly using an [[advancedsettings.xml]] file. This is especially useful if {{kodi}} is crashing during start-up and you are unable to turn debugging on via the GUI. The advancedsettings.xml file is simply a plain text document that is saved in the [[userdata folder]] and read when {{kodi}} first starts up. You can use the following examples to enable debug logging:

{{note|Be sure to format this as a '''plain text''' document, and make sure it is titled <code>advancedsettings.xml</code> and make sure the extension is ''just'' <code>.xml</code> and not something like ".xml.txt" or ".xml.doc". }}

=== advancedsettings.xml for normal debugging ===
If you want '''basic debug logging''' then use this. This the same as enabling logging in the GUI without enabling component-specific logging. Start with this one first if you are not sure which mode to use:

<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
</advancedsettings>
</syntaxhighlight>

=== advancedsettings.xml for input devices ===
''Useful as you cannot enable debug logging in the GUI if your input devices don't work.''

If you only want debug logging with verbose components for '''input devices''' (JSON-RPC, CEC, HTTP, for remotes, smart phone remotes, web remotes, etc) then use this:
<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
<debug>
<extralogging>true</extralogging>
<setextraloglevel>64,2048,32768</setextraloglevel>
<showloginfo>true</showloginfo> 
</debug>
</advancedsettings>
</syntaxhighlight>

=== advancedsettings.xml for everything ===
If you want debug logging with '''all verbose components''' enabled use this.

{{note|Normally, you don't want to use this one unless specifically asked for it, as it will create a very hard-to-read debug log.}}

<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
<debug>
<extralogging>true</extralogging>
<setextraloglevel>32,64,128,256,512,1024,2048,4096,8192,16384,32768,65536</setextraloglevel>
<showloginfo>true</showloginfo>
</debug>
</advancedsettings>
</syntaxhighlight>

=== Technical notes ===
{{collapse top}}
Everything except the <code><loglevel></code> tag is actually taken from guisettings.xml, but they can be used in the advancedsettings.xml file as a way to manually enable them.

As one can see from the previous sections, individual component logging is set using the <code><setextraloglevel></code> tag. A complete list of the components and their setting value follows:

{| class="prettytable"
! Component !! setting value
|-
| LOGSAMBA || 32
|-
| LOGCURL || 64
|-
| LOGCMYTH || 128
|-
| LOGFFMPEG || 256
|-
| LOGRTMP || 512
|-
| LOGDBUS || 1024
|-
| LOGJSONRPC || 2048
|-
| LOGAUDIO || 4096
|-
| LOGAIRTUNES || 8192
|-
| LOGUPNP || 16384
|-
| LOGCEC || 32768
|-
| LOGVIDEO || 65536
|}
{{collapse bottom}}

== Keyboard or remote shortcut ==
Since XBMC v12 a keymap.xml file can map a keyboard shortcut or remote control button to toggle debugging using the value <code>toggledebug</code>. For example, <code><l>toggledebug</l></code>. See [https://github.com/xbmc/xbmc/pull/1226 here] and '''[[keymaps]]''' for more information on how to define a keyboard or remote button.

After you have enabled debug logging, please restart {{kodi}} so that the log starts fresh and contains full start-up information.

= So what do I do with this thing? =

Whatever you do, please '''DO NOT''' paste it directly into IRC, a forum post or ticket on the bug tracker. This not only clutters said text, but the log is nearly impossible to read like this. If your log file is too big for the following methods, please restart {{kodi}} to start a clean log file file, recreate the problem in as few steps as possible, then stop {{kodi}} and try again. If it is still too large, try disabling features such as "scan library on startup", which spam's a lot of info to the log (unless of course this is where the problem is).

:{{note|{{big|'''Always include the whole debug log.''' Don't assume which portions of the log are relevant or not. }} }}

:{{note|Make sure you have enabled "debug logging". The normal log file, without debugging enabled, is almost always useless when it comes to troubleshooting!}}

=== In the forums and IRC ===
Use a pastesite such as http://xbmclogs.com , http://pastebin.com , or http://pastebin.ca on when posting on the forums. Simply visit one of these sites, paste or upload your log and hit submit. After a few seconds you'll have a nice short URL to paste in your post. Be sure to select an appropriate time to keep your paste around when submitting!

=== On the bug tracker ===
Just upload the log to your ticket as an attachment. '''DO NOT''' archive (zip,rar,tar,etc) it in anyway! Trac will let us view it right on the site without downloading.

=== Watch it locally, perhaps spotting errors you can fix or report ===
Using 'tail -f {location}' you can watch the log from a cmd/console (better with 2 displays), or better, via ssh (won't distract the gui).

= Log files =
* '''kodi.log''' or '''xbmc.log''' - This is the log file of most recent (or currently running) {{kodi}} session.
* '''kodi.old.log''' or '''xbmc.old.log''' - This is the log file from the last XBMC session. If {{kodi}} crashes AND you have restarted it before viewing the log, this is the one you want.

=== Location ===
''kodi.log'' {{small|(or ''xbmc.log'')}} and ''kodi.old.log'' {{small|(or ''xbmc.old.log'')}} are located here, depending on your platform:
{|class="prettytable"
! style="background: lightgrey; width: 150px" | '''Operative system'''
! style="background: lightgrey; width: 700px" | '''File/Folder Paths'''
|-
| colspan=2 | {{Helix note|Directories and files named <code>'''xbmc'''</code> will be renamed to <code>'''kodi'''</code> as part of the project rename starting in v14.}}
|-
|'''Android''' || {{note|The first folder might be different on various devices:}} <code>''<data/sdcard/Android>''/data/org.xbmc.xbmc/cache/temp/xbmc.log</code>
or <code>/sdcard/Android/data/org.xbmc.xbmc/files/.xbmc/temp/xbmc.log</code>
|-
|'''iOS/ATV2''' || <code>/private/var/mobile/Library/Preferences/xbmc.log</code>
|-
|'''Linux''' || <code>$HOME/.kodi/temp/kodi.log</code> ''(or <code>$HOME/.xbmc/temp/xbmc.log)''</code>
|-
|'''Mac OS X''' || <code>/Users/''<username>''/Library/Logs/xbmc.log</code>
|-
|'''Windows''' || <code>%APPDATA%\XBMC\xbmc.log</code>
|-
| '''[[Special protocol]]''' || <code>special://logpath (this can be used by scripts)</code>
|}

See '''[[Log file/File manager access]]''' for how to copy the debug log file using the [[File manager]].

= Easy ways to get and post the log file =
=== Debug log add-on ===
{{main|Log file/Easy}}
You can use the '''[[Add-on:XBMC Log Uploader|XBMC Log Uploader]]''' to make the process of getting your debug log easier.

=== Automatic pastebin log in Linux via command line ===
You can generate a debug.log [http://en.wikipedia.org/wiki/Pastebin Pastebin] link automatically quickly to post anywhere that requires a debug.log.
<br />
:'''''See also:''''' [[SSH|Accessing XBMC via SSH]] e.g. Putty

:{{note|Don't forget to [[#Enable debugging|enable debugging]]}}
<pre>sudo apt-get install pastebinit -y

cat $HOME/.kodi/temp/kodi.log | pastebinit</pre>
''(or cat $HOME/.xbmc/temp/xbmc.log | pastebinit)''

Submit the link you get in any forums discussion where you post about '''any''' problem.

= Technical details about log files =
{{Editor note|This section might be outdated now that {{kodi}} has component-level logging. Some of it should still be true, but just keep in mind that this section hasn't been totally cleaned up for v13 and v14 yet.}}

=== Layout ===
Each event is logged to one line of the {{kodi}} log file which is formatted as follows...
<pre>[TIMESTAMP] T:[THREADID] M:[FREEMEM] [LEVEL]: [MESSAGE]</pre>
* '''TIMESTAMP''' - The wall time at which the event occurred.
* '''THREADID''' - The thread identification number of the thread in which the event occurred.
* '''FREEMEM''' - The amount of memory (in bytes) free at the time of the event.
* '''LEVEL''' - The severity of the event.
* '''MESSAGE''' - A brief description and/or important information about the event.

=== Log levels ===
There are two different types levels when talking about the {{kodi}} log. The first is the severity of event that has occurred. The second controls which severity levels are actually printed out to the log.

;Severity levels
In order from least to most severe...
* '''DEBUG''' - In depth information about the status of {{kodi}}. This information can pretty much only be deciphered by a developer or long time {{kodi}} power user.
* '''INFO''' - Something has happened. It's not a problem, we just thought you might want to know. Fairly excessive output that most people won't care about.
* '''NOTICE''' - Similar to INFO but the average Joe might want to know about these events. This level and above are logged by default.
* '''WARNING''' - Something potentially bad has happened. If {{kodi}} did something you didn't expect, this is probably why. Watch for errors to follow.
* '''ERROR''' - This event is bad. Something has failed. You likely noticed problems with the application be it skin artifacts, failure of playback a crash, etc.
* '''FATAL''' - We're screwed. {{kodi}} is about to crash.

;Log file control levels
In order from least to most information provided...
* '''None''' - No logging will occur. ''xbmc.log'' will likely be created but should remain empty.
* '''Normal''' - The default loglevel. Events with a severity of NOTICE or greater will be logged.
* '''Debug''' - All events are logged. This level (or higher) is all that you should bother someone else with.
* '''Debug w/ Visuals''' - Same printed log as ''Debug'', but free memory and CPU usage are rendered on the screen as well.
* '''SMB Debug''' - Same as ''Debug w/ Visuals'' with the addition of ridiculous amounts of Samba debugging info. Use this only if asked.


= See also =
* [[HOW-TO:Submit a bug report]]
* [[Bug tracker]]
* [[Troubleshooting]]

{{Gotham updated}}

[[Category:Development]]
[[Category:Trac]]
[[Category:Manual]]
[[Category:Troubleshooting]]
[[Category:Advanced topics]]

Help:Editing

2014-12-31T17:17:21Z

Bs27975: Created page with "Reference https://www.mediawiki.org/wiki/Help:Editing"

Reference https://www.mediawiki.org/wiki/Help:Editing

Log file/Advanced

2014-12-31T17:13:07Z

Bs27975:

{{mininav| [[Troubleshooting]] | [[HOW-TO:Submit a bug report]] | [[Log file]] }}

:{{bigger|''Not sure what to do, but someone just asked you for a "log file", "debug log", or "xbmc.log"? '''[[Log file/Easy|Click here]].'''''}}

<section being="intro" />At some point during your foray into {{kodi}}, you will likely come up against a problem that isn't made 100% clear from errors in the GUI. This is where the log file comes into play. {{kodi}} writes all sorts of useful stuff to its log, which is why it should be included with every bug/problem report. Don't be afraid of its contents! Often a quick glance through the log will turn up a simple typo or missing file which you can easily fix on your own.<section end="intro" />

{{Log file password warning}}

= Enable debugging = 
If someone asks for a debug log then debugging needs to be enabled. There are three ways to do this:

# Select the enable debug options in the '''[[#GUI settings|GUI settings]]'''
# Use an '''[[#advancedsettings.xml|advancedsettings.xml]]''' file
# Toggle debug logging with a '''[[#Keyboard or remote shortcut|keyboard or remote shortcut]]'''

== GUI settings ==
Most users only need to enable debug logging in the GUI.

In {{highlight|bordered=yes|[[Settings/System#Debugging|Settings -> System -> Debugging]]}} toggle the '''''Enable debug logging''''' setting.

{{#lst:Settings/System|debugging}}

== advancedsettings.xml ==
{{helix note|Some of this might only apply to the future version, Kodi v14 "Helix".}}

You can manually enable debug logging directly using an [[advancedsettings.xml]] file. This is especially useful if {{kodi}} is crashing during start-up and you are unable to turn debugging on via the GUI. The advancedsettings.xml file is simply a plain text document that is saved in the [[userdata folder]] and read when {{kodi}} first starts up. You can use the following examples to enable debug logging:

{{note|Be sure to format this as a '''plain text''' document, and make sure it is titled <code>advancedsettings.xml</code> and make sure the extension is ''just'' <code>.xml</code> and not something like ".xml.txt" or ".xml.doc". }}

=== advancedsettings.xml for normal debugging ===
If you want '''basic debug logging''' then use this. This the same as enabling logging in the GUI without enabling component-specific logging. Start with this one first if you are not sure which mode to use:

<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
</advancedsettings>
</syntaxhighlight>

=== advancedsettings.xml for input devices ===
''Useful as you cannot enable debug logging in the GUI if your input devices don't work.''

If you only want debug logging with verbose components for '''input devices''' (JSON-RPC, CEC, HTTP, for remotes, smart phone remotes, web remotes, etc) then use this:
<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
<debug>
<extralogging>true</extralogging>
<setextraloglevel>64,2048,32768</setextraloglevel>
<showloginfo>true</showloginfo> 
</debug>
</advancedsettings>
</syntaxhighlight>

=== advancedsettings.xml for everything ===
If you want debug logging with '''all verbose components''' enabled use this.

{{note|Normally, you don't want to use this one unless specifically asked for it, as it will create a very hard-to-read debug log.}}

<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
<debug>
<extralogging>true</extralogging>
<setextraloglevel>32,64,128,256,512,1024,2048,4096,8192,16384,32768,65536</setextraloglevel>
<showloginfo>true</showloginfo>
</debug>
</advancedsettings>
</syntaxhighlight>

=== Technical notes ===
{{collapse top}}
Everything except the <code><loglevel></code> tag is actually taken from guisettings.xml, but they can be used in the advancedsettings.xml file as a way to manually enable them.

As one can see from the previous sections, individual component logging is set using the <code><setextraloglevel></code> tag. A complete list of the components and their setting value follows:

{| class="prettytable"
! Component !! setting value
|-
| LOGSAMBA || 32
|-
| LOGCURL || 64
|-
| LOGCMYTH || 128
|-
| LOGFFMPEG || 256
|-
| LOGRTMP || 512
|-
| LOGDBUS || 1024
|-
| LOGJSONRPC || 2048
|-
| LOGAUDIO || 4096
|-
| LOGAIRTUNES || 8192
|-
| LOGUPNP || 16384
|-
| LOGCEC || 32768
|-
| LOGVIDEO || 65536
|}
{{collapse bottom}}

== Keyboard or remote shortcut ==
Since XBMC v12 a keymap.xml file can map a keyboard shortcut or remote control button to toggle debugging using the value <code>toggledebug</code>. For example, <code><l>toggledebug</l></code>. See [https://github.com/xbmc/xbmc/pull/1226 here] and '''[[keymaps]]''' for more information on how to define a keyboard or remote button.

After you have enabled debug logging, please restart {{kodi}} so that the log starts fresh and contains full start-up information.

= So what do I do with this thing? =

Whatever you do, please '''DO NOT''' paste it directly into IRC, a forum post or ticket on the bug tracker. This not only clutters said text, but the log is nearly impossible to read like this. If your log file is too big for the following methods, please restart {{kodi}} to start a clean log file file, recreate the problem in as few steps as possible, then stop {{kodi}} and try again. If it is still too large, try disabling features such as "scan library on startup", which spam's a lot of info to the log (unless of course this is where the problem is).

:{{note|{{big|'''Always include the whole debug log.''' Don't assume which portions of the log are relevant or not. }} }}

:{{note|Make sure you have enabled "debug logging". The normal log file, without debugging enabled, is almost always useless when it comes to troubleshooting!}}

=== In the forums and IRC ===
Use a pastesite such as http://xbmclogs.com , http://pastebin.com , or http://pastebin.ca on when posting on the forums. Simply visit one of these sites, paste or upload your log and hit submit. After a few seconds you'll have a nice short URL to paste in your post. Be sure to select an appropriate time to keep your paste around when submitting!

=== On the bug tracker ===
Just upload the log to your ticket as an attachment. '''DO NOT''' archive (zip,rar,tar,etc) it in anyway! Trac will let us view it right on the site without downloading.

=== Watch it locally, perhaps spotting errors you can fix or report ===
Using 'tail -f {location}' you can watch the log from a cmd/console (better with 2 displays), or better, via ssh (won't distract the gui).

= Log files =
* '''kodi.log''' or '''xbmc.log''' - This is the log file of most recent (or currently running) {{kodi}} session.
* '''kodi.old.log''' or '''xbmc.old.log''' - This is the log file from the last XBMC session. If {{kodi}} crashes AND you have restarted it before viewing the log, this is the one you want.

=== Location ===
''kodi.log'' {{small|(or ''xbmc.log'')}} and ''kodi.old.log'' {{small|(or ''xbmc.old.log'')}} are located here, depending on your platform:
{|class="prettytable"
! style="background: lightgrey; width: 150px" | '''Operative system'''
! style="background: lightgrey; width: 700px" | '''File/Folder Paths'''
|-
| colspan=2 | {{Helix note|Directories and files named <code>'''xbmc'''</code> will be renamed to <code>'''kodi'''</code> as part of the project rename starting in v14.}}
|-
|'''Android''' || {{note|The first folder might be different on various devices:}} <code>''<data/sdcard/Android>''/data/org.xbmc.xbmc/cache/temp/xbmc.log</code>
or <code>/sdcard/Android/data/org.xbmc.xbmc/files/.xbmc/temp/xbmc.log</code>
|-
|'''iOS/ATV2''' || <code>/private/var/mobile/Library/Preferences/xbmc.log</code>
|-
|'''Linux''' || <code>$HOME/.kodi/temp/kodi.log</code> ''(or <code>$HOME/.xbmc/temp/xbmc.log)''</code>
|-
|'''Mac OS X''' || <code>/Users/''<username>''/Library/Logs/xbmc.log</code>
|-
|'''Windows''' || <code>%APPDATA%\XBMC\xbmc.log</code>
|-
| '''[[Special protocol]]''' || <code>special://logpath (this can be used by scripts)</code>
|}

See '''[[Log file/File manager access]]''' for how to copy the debug log file using the [[File manager]].

= Easy ways to get and post the log file =
=== Debug log add-on ===
{{main|Log file/Easy}}
You can use the '''[[Add-on:XBMC Log Uploader|XBMC Log Uploader]]''' to make the process of getting your debug log easier.

=== Automatic pastebin log in Linux via command line ===
You can generate a debug.log [http://en.wikipedia.org/wiki/Pastebin Pastebin] link automatically quickly to post anywhere that requires a debug.log.
<br />
:'''''See also:''''' [[SSH|Accessing XBMC via SSH]] e.g. Putty

:{{note|Don't forget to [[#Enable debugging|enable debugging]]}}
<pre>sudo apt-get install pastebinit -y

cat $HOME/.kodi/temp/kodi.log | pastebinit</pre>
''(or cat $HOME/.xbmc/temp/xbmc.log | pastebinit)''

Submit the link you get in any forums discussion where you post about '''any''' problem.

= Technical details about log files =
{{Editor note|This section might be outdated now that {{kodi}} has component-level logging. Some of it should still be true, but just keep in mind that this section hasn't been totally cleaned up for v13 and v14 yet.}}
{{collapse top}}
=== Layout ===
Each event is logged to one line of the {{kodi}} log file which is formatted as follows...
<pre>[TIMESTAMP] T:[THREADID] M:[FREEMEM] [LEVEL]: [MESSAGE]</pre>
* '''TIMESTAMP''' - The wall time at which the event occurred.
* '''THREADID''' - The thread identification number of the thread in which the event occurred.
* '''FREEMEM''' - The amount of memory (in bytes) free at the time of the event.
* '''LEVEL''' - The severity of the event.
* '''MESSAGE''' - A brief description and/or important information about the event.

=== Log levels ===
There are two different types levels when talking about the {{kodi}} log. The first is the severity of event that has occurred. The second controls which severity levels are actually printed out to the log.

;Severity levels
In order from least to most severe...
* '''DEBUG''' - In depth information about the status of {{kodi}}. This information can pretty much only be deciphered by a developer or long time {{kodi}} power user.
* '''INFO''' - Something has happened. It's not a problem, we just thought you might want to know. Fairly excessive output that most people won't care about.
* '''NOTICE''' - Similar to INFO but the average Joe might want to know about these events. This level and above are logged by default.
* '''WARNING''' - Something potentially bad has happened. If {{kodi}} did something you didn't expect, this is probably why. Watch for errors to follow.
* '''ERROR''' - This event is bad. Something has failed. You likely noticed problems with the application be it skin artifacts, failure of playback a crash, etc.
* '''FATAL''' - We're screwed. {{kodi}} is about to crash.

;Log file control levels
In order from least to most information provided...
* '''None''' - No logging will occur. ''xbmc.log'' will likely be created but should remain empty.
* '''Normal''' - The default loglevel. Events with a severity of NOTICE or greater will be logged.
* '''Debug''' - All events are logged. This level (or higher) is all that you should bother someone else with.
* '''Debug w/ Visuals''' - Same printed log as ''Debug'', but free memory and CPU usage are rendered on the screen as well.
* '''SMB Debug''' - Same as ''Debug w/ Visuals'' with the addition of ridiculous amounts of Samba debugging info. Use this only if asked.
{{collapse bottom}}

= See also =
* [[HOW-TO:Submit a bug report]]
* [[Bug tracker]]
* [[Troubleshooting]]

{{Gotham updated}}

[[Category:Development]]
[[Category:Trac]]
[[Category:Manual]]
[[Category:Troubleshooting]]
[[Category:Advanced topics]]

Log file/Advanced

2014-12-31T17:06:54Z

Bs27975: Caught a few xbmc -> kodi changes. There are more, but I have no direct experience with those platforms. Also ... my experience was showloginfo -> false in advancesyssettings before screen updates actually got turned off. Added notation for tail -f.

{{mininav| [[Troubleshooting]] | [[HOW-TO:Submit a bug report]] | [[Log file]] }}

:{{bigger|''Not sure what to do, but someone just asked you for a "log file", "debug log", or "xbmc.log"? '''[[Log file/Easy|Click here]].'''''}}

<section being="intro" />At some point during your foray into {{kodi}}, you will likely come up against a problem that isn't made 100% clear from errors in the GUI. This is where the log file comes into play. {{kodi}} writes all sorts of useful stuff to its log, which is why it should be included with every bug/problem report. Don't be afraid of its contents! Often a quick glance through the log will turn up a simple typo or missing file which you can easily fix on your own.<section end="intro" />

{{Log file password warning}}

= Enable debugging = 
If someone asks for a debug log then debugging needs to be enabled. There are three ways to do this:

# Select the enable debug options in the '''[[#GUI settings|GUI settings]]'''
# Use an '''[[#advancedsettings.xml|advancedsettings.xml]]''' file
# Toggle debug logging with a '''[[#Keyboard or remote shortcut|keyboard or remote shortcut]]'''

== GUI settings ==
Most users only need to enable debug logging in the GUI.

In {{highlight|bordered=yes|[[Settings/System#Debugging|Settings -> System -> Debugging]]}} toggle the '''''Enable debug logging''''' setting.

{{#lst:Settings/System|debugging}}

== advancedsettings.xml ==
{{helix note|Some of this might only apply to the future version, Kodi v14 "Helix".}}

You can manually enable debug logging directly using an [[advancedsettings.xml]] file. This is especially useful if {{kodi}} is crashing during start-up and you are unable to turn debugging on via the GUI. The advancedsettings.xml file is simply a plain text document that is saved in the [[userdata folder]] and read when {{kodi}} first starts up. You can use the following examples to enable debug logging:

{{note|Be sure to format this as a '''plain text''' document, and make sure it is titled <code>advancedsettings.xml</code> and make sure the extension is ''just'' <code>.xml</code> and not something like ".xml.txt" or ".xml.doc". }}

=== advancedsettings.xml for normal debugging ===
If you want '''basic debug logging''' then use this. This the same as enabling logging in the GUI without enabling component-specific logging. Start with this one first if you are not sure which mode to use:

<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
</advancedsettings>
</syntaxhighlight>

=== advancedsettings.xml for input devices ===
''Useful as you cannot enable debug logging in the GUI if your input devices don't work.''

If you only want debug logging with verbose components for '''input devices''' (JSON-RPC, CEC, HTTP, for remotes, smart phone remotes, web remotes, etc) then use this:
<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
<debug>
<extralogging>true</extralogging>
<setextraloglevel>64,2048,32768</setextraloglevel>
<showloginfo>true</showloginfo> 
</debug>
</advancedsettings>
</syntaxhighlight>

=== advancedsettings.xml for everything ===
If you want debug logging with '''all verbose components''' enabled use this.

{{note|Normally, you don't want to use this one unless specifically asked for it, as it will create a very hard-to-read debug log.}}

<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
<debug>
<extralogging>true</extralogging>
<setextraloglevel>32,64,128,256,512,1024,2048,4096,8192,16384,32768,65536</setextraloglevel>
<showloginfo>true</showloginfo>
</debug>
</advancedsettings>
</syntaxhighlight>

=== Technical notes ===
{{collapse top}}
Everything except the <code><loglevel></code> tag is actually taken from guisettings.xml, but they can be used in the advancedsettings.xml file as a way to manually enable them.

As one can see from the previous sections, individual component logging is set using the <code><setextraloglevel></code> tag. A complete list of the components and their setting value follows:

{| class="prettytable"
! Component !! setting value
|-
| LOGSAMBA || 32
|-
| LOGCURL || 64
|-
| LOGCMYTH || 128
|-
| LOGFFMPEG || 256
|-
| LOGRTMP || 512
|-
| LOGDBUS || 1024
|-
| LOGJSONRPC || 2048
|-
| LOGAUDIO || 4096
|-
| LOGAIRTUNES || 8192
|-
| LOGUPNP || 16384
|-
| LOGCEC || 32768
|-
| LOGVIDEO || 65536
|}
{{collapse bottom}}

== Keyboard or remote shortcut ==
Since XBMC v12 a keymap.xml file can map a keyboard shortcut or remote control button to toggle debugging using the value <code>toggledebug</code>. For example, <code><l>toggledebug</l></code>. See [https://github.com/xbmc/xbmc/pull/1226 here] and '''[[keymaps]]''' for more information on how to define a keyboard or remote button.

After you have enabled debug logging, please restart {{kodi}} so that the log starts fresh and contains full start-up information.

= So what do I do with this thing? =

Whatever you do, please '''DO NOT''' paste it directly into IRC, a forum post or ticket on the bug tracker. This not only clutters said text, but the log is nearly impossible to read like this. If your log file is too big for the following methods, please restart {{kodi}} to start a clean log file file, recreate the problem in as few steps as possible, then stop {{kodi}} and try again. If it is still too large, try disabling features such as "scan library on startup", which spam's a lot of info to the log (unless of course this is where the problem is).

:{{note|{{big|'''Always include the whole debug log.''' Don't assume which portions of the log are relevant or not. }} }}

:{{note|Make sure you have enabled "debug logging". The normal log file, without debugging enabled, is almost always useless when it comes to troubleshooting!}}

=== In the forums and IRC ===
Use a pastesite such as http://xbmclogs.com , http://pastebin.com , or http://pastebin.ca on when posting on the forums. Simply visit one of these sites, paste or upload your log and hit submit. After a few seconds you'll have a nice short URL to paste in your post. Be sure to select an appropriate time to keep your paste around when submitting!

=== On the bug tracker ===
Just upload the log to your ticket as an attachment. '''DO NOT''' archive (zip,rar,tar,etc) it in anyway! Trac will let us view it right on the site without downloading.

=== Watch it locally, perhaps spotting errors you can fix or report ===
Using <pre>tail -f {location}</pre> you can watch the log from a cmd/console (better with 2 displays), or better, via ssh (won't distract the gui).

= Log files =
* '''kodi.log''' or '''xbmc.log''' - This is the log file of most recent (or currently running) {{kodi}} session.
* '''kodi.old.log''' or '''xbmc.old.log''' - This is the log file from the last XBMC session. If {{kodi}} crashes AND you have restarted it before viewing the log, this is the one you want.

=== Location ===
''kodi.log'' {{small|(or ''xbmc.log'')}} and ''kodi.old.log'' {{small|(or ''xbmc.old.log'')}} are located here, depending on your platform:
{|class="prettytable"
! style="background: lightgrey; width: 150px" | '''Operative system'''
! style="background: lightgrey; width: 700px" | '''File/Folder Paths'''
|-
| colspan=2 | {{Helix note|Directories and files named <code>'''xbmc'''</code> will be renamed to <code>'''kodi'''</code> as part of the project rename starting in v14.}}
|-
|'''Android''' || {{note|The first folder might be different on various devices:}} <code>''<data/sdcard/Android>''/data/org.xbmc.xbmc/cache/temp/xbmc.log</code>
or <code>/sdcard/Android/data/org.xbmc.xbmc/files/.xbmc/temp/xbmc.log</code>
|-
|'''iOS/ATV2''' || <code>/private/var/mobile/Library/Preferences/xbmc.log</code>
|-
|'''Linux''' || <code>$HOME/.kodi/temp/kodi.log</code> ''(or <code>$HOME/.xbmc/temp/xbmc.log)''</code>
|-
|'''Mac OS X''' || <code>/Users/''<username>''/Library/Logs/xbmc.log</code>
|-
|'''Windows''' || <code>%APPDATA%\XBMC\xbmc.log</code>
|-
| '''[[Special protocol]]''' || <code>special://logpath (this can be used by scripts)</code>
|}

See '''[[Log file/File manager access]]''' for how to copy the debug log file using the [[File manager]].

= Easy ways to get and post the log file =
=== Debug log add-on ===
{{main|Log file/Easy}}
You can use the '''[[Add-on:XBMC Log Uploader|XBMC Log Uploader]]''' to make the process of getting your debug log easier.

=== Automatic pastebin log in Linux via command line ===
You can generate a debug.log [http://en.wikipedia.org/wiki/Pastebin Pastebin] link automatically quickly to post anywhere that requires a debug.log.
<br />
:'''''See also:''''' [[SSH|Accessing XBMC via SSH]] e.g. Putty

:{{note|Don't forget to [[#Enable debugging|enable debugging]]}}
<pre>sudo apt-get install pastebinit -y

cat $HOME/.kodi/temp/kodi.log | pastebinit</pre>
''(or cat $HOME/.xbmc/temp/xbmc.log | pastebinit)''

Submit the link you get in any forums discussion where you post about '''any''' problem.

= Technical details about log files =
{{Editor note|This section might be outdated now that {{kodi}} has component-level logging. Some of it should still be true, but just keep in mind that this section hasn't been totally cleaned up for v13 and v14 yet.}}
{{collapse top}}
=== Layout ===
Each event is logged to one line of the {{kodi}} log file which is formatted as follows...
<pre>[TIMESTAMP] T:[THREADID] M:[FREEMEM] [LEVEL]: [MESSAGE]</pre>
* '''TIMESTAMP''' - The wall time at which the event occurred.
* '''THREADID''' - The thread identification number of the thread in which the event occurred.
* '''FREEMEM''' - The amount of memory (in bytes) free at the time of the event.
* '''LEVEL''' - The severity of the event.
* '''MESSAGE''' - A brief description and/or important information about the event.

=== Log levels ===
There are two different types levels when talking about the {{kodi}} log. The first is the severity of event that has occurred. The second controls which severity levels are actually printed out to the log.

;Severity levels
In order from least to most severe...
* '''DEBUG''' - In depth information about the status of {{kodi}}. This information can pretty much only be deciphered by a developer or long time {{kodi}} power user.
* '''INFO''' - Something has happened. It's not a problem, we just thought you might want to know. Fairly excessive output that most people won't care about.
* '''NOTICE''' - Similar to INFO but the average Joe might want to know about these events. This level and above are logged by default.
* '''WARNING''' - Something potentially bad has happened. If {{kodi}} did something you didn't expect, this is probably why. Watch for errors to follow.
* '''ERROR''' - This event is bad. Something has failed. You likely noticed problems with the application be it skin artifacts, failure of playback a crash, etc.
* '''FATAL''' - We're screwed. {{kodi}} is about to crash.

;Log file control levels
In order from least to most information provided...
* '''None''' - No logging will occur. ''xbmc.log'' will likely be created but should remain empty.
* '''Normal''' - The default loglevel. Events with a severity of NOTICE or greater will be logged.
* '''Debug''' - All events are logged. This level (or higher) is all that you should bother someone else with.
* '''Debug w/ Visuals''' - Same printed log as ''Debug'', but free memory and CPU usage are rendered on the screen as well.
* '''SMB Debug''' - Same as ''Debug w/ Visuals'' with the addition of ridiculous amounts of Samba debugging info. Use this only if asked.
{{collapse bottom}}

= See also =
* [[HOW-TO:Submit a bug report]]
* [[Bug tracker]]
* [[Troubleshooting]]

{{Gotham updated}}

[[Category:Development]]
[[Category:Trac]]
[[Category:Manual]]
[[Category:Troubleshooting]]
[[Category:Advanced topics]]

Log file/Advanced

2014-12-31T16:51:01Z

Bs27975:

{{mininav| [[Troubleshooting]] | [[HOW-TO:Submit a bug report]] | [[Log file]] }}

:{{bigger|''Not sure what to do, but someone just asked you for a "log file", "debug log", or "xbmc.log"? '''[[Log file/Easy|Click here]].'''''}}

<section being="intro" />At some point during your foray into {{kodi}}, you will likely come up against a problem that isn't made 100% clear from errors in the GUI. This is where the log file comes into play. {{kodi}} writes all sorts of useful stuff to its log, which is why it should be included with every bug/problem report. Don't be afraid of its contents! Often a quick glance through the log will turn up a simple typo or missing file which you can easily fix on your own.<section end="intro" />

{{Log file password warning}}

= Enable debugging = 
If someone asks for a debug log then debugging needs to be enabled. There are three ways to do this:

# Select the enable debug options in the '''[[#GUI settings|GUI settings]]'''
# Use an '''[[#advancedsettings.xml|advancedsettings.xml]]''' file
# Toggle debug logging with a '''[[#Keyboard or remote shortcut|keyboard or remote shortcut]]'''

== GUI settings ==
Most users only need to enable debug logging in the GUI.

In {{highlight|bordered=yes|[[Settings/System#Debugging|Settings -> System -> Debugging]]}} toggle the '''''Enable debug logging''''' setting.

{{#lst:Settings/System|debugging}}

== advancedsettings.xml ==
{{helix note|Some of this might only apply to the future version, Kodi v14 "Helix".}}

You can manually enable debug logging directly using an [[advancedsettings.xml]] file. This is especially useful if {{kodi}} is crashing during start-up and you are unable to turn debugging on via the GUI. The advancedsettings.xml file is simply a plain text document that is saved in the [[userdata folder]] and read when {{kodi}} first starts up. You can use the following examples to enable debug logging:

{{note|Be sure to format this as a '''plain text''' document, and make sure it is titled <code>advancedsettings.xml</code> and make sure the extension is ''just'' <code>.xml</code> and not something like ".xml.txt" or ".xml.doc". }}

=== advancedsettings.xml for normal debugging ===
If you want '''basic debug logging''' then use this. This the same as enabling logging in the GUI without enabling component-specific logging. Start with this one first if you are not sure which mode to use:

<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
</advancedsettings>
</syntaxhighlight>

=== advancedsettings.xml for input devices ===
''Useful as you cannot enable debug logging in the GUI if your input devices don't work.''

If you only want debug logging with verbose components for '''input devices''' (JSON-RPC, CEC, HTTP, for remotes, smart phone remotes, web remotes, etc) then use this:
<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
<debug>
<extralogging>true</extralogging>
<setextraloglevel>64,2048,32768</setextraloglevel>
<showloginfo>true</showloginfo> 
</debug>
</advancedsettings>
</syntaxhighlight>

=== advancedsettings.xml for everything ===
If you want debug logging with '''all verbose components''' enabled use this.

{{note|Normally, you don't want to use this one unless specifically asked for it, as it will create a very hard-to-read debug log.}}

<syntaxhighlight lang="xml">
<advancedsettings>
<loglevel>2</loglevel> 
<debug>
<extralogging>true</extralogging>
<setextraloglevel>32,64,128,256,512,1024,2048,4096,8192,16384,32768,65536</setextraloglevel>
<showloginfo>true</showloginfo>
</debug>
</advancedsettings>
</syntaxhighlight>

=== Technical notes ===
{{collapse top}}
Everything except the <code><loglevel></code> tag is actually taken from guisettings.xml, but they can be used in the advancedsettings.xml file as a way to manually enable them.

As one can see from the previous sections, individual component logging is set using the <code><setextraloglevel></code> tag. A complete list of the components and their setting value follows:

{| class="prettytable"
! Component !! setting value
|-
| LOGSAMBA || 32
|-
| LOGCURL || 64
|-
| LOGCMYTH || 128
|-
| LOGFFMPEG || 256
|-
| LOGRTMP || 512
|-
| LOGDBUS || 1024
|-
| LOGJSONRPC || 2048
|-
| LOGAUDIO || 4096
|-
| LOGAIRTUNES || 8192
|-
| LOGUPNP || 16384
|-
| LOGCEC || 32768
|-
| LOGVIDEO || 65536
|}
{{collapse bottom}}

== Keyboard or remote shortcut ==
Since XBMC v12 a keymap.xml file can map a keyboard shortcut or remote control button to toggle debugging using the value <code>toggledebug</code>. For example, <code><l>toggledebug</l></code>. See [https://github.com/xbmc/xbmc/pull/1226 here] and '''[[keymaps]]''' for more information on how to define a keyboard or remote button.

After you have enabled debug logging, please restart {{kodi}} so that the log starts fresh and contains full start-up information.

= So what do I do with this thing? =

Whatever you do, please '''DO NOT''' paste it directly into IRC, a forum post or ticket on the bug tracker. This not only clutters said text, but the log is nearly impossible to read like this. If your log file is too big for the following methods, please restart {{kodi}} to start a clean log file file, recreate the problem in as few steps as possible, then stop {{kodi}} and try again. If it is still too large, try disabling features such as "scan library on startup", which spam's a lot of info to the log (unless of course this is where the problem is).

:{{note|{{big|'''Always include the whole debug log.''' Don't assume which portions of the log are relevant or not. }} }}

:{{note|Make sure you have enabled "debug logging". The normal log file, without debugging enabled, is almost always useless when it comes to troubleshooting!}}

=== In the forums and IRC ===
Use a pastesite such as http://xbmclogs.com , http://pastebin.com , or http://pastebin.ca on when posting on the forums. Simply visit one of these sites, paste or upload your log and hit submit. After a few seconds you'll have a nice short URL to paste in your post. Be sure to select an appropriate time to keep your paste around when submitting!

=== On the bug tracker ===
Just upload the log to your ticket as an attachment. '''DO NOT''' archive (zip,rar,tar,etc) it in anyway! Trac will let us view it right on the site without downloading.

= Log files =
* '''kodi.log''' or '''xbmc.log''' - This is the log file of most recent (or currently running) {{kodi}} session.
* '''kodi.old.log''' or '''xbmc.old.log''' - This is the log file from the last XBMC session. If {{kodi}} crashes AND you have restarted it before viewing the log, this is the one you want.

=== Location ===
''kodi.log'' {{small|(or ''xbmc.log'')}} and ''kodi.old.log'' {{small|(or ''xbmc.old.log'')}} are located here, depending on your platform:
{|class="prettytable"
! style="background: lightgrey; width: 150px" | '''Operative system'''
! style="background: lightgrey; width: 700px" | '''File/Folder Paths'''
|-
| colspan=2 | {{Helix note|Directories and files named <code>'''xbmc'''</code> will be renamed to <code>'''kodi'''</code> as part of the project rename starting in v14.}}
|-
|'''Android''' || {{note|The first folder might be different on various devices:}} <code>''<data/sdcard/Android>''/data/org.xbmc.xbmc/cache/temp/xbmc.log</code>
or <code>/sdcard/Android/data/org.xbmc.xbmc/files/.xbmc/temp/xbmc.log</code>
|-
|'''iOS/ATV2''' || <code>/private/var/mobile/Library/Preferences/xbmc.log</code>
|-
|'''Linux''' || <code>$HOME/.kodi/temp/kodi.log</code> ''or <code>$HOME/.xbmc/temp/xbmc.log''</code>
|-
|'''Mac OS X''' || <code>/Users/''<username>''/Library/Logs/xbmc.log</code>
|-
|'''Windows''' || <code>%APPDATA%\XBMC\xbmc.log</code>
|-
| '''[[Special protocol]]''' || <code>special://logpath (this can be used by scripts)</code>
|}

See '''[[Log file/File manager access]]''' for how to copy the debug log file using the [[File manager]].

= Easy ways to get and post the log file =
=== Debug log add-on ===
{{main|Log file/Easy}}
You can use the '''[[Add-on:XBMC Log Uploader|XBMC Log Uploader]]''' to make the process of getting your debug log easier.

=== Automatic pastebin log in Linux via command line ===
You can generate a debug.log [http://en.wikipedia.org/wiki/Pastebin Pastebin] link automatically quickly to post anywhere that requires a debug.log.
<br />
:'''''See also:''''' [[SSH|Accessing XBMC via SSH]] e.g. Putty

:{{note|Don't forget to [[#Enable debugging|enable debugging]]}}
<pre>sudo apt-get install pastebinit -y

cat $HOME/.kodi/temp/kodi.log | pastebinit
''(or cat $HOME/.xbmc/temp/xbmc.log | pastebinit)''</pre>

Submit the link you get in any forums discussion where you post about '''any''' problem.

= Technical details about log files =
{{Editor note|This section might be outdated now that {{kodi}} has component-level logging. Some of it should still be true, but just keep in mind that this section hasn't been totally cleaned up for v13 and v14 yet.}}
{{collapse top}}
=== Layout ===
Each event is logged to one line of the {{kodi}} log file which is formatted as follows...
<pre>[TIMESTAMP] T:[THREADID] M:[FREEMEM] [LEVEL]: [MESSAGE]</pre>
* '''TIMESTAMP''' - The wall time at which the event occurred.
* '''THREADID''' - The thread identification number of the thread in which the event occurred.
* '''FREEMEM''' - The amount of memory (in bytes) free at the time of the event.
* '''LEVEL''' - The severity of the event.
* '''MESSAGE''' - A brief description and/or important information about the event.

=== Log levels ===
There are two different types levels when talking about the {{kodi}} log. The first is the severity of event that has occurred. The second controls which severity levels are actually printed out to the log.

;Severity levels
In order from least to most severe...
* '''DEBUG''' - In depth information about the status of {{kodi}}. This information can pretty much only be deciphered by a developer or long time {{kodi}} power user.
* '''INFO''' - Something has happened. It's not a problem, we just thought you might want to know. Fairly excessive output that most people won't care about.
* '''NOTICE''' - Similar to INFO but the average Joe might want to know about these events. This level and above are logged by default.
* '''WARNING''' - Something potentially bad has happened. If {{kodi}} did something you didn't expect, this is probably why. Watch for errors to follow.
* '''ERROR''' - This event is bad. Something has failed. You likely noticed problems with the application be it skin artifacts, failure of playback a crash, etc.
* '''FATAL''' - We're screwed. {{kodi}} is about to crash.

;Log file control levels
In order from least to most information provided...
* '''None''' - No logging will occur. ''xbmc.log'' will likely be created but should remain empty.
* '''Normal''' - The default loglevel. Events with a severity of NOTICE or greater will be logged.
* '''Debug''' - All events are logged. This level (or higher) is all that you should bother someone else with.
* '''Debug w/ Visuals''' - Same printed log as ''Debug'', but free memory and CPU usage are rendered on the screen as well.
* '''SMB Debug''' - Same as ''Debug w/ Visuals'' with the addition of ridiculous amounts of Samba debugging info. Use this only if asked.
{{collapse bottom}}

= See also =
* [[HOW-TO:Submit a bug report]]
* [[Bug tracker]]
* [[Troubleshooting]]

{{Gotham updated}}

[[Category:Development]]
[[Category:Trac]]
[[Category:Manual]]
[[Category:Troubleshooting]]
[[Category:Advanced topics]]

Talk:Log file/Easy

2014-12-31T16:36:55Z

Bs27975: Created page with "Any chance http://xbmclogs.com/show.php has been kodi'fied and the article needs to be so updated? ~~~~"

Any chance http://xbmclogs.com/show.php has been kodi'fied and the article needs to be so updated?
[[User:Bs27975|Bs27975]] ([[User talk:Bs27975|talk]]) 11:36, 31 December 2014 (EST)