Analyze: Difference between revisions

From OLPC
Jump to navigation Jump to search
mNo edit summary
(Migrated to SL wiki)
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Activity migrated to sl.o
| download=http://activities.sugarlabs.org/en-US/sugar/addon/4200 Analyze
| git=http://git.sugarlabs.org/projects/analyze Analyze
| homepage=http://wiki.sugarlabs.org/go/Activities/Analyze Analyze
}}

[[Image:Activity-analyze.svg]]
[[Image:Activity-analyze.svg]]
{{TOCright}}
{{TOCright}}
Line 8: Line 14:
== Installing Analyze ==
== Installing Analyze ==


See the section on [[Activities#Installing_one_activity|installing Activities]].
Analyze is bundled as an .xo. [http://dev.laptop.org/%7Ecscott/bundles/Analyze-7.xo Analyze-7.xo] is the current bundle. See the section on [[Activities#Installing_one_activity|installing Activities]].


== Using Analyze ==
== Using Analyze ==
Line 14: Line 20:
Analyze is a very simple Activity. All that you do is tell it what interface you want it to display information from.
Analyze is a very simple Activity. All that you do is tell it what interface you want it to display information from.


To select an interface, click on the "Interfaces" tab at top, and then on the appropriate Interface icon (by default, Analyze will start in the Network Status screen). Here are (from left to right) the Network Status, X Server, and Presence Service interface icons.
To select an interface, click on the "Interfaces" tab at top, and then on the appropriate Interface icon (by default, Analyze will start in the Network Status screen). Read the [[Analyze#Features|features list]] to find out what information should be available in each section. Here are (from left to right) the Network Status, X Server, and Presence Service interface icons.


[[Image:Analyze-activity-interface-icons.png|From left to right: Network Status, X Server, and Presence Service interface icons.]]
[[Image:Analyze-activity-interface-icons.png|From left to right: Network Status, X Server, and Presence Service interface icons.]]

Note that the Presence Service screen has 3 windows. You can drag the window boundaries up and down to resize the area of each sub-display.

[[Image:Analyze-activity-screenshot-resize.png|200px]]

== Contributing to Analyze ==

=== Submitting bugs and feature requests ===

If you find a bug in Analyze or think of an enhancement you'd like to see it have as a future feature, [http://dev.laptop.org/newticket submit a ticket here]. Make sure to set the component to "analyze-activity" so we can all see what component it is for.

=== Testing ===

Please see [[Tests/Activity/Analyze]] for instructions.

=== Coding ===

You can browse the current Activity source code at http://dev.laptop.org/git?p=projects/analyze-activity (includes instructions on how to check it out). To see what work needs to be done, look at the [http://dev.laptop.org/query?component=analyze-activity tickets in Trac].

== Features ==


=== Network Status interface ===
=== Network Status interface ===

[[Image:Analyze-activity-screenshot-network.png|180px|right|Networking interface screenshot]]


This interface displays network interface data from /proc/net/dev. You should see the following information:
This interface displays network interface data from /proc/net/dev. You should see the following information:
Line 30: Line 58:
* packets received
* packets received
* packets sent
* packets sent

[[Image:Analyze-activity-screenshot-network.png|300px|Networking interface screenshot]]


=== X Window interface ===
=== X Window interface ===

[[Image:Analyze-activity-screenshot-x.png|180px|right|X Window interface screenshot]]


This interface displays X window information from the libXres extension. You should see the following information:
This interface displays X window information from the libXres extension. You should see the following information:
Line 42: Line 70:
* pixmap bytes
* pixmap bytes
* memory usage (other/total)
* memory usage (other/total)

[[Image:Analyze-activity-screenshot-x.png|300px|X Window interface screenshot]]


=== Presence Service interface ===
=== Presence Service interface ===


[[Image:Analyze-activity-screenshot-ps.png|180px|right|Presence Service interface screenshot]]
This interface displays Presence Service information, getting data directly from [[Dbus]]. Note that the Presence Service screen has 3 windows. You can drag the window boundaries up and down to resize the area of each sub-display.

[[Image:Analyze-activity-screenshot-resize.png|200px]]


This interface has 3 sections: the presence service event log, Activities (on your Neighborhood) and Buddies (in your Neighborhood).
This interface displays Presence Service information, getting data directly from [[Dbus]]. It has 3 sections: the presence service event log, Activities (on your Neighborhood) and Buddies (in your Neighborhood).


==== Presence service event log ====
==== Presence service event log ====
Line 83: Line 107:
* Activities
* Activities
* handles
* handles

[[Image:Analyze-activity-screenshot-ps.png|300px|Presence Service interface screenshot]]


== Semantic metadata ==
== Semantic metadata ==

{{Activity page
{{Activity page
|icon=Image:Activity-analyze.svg
|icon=Image:Activity-analyze.svg
Line 134: Line 155:
|activity source=http://dev.laptop.org/git?p=projects/analyze-activity
|activity source=http://dev.laptop.org/git?p=projects/analyze-activity
|language codes=en
|language codes=en
|bundle URL=http://dev.laptop.org/~cscott/bundles/Analyze-7.xo
|bundle URL=http://dev.laptop.org/~edsiper/bundles/Analyze-8.xo
|activity version=7
|activity version=8
|releases=Candidate
|releases=8.2.0 (767)
|devel status=6. Mature
|devel status=6. Mature
}}
}}

Latest revision as of 00:34, 24 July 2009

?Sugar icon}}    This activity is now hosted at the Sugar Activity Library.

The information here is likely to be out-of-date. Consult the new pages for "Analyze" first:

Activity-analyze.svg

What is Analyze?

Analyze is an Activity that displays your XO's networking, X (graphical) display, and presence service status. It is useful to developers and end-users as an easy way for users to monitor and submit data for monitoring/debugging networking/X issues.

Installing Analyze

Analyze is bundled as an .xo. Analyze-7.xo is the current bundle. See the section on installing Activities.

Using Analyze

Analyze is a very simple Activity. All that you do is tell it what interface you want it to display information from.

To select an interface, click on the "Interfaces" tab at top, and then on the appropriate Interface icon (by default, Analyze will start in the Network Status screen). Read the features list to find out what information should be available in each section. Here are (from left to right) the Network Status, X Server, and Presence Service interface icons.

From left to right: Network Status, X Server, and Presence Service interface icons.

Note that the Presence Service screen has 3 windows. You can drag the window boundaries up and down to resize the area of each sub-display.

Analyze-activity-screenshot-resize.png

Contributing to Analyze

Submitting bugs and feature requests

If you find a bug in Analyze or think of an enhancement you'd like to see it have as a future feature, submit a ticket here. Make sure to set the component to "analyze-activity" so we can all see what component it is for.

Testing

Please see Tests/Activity/Analyze for instructions.

Coding

You can browse the current Activity source code at http://dev.laptop.org/git?p=projects/analyze-activity (includes instructions on how to check it out). To see what work needs to be done, look at the tickets in Trac.

Features

Network Status interface

Networking interface screenshot

This interface displays network interface data from /proc/net/dev. You should see the following information:

  • interface name
  • IP address
  • netmask
  • MAC address
  • bytes received
  • bytes sent
  • packets received
  • packets sent

X Window interface

X Window interface screenshot

This interface displays X window information from the libXres extension. You should see the following information:

  • X window names
  • PIDs
  • resource base
  • pixmap bytes
  • memory usage (other/total)

Presence Service interface

Presence Service interface screenshot

This interface displays Presence Service information, getting data directly from Dbus. It has 3 sections: the presence service event log, Activities (on your Neighborhood) and Buddies (in your Neighborhood).

Presence service event log

The top section of the Presence Service interface is a log of recent presence service events.

Activities (on your Neighborhood)

The middle section of the Presence Service interface is a list of shared Activities visible in Neighborhood view, with the following information for each:

  • object path
  • ID
  • color
  • type
  • name
  • connection
  • channels
  • buddies

Buddies (in your Neighborhood)

The middle section of the Presence Service interface is a list of shared Activities visible in Neighborhood view, with the following information for each:

  • object path
  • pubkey
  • nick
  • owner
  • color
  • IPv4
  • current activity
  • Activities
  • handles

Semantic metadata

Activity Summary

Icon: Sugar icon::Image:Activity-analyze.svg
Genre: Activity genre::Other
Activity group: ,|x|Activity group::x}}
Short description: [[Short description::Analyze is an Activity that displays your XO's networking, X (graphical) display, and presence service status. It is useful to developers and end-users as an easy way for users to monitor and submit data for monitoring/debugging networking/X issues.]]
Description: [[Description::Analyze displays the following information in an easy-to-read format:
  • Network status - displays network interface data from /proc/net/dev.
    • interface name
    • IP address
    • netmask
    • MAC address
    • bytes received
    • bytes sent
    • packets received
    • packets sent
  • X server - Displays X window information from the libXres extension.
    • X window names
    • PIDs
    • resource base
    • pixmap bytes
    • memory usage (other/total)
  • Presence service - displays the following, getting information directly from dbus.
    • a log of presence service activities
    • shared Activities visible in Neighborhood view, with the following information for each:
      • object path
      • ID
      • color
      • type
      • name
      • connection
      • channels
      • buddies
    • buddies visible in Neighborhood view, with the following information for each:
      • object path
      • pubkey
      • nick
      • owner
      • color
      • IPv4
      • current activity
      • Activities
      • handles]]
Maintainers: ,|x|Contact person::x}}
Repository URL: Source code::http://dev.laptop.org/git?p=projects/analyze-activity
Available languages: ,|x|Available languages::x}}
Available languages (codes): ,|x|Language code::x}}
Pootle URL:
Related projects: Related projects,|x|Related projects::x}}
Contributors: ,|x|Team member::x}}
URL from which to download the latest .xo bundle Activity bundle::http://dev.laptop.org/~edsiper/bundles/Analyze-8.xo
Last tested version number: Activity version::8
The releases with which this version of the activity has been tested. ,|x|Software release::x}}
Development status: Devel status::6. Mature
Ready for testing (development has progressed to the point where testers should try it out): ,|x|Ready for testing::x}}
smoke tested :
test plan available :
test plan executed :
developer response to testing :