Difference between revisions of "BugSquad/Get Logs"

From Sugar Labs
Jump to navigation Jump to search
m (BugSquad/Get Logs moved to BugSquad/GetLogs: better naming)
Line 1: Line 1:
If you provide debugging logs to a ticket, you'll be making it much easier to developers to fix the issue.
+
== Why ==
 +
If you provide debugging logs to a ticket, you'll be making it much easier to developers to fix the issue. In most of the cases it will be easiest for you to reproduce the bug.
  
 
== Enabling debugging ==
 
== Enabling debugging ==
Line 5: Line 6:
 
These are general steps to follow when providing logs for some bug:
 
These are general steps to follow when providing logs for some bug:
  
* Start the [[Terminal activity]].
+
* Start the Terminal activity.
 
* Type the following:
 
* Type the following:
 
   echo 'export SUGAR_LOGGER_LEVEL=debug' >> /home/olpc/.xsession
 
   echo 'export SUGAR_LOGGER_LEVEL=debug' >> /home/olpc/.xsession
Line 11: Line 12:
 
* Reboot, or just restart X using ctrl+alt+erase
 
* Reboot, or just restart X using ctrl+alt+erase
 
* Perform the minimal steps to reproduce the bug.
 
* Perform the minimal steps to reproduce the bug.
* '''The relevant logs are in /home/olpc/.sugar/default/logs''', (e.g org.laptop.WebActivity-1.log for the log of the first Browse instance) copy them to a USB flash drive and attach to the ticket from some other computer.
+
* The relevant logs are in '''/home/olpc/.sugar/default/logs''', (e.g org.laptop.WebActivity-1.log for the log of the first Browse instance). You can copy them to a USB flash drive and attach to the ticket from another computer or use the Browse activity to attach them to the ticket.
''''' The file datastore.log may contain a list of all the files in your USB flash drive or SD card. Check and delete from there if you don't want to submit that information. Most probably it's not needed by the developers. '''''
+
 
 +
Note: The file datastore.log may contain a list of all the files in your USB flash drive or SD card. Check and delete from there if you don't want to submit that information. Most probably it's not needed by the developers.  
 +
 
 
* Another interesting file to attach to the ticket is /var/log/messages.
 
* Another interesting file to attach to the ticket is /var/log/messages.
 
* You may also use <code>olpc-netlog</code> to gather all logs and XO info to a single file.
 
* You may also use <code>olpc-netlog</code> to gather all logs and XO info to a single file.
Line 18: Line 21:
  
 
=== Other debugging settings ===
 
=== Other debugging settings ===
The file <tt>/home/olpc/.xsession-example</tt> contains other settings useful for debugging, you can copy individual lines from this or copy the entire file to <tt>/home/olpc/.xsession</tt>.
+
The file <tt>/home/olpc/.xsession-example</tt> contains other settings useful for debugging. You can copy individual lines from this or copy the entire file to <tt>/home/olpc/.xsession</tt>.
  
 
=== Presence service ===
 
=== Presence service ===
  
If your bug involves the presence service, you might also want to follow the steps for [[Telepathy debugging]].
+
If your bug involves the presence service, you might also want to follow the steps for [[BugSquad/TelepathyDebugging]].
  
 
== If you can't reproduce the bug ==
 
== If you can't reproduce the bug ==

Revision as of 07:42, 25 September 2008

Why

If you provide debugging logs to a ticket, you'll be making it much easier to developers to fix the issue. In most of the cases it will be easiest for you to reproduce the bug.

Enabling debugging

These are general steps to follow when providing logs for some bug:

  • Start the Terminal activity.
  • Type the following:
 echo 'export SUGAR_LOGGER_LEVEL=debug' >> /home/olpc/.xsession
  • Reboot, or just restart X using ctrl+alt+erase
  • Perform the minimal steps to reproduce the bug.
  • The relevant logs are in /home/olpc/.sugar/default/logs, (e.g org.laptop.WebActivity-1.log for the log of the first Browse instance). You can copy them to a USB flash drive and attach to the ticket from another computer or use the Browse activity to attach them to the ticket.

Note: The file datastore.log may contain a list of all the files in your USB flash drive or SD card. Check and delete from there if you don't want to submit that information. Most probably it's not needed by the developers.

  • Another interesting file to attach to the ticket is /var/log/messages.
  • You may also use olpc-netlog to gather all logs and XO info to a single file.
  • Log is an activity for viewing log files

Other debugging settings

The file /home/olpc/.xsession-example contains other settings useful for debugging. You can copy individual lines from this or copy the entire file to /home/olpc/.xsession.

Presence service

If your bug involves the presence service, you might also want to follow the steps for BugSquad/TelepathyDebugging.

If you can't reproduce the bug

Python-based activities automatically make logs in /home/olpc/.sugar/default/logs. These logs seem to be moved into subfolders on restart and deleted after a certain period of time. The python stack trace is recorded here on crashes. This is also a good thing to attach to a bug. As above, you will have to use the Terminal activity to copy them to removable memory (SD or USB) before using the XO or another computer to attach them to the bug.