Settings/System/Logging: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
No edit summary
(Updated for v19)
Line 1: Line 1:
{{mininav| [[Settings]] | [[Settings/System|System Settings]] }}
{{mininav| [[Settings]] | [[Settings/System|System]] }}
[[File:system_logging.JPG|600px|right]]
 




Line 7: Line 5:




To access the '''Logging''' settings page, the menu Settings Level must be set to at least '''Standard'''
{{-}}


 
= Debug =
==Debug==
This section is related to the creation of Debug Logs.
This section is related to the creation of Debug Logs.
; {{see also|Log_file|label 1=Debug Log}}


<gallery mode="packed" widths="700px" heights="394px">
File:Settings-System-Logging-01.jpg
</gallery>




=== Enable debug logging ===
== Enable debug logging ==
{|
{|
|- valign="top"
|- valign="top"
Line 25: Line 22:
| '''Description:'''
| '''Description:'''
| Turn debug logging '''on''' or '''off'''. Useful for troubleshooting. <br />
| Turn debug logging '''on''' or '''off'''. Useful for troubleshooting. <br />
If you have been requested to provide a debug log, this setting must be enabled. For further instructions, refer to the link below.
If you have been requested to provide a debug log, this setting must be enabled. For further instructions, refer to the link below.<br>
'''See: [[Log_file|Debug Log]]'''
|}
|}
; {{see also|Log_file|label 1=Debug Log}}




=== Enable component-specific logging ===
== Enable component-specific logging ==
{|
{|
|- valign="top"
|- valign="top"
Line 39: Line 35:
| '''Description:'''
| '''Description:'''
| Enables verbose messages from additional libraries to be included in the debug log <br />
| Enables verbose messages from additional libraries to be included in the debug log <br />
Depending upon the issue you are investigating, you may want additional logging for a particular component of Kodi. To use this, enable this item and then select the required additional data in the next setting.
Depending upon the issue you are investigating, you may want additional logging for a particular component of Kodi. To use this, enable this item and then select the required additional data in the next setting.<br>
'''See: [[Log_file|Debug Log]]'''
|}
|}
; {{see also|Log_file|label 1=Debug Log}}




