Attaching Sugar logs to tickets: Difference between revisions

From OLPC
Jump to navigation Jump to search
m (also categorize as Category:Preparing for testing)
(Updated to reflect presence of olpc-log in builds)
Line 11: Line 11:
* 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.
* From a terminal window, type:
* '''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.
sudo olpc-log
''''' 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.
* It places all relevant logs into a file in the current directory. The name of the file includes the serial number of the laptop and the date and time the log was generated. Please send this log when reporting the problem.
* You may also use <code>olpc-netlog</code> to gather all logs and XO info to a single file.
* [[Log]] is an activity for viewing log files
* [[Log]] is an activity for viewing log files


=== 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>, and uncomment the debug logging lines as needed.


=== Presence service ===
=== Presence service ===

Revision as of 17:10, 30 September 2008

If you provide debugging logs to a ticket, you'll be making it much easier to developers to fix the issue.

Enabling debugging

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

 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.
  • From a terminal window, type:
 sudo olpc-log
  • It places all relevant logs into a file in the current directory. The name of the file includes the serial number of the laptop and the date and time the log was generated. Please send this log when reporting the problem.
  • 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, and uncomment the debug logging lines as needed.

Presence service

If your bug involves the presence service, you might also want to follow the steps for Telepathy debugging.

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.