Difference between revisions of "Platform Team/sugar-stats"

From Sugar Labs
Jump to navigation Jump to search
(Another fixed link (I'm trying to find any statistics, folks))
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{Note/note|This is page is about development version.|If you are looking for information about stable release, follow to [[Platform_Team/sugar-stats/0.1|separate page]].}}
 +
 
== Summary ==
 
== Summary ==
  
Line 7: Line 9:
 
* 0.94
 
* 0.94
  
More (0.86+) Sugar version might be added on demand.
+
More (0.86+) Sugar versions might be added on demand.
  
== Stats server ==
+
== Getting the code ==
 
 
Project contains also a server which is based on [[Sugar_Server_Kit/Active_Document|active-document]] and [[Sugar_Server_Kit/RESTful_Document|restful-document]] and designed to be a part of [[Platform_Team/Sugar_Network|Sugar Network]] and [[Sugar Server Kit/sugar-server|sugar-server]] implementations.
 
 
 
Standalone server might be launched using {{Code|sugar-stats-server}} command from project sources. The easiest way is using binary package [http://download.sugarlabs.org/packages/Server:/Factory/ sugar-stats-server]. The package contains:
 
 
 
* {{Code|sugar-stats-server}} command,
 
* {{Code|/etc/sugar-stats.conf}} default configuration,
 
* {{Code|/etc/init.d/sugar-stats}} daemon.
 
 
 
For stats transfering from clients, it is useful to use secure SSL connection. Server configuration needs to be tweaked (the [[Sugar_Server_Kit/sugar-client#Usage statistics|client]] should use the same certificate):
 
 
 
* {{Code|stats-keyfile}}, path to server's private key,
 
* {{Code|stats-certificate}}, path to server's certificate file.
 
  
Server will authenticate clients using SSH keys generated on client side by Sugar Shell. To let server check client signatures, OpenSSH-5.6+ should be installed on server side. For less than 5.6 versions, authentication needs to be disabled using {{Code|trust-users}} parameter.
+
* Gitorious [https://web.archive.org/web/20130725065424/git.sugarlabs.org/desktop/stats sources] repository.
 +
* Binary [http://download.sugarlabs.org/packages/SweetsDistribution:/Factory/ packages] from [[Sweets Distribution]].
  
=== Configuration ===
+
In use, the library does not require any building routines, just provide the full path to the {{Code|active_document/}} subdirectory via the {{Code|PYTHONPATH}} environment variable.
  
Read the {{Code|/etc/sugar-stats.conf}} for explanation or run the following command to get current configuration with comments:
+
See the [http://git.sugarlabs.org/desktop/stats/trees/master/examples examples/] subdirectory in the sources tree for usage examples.
  
sugar-stats-server config
+
=== Library requirements ===
 
 
The important parameters that need to be set before using the server (for sugar-stats-server installed from packages there are initialized by meaningful values):
 
 
 
* {{Code|stats/stats-root <nowiki>=</nowiki> /var/lib/sugar-stats/rrd}}<br>Path to the root directory to place stats;
 
* {{Code|active-document/data-root <nowiki>=</nowiki> /var/lib/sugar-stats/users}}<br>Path to the root directory to place documents' data and indexes;
 
 
 
== Getting the code ==
 
 
 
* Gitorious [http://git.sugarlabs.org/server/stats sources] repository.
 
* Binary [http://download.sugarlabs.org/packages/Server:/Factory/ packages] build for distributions [[Sugar_Server_Kit#Supported_platforms|supported]] by SSK.
 
 
 
Library requires:
 
  
 
* RRDtool [http://oss.oetiker.ch/rrdtool/prog/rrdpython.en.html python binding].
 
* RRDtool [http://oss.oetiker.ch/rrdtool/prog/rrdpython.en.html python binding].
 
For using, library does not require any building routines, just provide full path to the {{Code|active_document/}} subdirectory via {{Code|PYTHONPATH}} environment variable.
 
 
See [http://git.sugarlabs.org/server/stats/trees/master/examples examples/] subdirectory in the sources tree for usage examples.
 
  
 
== See also ==
 
== See also ==
  
* [[Sugar_Server_Kit/sugar-client|sugar-client]] application that uses sugar-stats library.
+
* [[Platform_Team/Server_Kit/sugar-client|sugar-client]] application that uses sugar-stats library.
  
 
== Getting involved ==
 
== Getting involved ==
  
* [http://bugs.sugarlabs.org/newticket?component=sugar-server-kit Report] on bugs.
+
* [https://web.archive.org/web/20130720223915/https://bugs.sugarlabs.org/newticket?component=sugar-server-kit Report] on bugs.
* Read the [http://git.sugarlabs.org/server/stats/blobs/master/HACKING HACKING] file to know how to contribute with code.
+
* Read the [https://web.archive.org/web/20130728113129/git.sugarlabs.org/server/client/blobs/master/HACKING HACKING] file to know how to contribute with code.

Latest revision as of 15:24, 6 September 2024

35px-Activity-write.png
This is page is about development version.
If you are looking for information about stable release, follow to separate page.

Summary

Library to gather Sugar usage statistics. The gathering method is based on sniffing DBus and X11 events.

Supported Sugars

  • 0.94

More (0.86+) Sugar versions might be added on demand.

Getting the code

In use, the library does not require any building routines, just provide the full path to the active_document/ subdirectory via the PYTHONPATH environment variable.

See the examples/ subdirectory in the sources tree for usage examples.

Library requirements

See also

Getting involved

  • Report on bugs.
  • Read the HACKING file to know how to contribute with code.