Difference between revisions of "Application:Lumberjack"

From WebOS Internals
Jump to navigation Jump to search
m (Added Resources section. Added app specific donation template to header and resources section. Changed icon position in summary, set to frameless.)
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
<div style='position: relative;'>
 
{{application
 
{{application
 
|name=Lumberjack
 
|name=Lumberjack
 
|type=webOS
 
|type=webOS
−
|version=0.1.1 Beta
+
|version=0.5.0
 
|tag=Utilities
 
|tag=Utilities
 
|screenshot=Lumberjack_ss1.png
 
|screenshot=Lumberjack_ss1.png
−
|description=}}
+
|description=<div style='position: absolute; bottom: 0; right: 0; padding-right: 28px; padding-bottom: 16px'>{{LumberjackDonation}}</div>
 +
}}
 +
</div>
  
−
=Summary=
+
==Summary==
−
{{icon|Icon_WebOSInternals_Lumberjack.png|float:right;}}Lumberjack is an on-device logging tool. It allows you to view and follow the logs for specific applications from the /var/log/messages file.
+
[[image:Icon_WebOSInternals_Lumberjack.png|frameless|left]]
 +
Lumberjack is an on-device logging tool. It allows you to view and follow the logs for specific applications from the /var/log/messages file.
  
 
Its goal is to make debugging apps without a workstation better and easier.
 
Its goal is to make debugging apps without a workstation better and easier.
  
−
<table>
 
−
<tr>
 
−
<td>[[File:main_screen.png]]</td>
 
−
<td>
 
−
How is retrieve different from follow?
 
−
:* The app is always logging, retrieve get the entire log since it was last cleared. and follow is just from then on appearing in real-time.
 
−
:* Retrieve is just a static once look. unless you the refresh button.
 
  
−
What is DBus Capture?
+
== FAQ ==
−
:* The DBus Capture button is to follow service request in real time. It will show which applications are sending out requests and what the service returns. For example an application will request GPS services, the log will show this request and how the service responds to the request.
+
[[File:Lumberjack_ss3.png|200px|right]]
  
−
How do you write to logs?
+
<h3>How is the "Retrieve Log" different from the "Follow Log"?</h3>
−
:* Mojo.log events to document and debug their apps
+
Applications are always logging to the /var/log/messages file, the Retrieve Log button gets the entire log since it was last cleared. Where as the Follow Log displays the log in real-time.
−
:* can also use the javascript alert() function
 
  
−
What's the difference between cleaned and raw log scene formats?
+
&bull; The Follow Log displays logs in real-time.
−
:* Raw log, copies the exact row from the messages file
 
−
:* Cleaned log is formatted
 
  
−
</td>
+
&bull; The Retrieve Log displays a static once look, but this can be updated by selecting the refresh button.
−
<tr>
 
−
</table>
 
  
 +
[[File:Lumberjack_worm.png|200px|right]]
 +
<h3>What is "Resource Monitor"?</h3>
 +
A graph of dom nodes and resource handles over time.
  
 +
[[File:Lumberjack_scenetiming.png|200px|right]]
 +
<h3>What is "Scene Timing"?</h3>
 +
Parses the time a scene takes to display.
  
 +
[[File:Lumberjack_ss5.png|200px|right]]
 +
<h3>What is "LS2 Monitor" (webOS 2.x) and "DBus Capture" (webOS 1.x)?</h3>
 +
The LS2 Monitor and DBus Capture buttons follow service requests in real time. It will show which applications are sending out requests and what the service returns.
  
−
[[File:lumberjack_logView.png]]
+
For example an application will request GPS services, the log will show this request and what data the service responds to the request.
  
 +
In webOS 1.x requests went over DBus, and in webOS 2.x they use LS2. What Lumberjack sees is the same.
  
−
By default the device is at mojo.log.error level. so lumberjack changes LunaSysMgrJS to debug from error when it starts. then back to error when it closes.
 
  
 +
