Attaching Sugar logs to tickets: Difference between revisions

From OLPC
Jump to navigation Jump to search
m (+cat)
m (fix links. add headings)
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.
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:
These are general steps to follow when providing logs for some bug:


* Open the terminal activity.
* Start the [[Terminal activity]].
* Type the following:
* Type the following:
echo 'export SUGAR_LOGGER_LEVEL=debug' >> /home/olpc/.xsession


* Reboot, or just restart X using ctrl+alt+erase
echo 'export SUGAR_LOGGER_LEVEL=debug' >> /home/olpc/.xsession
* Perform the minimal steps to reproduce the bug.

* Reboot / you can as well just restart X using ctrl+alt+erase
* Do 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 an usb stick 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) copy them to an usb stick and attach to the ticket from some other computer.
''''' The file datastore.log may contain a list of all the files in your USB stick 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. '''''
''''' The file datastore.log may contain a list of all the files in your USB stick 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. '''''
Line 15: Line 16:
* 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.


=== Presence service ===
If your bug involves the presence service, you might also want to follow the [[Telepathy-debug|steps outlined for debugging Telepathy]].

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 ==
== 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 a removable memory (SD or USB) before using the XO or another computer to attach them to 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.




[[category:developers]] [[category:software]]
[[category:Developers]] [[category:software]]

Revision as of 06:54, 17 June 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.
  • 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 an usb stick and attach to the ticket from some other computer.

The file datastore.log may contain a list of all the files in your USB stick 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.

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.