BugSquad/Get Logs: Difference between revisions

(4 intermediate revisions by 3 users not shown)

Line 1:

<noinclude>~~{{TOCright}}~~

[[Category:Testing]]

[[Category:BugSquad]]

Line 11:

== The Log Activity ==

The [[olpc:Log]] Activity, ~~[{{fullurle:olpc:File:Activity-log.svg}} http://wiki.laptop.org/images/b/b5/Activity-log.svg][[Image:olpc:File:Activity-log.svg|link=olpc:Log]]~~ is a Sugar-based log viewer that is in most distributions to help you view software logs. You can copy text from the view pane into the Sugar clipboard, then from the clipboard keep it into the Journal, and then attach that Journal item into the [http://bugs.sugarlabs.org bugs.sugarlabs.org] or [http://dev.laptop.org dev.laptop.org] [Attach file] > [Browse...] dialogs, or paste relevant pieces directly into the bug description.

The [[olpc:Log]] Activity, is a Sugar-based log viewer that is in most distributions to help you view software logs. You can copy text from the view pane into the Sugar clipboard, then from the clipboard keep it into the Journal, and then attach that Journal item into the [http://bugs.sugarlabs.org bugs.sugarlabs.org] or [http://dev.laptop.org dev.laptop.org] [Attach file] > [Browse...] dialogs, or paste relevant pieces directly into the bug description.

You can use the Log Collector to easily export all logs to the journal in a handy zip bundle:

[[Image:Log Collector.png|615px]]

== Enabling Sugar debug logging ==

~~Starting with the 0.83 development release, we created the text~~ file, ~/.sugar/debug ~~(shown in the gray box below)~~, ~~which gets read at sugar startup~~. All the ~~logging options are~~ commented ~~out~~ by ~~default~~. Use your editor ~~of choice and~~ remove the '#' before the line 'export SUGAR_LOGGER_LEVEL=debug' to ~~enable Sugar debug logging~~.

A shell script file, {{Code|~/.sugar/debug}}, is run when Sugar starts up. All environment variables exported by the file will be inherited by the Sugar shell and activity processes.

From Sugar 0.83 to 0.98, the file is prepared with commented lines. From Sugar 0.102, the file must be created by you. Use your editor to add a line, or remove the '#' before the line, to ensure SUGAR_LOGGER_LEVEL is exported with the value ''debug'', like this:

export SUGAR_LOGGER_LEVEL=debug

From Sugar 0.83 to 0.98, the prepared file looks like this:

<pre>

# Uncomment the following lines to turn on many sugar debugging

Line 33:

Line 43:

=== Where are the logs placed ===

* Perform the minimal steps to reproduce the bug.

* The relevant logs are stored in '~/.sugar/default/logs', (e.g, org.laptop.WebActivity-1.log for the log of the first Browse instance).

* The relevant logs are stored in {{Code|~/.sugar/default/logs}}, (e.g, org.laptop.WebActivity-1.log for the log of the first Browse instance).

=== Using sugar-launch ===

To enable debug logging for one run of one specific activity, use sugar-launch in Terminal, to set the SUGAR_LOGGER_LEVEL environment variable and start the activity by bundle id:

SUGAR_LOGGER_LEVEL=debug sugar-launch org.laptop.Chat

=== Using the sugar-emulator ===

Line 51:

Line 66:

* Reboot, or just restart X using ctrl+alt+erase

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

The file {{Code|~/.xsession-example}} contains other settings useful for debugging. You can copy individual lines from this or copy the entire file to {{Code|~/.xsession}}.

== On other machines (Sugar.84)==

@@ Line 1: / Line 1: @@
-<noinclude>{{TOCright}}
+<noinclude>
 [[Category:Testing]]
 [[Category:BugSquad]]
@@ Line 11: / Line 11: @@
 == The Log Activity ==
-The [[olpc:Log]] Activity, [{{fullurle:olpc:File:Activity-log.svg}} http://wiki.laptop.org/images/b/b5/Activity-log.svg][[Image:olpc:File:Activity-log.svg|link=olpc:Log]] is a Sugar-based log viewer that is in most distributions to help you view software logs. You can copy text from the view pane into the Sugar clipboard, then from the clipboard keep it into the Journal, and then attach that Journal item into the [http://bugs.sugarlabs.org bugs.sugarlabs.org] or [http://dev.laptop.org dev.laptop.org] [Attach file] > [Browse...] dialogs, or paste relevant pieces directly into the bug description.
+The [[olpc:Log]] Activity, is a Sugar-based log viewer that is in most distributions to help you view software logs. You can copy text from the view pane into the Sugar clipboard, then from the clipboard keep it into the Journal, and then attach that Journal item into the [http://bugs.sugarlabs.org bugs.sugarlabs.org] or [http://dev.laptop.org dev.laptop.org] [Attach file] > [Browse...] dialogs, or paste relevant pieces directly into the bug description.
+You can use the Log Collector to easily export all logs to the journal in a handy zip bundle:
+[[Image:Log Collector.png|615px]]
 == Enabling Sugar debug logging ==
-Starting with the 0.83 development release, we created the text file, ~/.sugar/debug (shown in the gray box below), which gets read at sugar startup. All the logging options are commented out by default. Use your editor of choice and remove the '#' before the line 'export SUGAR_LOGGER_LEVEL=debug' to enable Sugar debug logging.
+A shell script file, {{Code|~/.sugar/debug}}, is run when Sugar starts up.  All environment variables exported by the file will be inherited by the Sugar shell and activity processes.
+From Sugar 0.83 to 0.98, the file is prepared with commented lines.  From Sugar 0.102, the file must be created by you.  Use your editor to add a line, or remove the '#' before the line, to ensure SUGAR_LOGGER_LEVEL is exported with the value ''debug'', like this:
+ export SUGAR_LOGGER_LEVEL=debug
+From Sugar 0.83 to 0.98, the prepared file looks like this:
 <pre>
 # Uncomment the following lines to turn on many sugar debugging
@@ Line 33: / Line 43: @@
 === Where are the logs placed ===
 * Perform the minimal steps to reproduce the bug.
-* The relevant logs are stored in '~/.sugar/default/logs', (e.g, org.laptop.WebActivity-1.log for the log of the first Browse instance).
+* The relevant logs are stored in {{Code|~/.sugar/default/logs}}, (e.g, org.laptop.WebActivity-1.log for the log of the first Browse instance).
+=== Using sugar-launch ===
+To enable debug logging for one run of one specific activity, use sugar-launch in Terminal, to set the SUGAR_LOGGER_LEVEL environment variable and start the activity by bundle id:
+ SUGAR_LOGGER_LEVEL=debug sugar-launch org.laptop.Chat
 === Using the sugar-emulator ===
@@ Line 51: / Line 66: @@
 * Reboot, or just restart X using ctrl+alt+erase
-The file <tt>~/.xsession-example</tt> contains other settings useful for debugging. You can copy individual lines from this or copy the entire file to <tt>~/.xsession</tt>.
+The file {{Code|~/.xsession-example}} contains other settings useful for debugging. You can copy individual lines from this or copy the entire file to {{Code|~/.xsession}}.
 == On other machines (Sugar.84)==