<h3>How do you write to logs?</h3>
  
 +
&bull; Mojo.log events to document and debug their apps. For more information on this technique see Palm's API documentation here [http://developer.palm.com/index.php?option=com_content&view=article&id=1864&Itemid=253 Mojo.Log]
  
 +
&bull; Logging can also be displayed with javascripts <b>alert()</b> function, and can by viewed in lumberjack by selecting "Alerts" in the "What to look for" list.
  
−
[[File:preferences_screen.png]]
+
 
 +
<h3>What's the difference between cleaned and raw log scene formats?</h3>
 +
 
 +
&bull; Raw log, copies the exact row from the messages file
 +
 
 +
<pre>2010-10-17T10:51:20.712188Z [1070190] palm-webos-device user.crit LunaSysMgr: {LunaSysMgrJS}: org.webosinternals.lumberjack: Error: Test Error Message, palmInitFramework346:2520</pre>
 +
 
 +
&bull; Cleaned log is formatted
 +
<pre>[2010-10-17 10:51:20] (Lumberjack) Error: Test Error Message</pre>
 +
 
 +
<h3>How can I view log with Linux Access?</h3>
 +
 
 +
<pre>tail -f /var/log/messages</pre>
 +
 
 +
 
 +
<div id="Note" style="border: 2px solid black; font: italic bold; width: 60%; margin: 10px;">
 +
<div style="font: italic bold 1.5em; margin: 10px;"><h2>NOTE</h2></div>
 +
<div id="NoteBody" style="margin: 10px;">By default webOS devices has their logging level set at the "Mojo.log.error" level. Lumberjack changes the logging level from error to debug in the LunaSysMgrJS when it starts. When Lumberjack is closed the logging level reverts back to error when it closes.
 +
 
 +
It is best to test your applications with lumberjack already open.</div>
 +
</div>
 +
 
 +
== Preferences ==
 +
 
 +
[[File:preferences_screen.png|200px|right]]
 +
 
 +
The Lumberjack preferences screen can be accessed by tapping the menu button on the top left corner of your device.
 +
 
 +
The Global group:
 +
:* Theme - Changes the applications viewing theme between the standard Palm default (light) theme or the Palm Dark theme.
 +
:* Log Level - Sets the type of log events you want Lumberjack to display.
 +
::* Don't Change - Won't change your current setting when Lumberjack is opened.
 +
::* Alert - ''example: alert("I have" + 3 + "eggs.");''
 +
::* Error - ''example: Mojo.Log.error("I have", 3, "eggs.");''
 +
::* Warning - ''example: Mojo.Log.warn("I have", 3, "eggs.");''
 +
::* Info - ''example: Mojo.Log.info("I have", 3, "eggs.");''
 +
 
 +
 
 +
The Main Scene group:
 +
:* List Stock Apps - When enabled will list stock apps (dialer, calendar, clock, email, etc)
 +
:* Log in New Card - When enabled some log scenes will automatically pop out into their own card
 +
 
 +
 
 +
The Log Scenes group:
 +
:* Font Size
 +
::* Normal
 +
::* Paul Bunyan
 +
:* Copy Format
 +
::* Raw Log
 +
::* Cleaned
 +
 
 +
 
 +
== Resources ==
 +
 
 +
===== Support Development =====
 +
<blockquote>
 +
{{LumberjackDonation}}
 +
<br />
 +
</blockquote>
 +
 
 +
===== Official Forum =====
 +
<blockquote>
 +
