Difference between revisions of "Log file"

From Official Kodi Wiki
Jump to navigation Jump to search
(Rewrite page)
Line 1: Line 1:
{{mininav| [[Troubleshooting]] | [[HOW-TO:Submit a bug report]] }}
{{mininav| [[Troubleshooting]] }}


__TOC__


= Introduction =
<section begin="intro" />The Debug Log is {{kodi}}'s most basic diagnostic tool that assists in fault finding and troubleshooting. {{Kodi}} records a process and error log at all times, but this may not be sufficent and more detail is required. The Debug Log records additional data that may assist in resolving issues experienced by the user. The Easy and Advanced methods are the two options to create the '''Debug Log'''. The method you choose will depend on your requirements.<section end="intro" />


<section begin="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.<section end="intro" />
*'''Do NOT post your logs directly into the forum'''. Always use a paste site like '''''http://paste.kodi.tv/''''' or''''' https://paste.ubuntu.com'''''. Post the link to your pasted log in the forum.
*'''Provide ''FULL'' Logs only. No Partial logs or snippets.''' The only redactions should be personal information. (See the section on Personally Identifiable Information below)
*'''''[[Official:Forum_rules|Forum Rules]]''''' are strictly enforced especially those pertaining to the ''[[Official:Forum_rules#Piracy_Policy|Piracy Policy]]'' and ''[[Official:Forum_rules/Banned_add-ons|Banned Add-ons]]''. If you have banned add-ons installed, you are ineligible for support at the Official {{kodi}} forum.
*We do not accept files uploaded to lockers or online storage locations that require downloading to local computers.




== Important Notes ==
= Methods =
*{{Big|'''Do NOT post your logs directly in a forum. Always use a paste site like https://paste.kodi.tv . Post the link to your pasted log in the forum.''' Details are in the following pages.}}
<big>* '''[[Log file/Easy|Easy/Basic Method]]'''</big><br>
:{{#lst:Log_ file/Easy|intro}}




*{{big|'''Provide ''FULL'' Logs only. No Partial logs or snippets.'''}} The only redactions should be personal information.
<big>* '''[[Log file/Advanced|Advanced Method]]'''</big><br>
:{{#lst:Log_file/Advanced|intro}}




* Be aware that the Logs are "Session Logs" only. The logs are written from Kodi startup to Kodi shutdown (or crash). The next time you start Kodi, the kodi.log is cleared, and a new log is created. The kodi.log that was there is renamed to kodi.old.log and the existing kodi.old.log is deleted. In effect you only ever have two logs available- the current one, and the previous one. Depending upon your situation and which of the following methods you use, be mindful of the following:
** If you have replicated the problem and are immediately using the Kodi LogUploader add-on, upload kodi.log
** If you are going to '''restart''' Kodi to use the uploader app, you need to upload kodi.old.log
** Before restarting, you can manually copy and paste the contents of the kodi.log to a pastebin site


= kodi.log -v- kodi.old.log =
<section begin="WhichLog" />The {{kodi}} logs are ''Session Logs''. The logs are written from {{kodi}} startup to {{kodi}} shutdown (or crash). The next time you start {{kodi}}, the existing '''kodi.log''' is renamed '''Kodi.old.log''' and a new '''kodi.log''' is created for this new session. In effect you only ever have two logs available- the current one, and the previous one.


== Basic Method ==
Which log you upload depends...
<big>* '''[[Log file/Easy]] -'''</big>
#If you have created the log which captures the problem and have '''not''' restarted {{kodi}}, then upload '''kodi.log'''
If Kodi is operational and you can still navigate through the menu system, use this method to create the Debugging Log.
#If you have created the log which captures the problem and have '''restarted''' {{kodi}}, then upload '''kodi.old.log''' <section end="WhichLog" />




== Advanced Method ==
<big>* '''[[Log file/Advanced]] -'''</big>
If your Kodi refuses to start, or crashes while attempting to start or while navigating the menu's, then use this method to create the Debugging Log.


{{updated|17}}
= Personally Identifiable Information =
'''{{red|Password and Personally Identifiable Information Warning}}'''<br>
Be aware that personally identifiable information may be revealed in the debug log. For example...
* If you have used your full name in the folder path, this will be revealed. eg ''f:\JohnSmith\Movies\Lucy (2015)''
* You are using add-ons from an unofficial repository where the author has failed to mask usernames and passwords
 
If this applies to your log and you are using the Kodi Logfile Uploader, then view the log first to ensure the Kodi Logfile Uploader has stripped all sensitive information from the log.
 
Passwords for network shares like SMB/SAMBA, FTP, etc, will automatically be excluded from the debug log. Add-ons from the Official Repository will not reveal passwords and usernames.
 
 
 
= See Also =
* [[Add-on:Kodi_Logfile_Uploader| Kodi Logfile Uploader Add-on]]
* [[Log_file/File_manager_access| Using the {{kodi}} File Manager to access logs]]
* [[Advancedsettings.xml#Troubleshooting_settings| Available Settings in the advancedsettings.xml]]
 
 
 
 
 
{{Top}}
 
{{updated|18}}
[[Category:FAQ]]
[[Category:Index]]
[[Category:Index]]
[[Category:Guides]]
[[Category:How-to]]
[[Category:Manual]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Advanced topics]]
[[Category:Troubleshooting]]

Revision as of 03:07, 10 April 2019

Home icon grey.png   ▶ Troubleshooting ▶ Log file


1 Introduction

The Debug Log is Kodi's most basic diagnostic tool that assists in fault finding and troubleshooting. Kodi records a process and error log at all times, but this may not be sufficent and more detail is required. The Debug Log records additional data that may assist in resolving issues experienced by the user. The Easy and Advanced methods are the two options to create the Debug Log. The method you choose will depend on your requirements.

  • Do NOT post your logs directly into the forum. Always use a paste site like http://paste.kodi.tv/ or https://paste.ubuntu.com. Post the link to your pasted log in the forum.
  • Provide FULL Logs only. No Partial logs or snippets. The only redactions should be personal information. (See the section on Personally Identifiable Information below)
  • Forum Rules are strictly enforced especially those pertaining to the Piracy Policy and Banned Add-ons. If you have banned add-ons installed, you are ineligible for support at the Official Kodi forum.
  • We do not accept files uploaded to lockers or online storage locations that require downloading to local computers.


2 Methods

* Easy/Basic Method

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.


* Advanced Method

This page will describe how to create, access and upload the Debug Logfile when Kodi is unresponsive or you are unable to navigate the menu system. If you can navigate the menu system, it is recommended you use the Easy Method.


3 kodi.log -v- kodi.old.log

The Kodi logs are Session Logs. The logs are written from Kodi startup to Kodi shutdown (or crash). The next time you start Kodi, the existing kodi.log is renamed Kodi.old.log and a new kodi.log is created for this new session. In effect you only ever have two logs available- the current one, and the previous one.

Which log you upload depends...

  1. If you have created the log which captures the problem and have not restarted Kodi, then upload kodi.log
  2. If you have created the log which captures the problem and have restarted Kodi, then upload kodi.old.log


4 Personally Identifiable Information

Password and Personally Identifiable Information Warning
Be aware that personally identifiable information may be revealed in the debug log. For example...

  • If you have used your full name in the folder path, this will be revealed. eg f:\JohnSmith\Movies\Lucy (2015)
  • You are using add-ons from an unofficial repository where the author has failed to mask usernames and passwords

If this applies to your log and you are using the Kodi Logfile Uploader, then view the log first to ensure the Kodi Logfile Uploader has stripped all sensitive information from the log.

Passwords for network shares like SMB/SAMBA, FTP, etc, will automatically be excluded from the debug log. Add-ons from the Official Repository will not reveal passwords and usernames.


5 See Also



Return to top