=== Specify component-specific logging ===
== Specify component-specific logging ==
{|
{|
|- valign="top"
|- valign="top"
Line 53: Line 48:
| '''Description:'''
| '''Description:'''
| Specify additional libraries whose verbose messages are to be included in the debug log<br />
| Specify additional libraries whose verbose messages are to be included in the debug log<br />
If the previous setting has been enabled, then select which additional components are to be included in the debug log. The following settings may be available, depending upon your hardware and operating system
If the previous setting has been enabled, then select which additional components are to be included in the debug log.<br>
<section begin="ComponentLoggingList" />* The SMB library
The following settings may be available, depending upon your hardware and operating system
* The libcURL library (HTTP(S), DAV)
{{#lst:Log_file/Easy|ComponentValues}}
* The FFmpeg libraries
'''See: [[Log_file|Debug Log]]'''
* The Audio component
* The Video component
* D-Bus calls
* JSON-RPC requests
* The Webserver component
* The Airtunes library
* The UPnP components
* The libCEC library
* The Database component
* Audio/video timing information<section end="ComponentLoggingList" />
|}
|}
; {{see also|Log_file|label 1=Debug Log}}




 
== Screenshot folder ==
=== Screenshot folder ===
{|
{|
|- valign="top"
|- valign="top"
Line 83: Line 66:
The screenshot can be taken using one of the following methods...
The screenshot can be taken using one of the following methods...
*Pressing {{keypress|ctrl|s}} on a keyboard
*Pressing {{keypress|ctrl|s}} on a keyboard
*Pressing the equiveland key on your remote control. This is not a standard button press and will need to be mapped to your remote control. '''''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''''
*Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control.<br>
'''See: [[Add-on:Keymap_Editor|Keymap Editor]]'''
|}
|}






== Events ==
= Events =
The following settings are related to the '''Event Log'''
The following settings are related to the '''Event Log'''
<gallery mode="packed" widths="700px" heights="394px">
File:Settings-System-Logging-02.jpg
</gallery>


;{{See|Event Log}}
;{{See|Event Log}}




 
== Enable event logging ==
=== Enable event logging ===
{|
{|
|- valign="top"
|- valign="top"
Line 102: Line 88:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Enables or disables the Event Log
| Enables or disables the Event Log<br>
'''See: [[Event_Log|Event Log]]'''
|}
|}
;{{See also|Event_Log|label 1= Event Log}}




 
== Enable notification event logging ==
=== Enable notification event logging ===
{|
{|
|- valign="top"
|- valign="top"
Line 115: Line 100:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| This setting is only available if the previous setting is '''Enabled'''. Enabling this setting will create an on-screen notification that an Event has been recorded in the log.
| This setting is only available if the previous setting is '''Enabled'''. Enabling this setting will create an on-screen notification that an Event has been recorded in the log.<br>
'''See: [[Event_Log|Event Log]]'''
|}
|}
;{{See also|Event_Log|label 1= Event Log}}




 
== Show event log ==
=== Show event log ===
{|
{|
|- valign="top"
|- valign="top"
Line 128: Line 112:
|- valign="top"
|- valign="top"
| '''Description:'''
| '''Description:'''
| Selecting this item will take you directly to the Event Log. The log can also be accessed from the main settings page.
| Selecting this item will take you directly to the Event Log. The log can also be accessed from the main settings page.<br>
'''See: [[Event_Log|Event Log]]'''
|}
|}
;{{See also|Event_Log|label 1= Event Log}}
 
 
 
= References =
<references />








{{Top}}
{{top}}
{{updated|19}}


{{updated|18}}
[[Category:Settings]]
[[Category:FAQ]]
[[Category:Index]]
[[Category:Guides]]
[[Category:Manual]]
[[Category:Karellen]]
[[Category:First time user]]
[[Category:Advanced topics]]
[[Category:Quick Start Guide]]

Revision as of 20:57, 22 March 2021

Home icon grey.png   ▶ Settings ▶ System ▶ Logging



Debug

This section is related to the creation of Debug Logs.


Enable debug logging

Settings level: Standard
Description: Turn debug logging on or off. Useful for troubleshooting.

If you have been requested to provide a debug log, this setting must be enabled. For further instructions, refer to the link below.
See: Debug Log


Enable component-specific logging

Settings level: Standard
Description: Enables verbose messages from additional libraries to be included in the debug log

Depending upon the issue you are investigating, you may want additional logging for a particular component of Kodi. To use this, enable this item and then select the required additional data in the next setting.
See: Debug Log


Specify component-specific logging

Settings level: Standard
Description: Specify additional libraries whose verbose messages are to be included in the debug log

If the previous setting has been enabled, then select which additional components are to be included in the debug log.
The following settings may be available, depending upon your hardware and operating system

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
Add-ons component[1] 16777216

See: Debug Log


Screenshot folder

Settings level: Standard
Description: Select the folder where the screenshots should be saved in

Kodi allows you to take a screen snapshot. This setting tells Kodi where to save the screenshot once it has been taken. You should use a location that allows easy access to the folder. The screenshot can be taken using one of the following methods...

  • Pressing ctrl+s on a keyboard
  • Pressing the equivalent key on your remote control. This is not a standard button press and will need to be mapped to your remote control.

See: Keymap Editor


Events

The following settings are related to the Event Log

See: Event Log


Enable event logging

Settings level: Standard
Description: Enables or disables the Event Log

See: Event Log


Enable notification event logging

Settings level: Standard
Description: This setting is only available if the previous setting is Enabled. Enabling this setting will create an on-screen notification that an Event has been recorded in the log.

See: Event Log


Show event log

Settings level: Standard
Description: Selecting this item will take you directly to the Event Log. The log can also be accessed from the main settings page.

See: Event Log


References



Return to top