* [http://forums.precentral.net/webos-internals/259538-lumberjack.html Official PreCentral Forum Thread]
 +
</blockquote>
 +
 
 +
===== Bug Reporting =====
 +
<blockquote>
 +
* [http://redmine.webos-internals.org/projects/lumberjack Official Bug Reporting Site]
 +
:''Registration on the site is required to submit bug reports.''
 +
</blockquote>
 +
 
 +
===== Feature Requests =====
 +
<blockquote>
 +
* [http://redmine.webos-internals.org/projects/lumberjack Official Feature Requests Site]
 +
:''Registration on the site is required to submit feature requests.''
 +
</blockquote>

Latest revision as of 03:32, 3 May 2011

Lumberjack ss1.png

Summary

Icon WebOSInternals Lumberjack.png

Lumberjack is an on-device logging tool. It allows you to view and follow the logs for specific applications from the /var/log/messages file.

Its goal is to make debugging apps without a workstation better and easier.


FAQ

Lumberjack ss3.png

How is the "Retrieve Log" different from the "Follow Log"?

Applications are always logging to the /var/log/messages file, the Retrieve Log button gets the entire log since it was last cleared. Where as the Follow Log displays the log in real-time.

• The Follow Log displays logs in real-time.

• The Retrieve Log displays a static once look, but this can be updated by selecting the refresh button.

Lumberjack worm.png

What is "Resource Monitor"?

A graph of dom nodes and resource handles over time.

Lumberjack scenetiming.png

What is "Scene Timing"?

Parses the time a scene takes to display.

Lumberjack ss5.png

What is "LS2 Monitor" (webOS 2.x) and "DBus Capture" (webOS 1.x)?

The LS2 Monitor and DBus Capture buttons follow service requests in real time. It will show which applications are sending out requests and what the service returns.

For example an application will request GPS services, the log will show this request and what data the service responds to the request.

In webOS 1.x requests went over DBus, and in webOS 2.x they use LS2. What Lumberjack sees is the same.


How do you write to logs?

• Mojo.log events to document and debug their apps. For more information on this technique see Palm's API documentation here Mojo.Log

• Logging can also be displayed with javascripts alert() function, and can by viewed in lumberjack by selecting "Alerts" in the "What to look for" list.


What's the difference between cleaned and raw log scene formats?

• Raw log, copies the exact row from the messages file 

2010-10-17T10:51:20.712188Z [1070190] palm-webos-device user.crit LunaSysMgr: {LunaSysMgrJS}: org.webosinternals.lumberjack: Error: Test Error Message, palmInitFramework346:2520

• Cleaned log is formatted 

[2010-10-17 10:51:20] (Lumberjack) Error: Test Error Message

How can I view log with Linux Access?

tail -f /var/log/messages


NOTE

By default webOS devices has their logging level set at the "Mojo.log.error" level. Lumberjack changes the logging level from error to debug in the LunaSysMgrJS when it starts. When Lumberjack is closed the logging level reverts back to error when it closes. It is best to test your applications with lumberjack already open.

Preferences

Preferences screen.png

The Lumberjack preferences screen can be accessed by tapping the menu button on the top left corner of your device.

The Global group:

  • Theme - Changes the applications viewing theme between the standard Palm default (light) theme or the Palm Dark theme.
  • Log Level - Sets the type of log events you want Lumberjack to display.
  • Don't Change - Won't change your current setting when Lumberjack is opened.
  • Alert - example: alert("I have" + 3 + "eggs.");
  • Error - example: Mojo.Log.error("I have", 3, "eggs.");
  • Warning - example: Mojo.Log.warn("I have", 3, "eggs.");
  • Info - example: Mojo.Log.info("I have", 3, "eggs.");


The Main Scene group:

  • List Stock Apps - When enabled will list stock apps (dialer, calendar, clock, email, etc)
  • Log in New Card - When enabled some log scenes will automatically pop out into their own card


The Log Scenes group:

  • Font Size
  • Normal
  • Paul Bunyan
  • Copy Format
  • Raw Log
  • Cleaned


Resources

Support Development

Btn donateCC LG.gif

Official Forum
Bug Reporting
Registration on the site is required to submit bug reports.
Feature Requests
Registration on the site is required to submit feature requests.
Retrieved from "http://wiki.webos-internals.org/index.php?title=Application:Lumberjack&oldid=15759"