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

Latest revision as of 16:05, 8 October 2012

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

Gitorious sources repository.
Binary packages from Sweets Distribution.

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

RRDtool python binding.

Getting involved

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

@@ 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 ==
@@ Line 9: / Line 11: @@
 More (0.86+) Sugar versions might be added on demand.
-== Stats server ==
+== Getting the code ==
-This project also contains a server, which is based on [[Sugar_Server_Kit/Active_Document|active-document]] and [[Sugar_Server_Kit/RESTful_Document|restful-document]], and is designed to be a part of the [[Platform_Team/Sugar_Network|Sugar Network]] and [[Sugar Server Kit/sugar-server|sugar-server]] implementations.
+* Gitorious [http://git.sugarlabs.org/desktop/stats sources] repository.
+* Binary [http://download.sugarlabs.org/packages/SweetsDistribution:/Factory/ packages] from [[Sweets Distribution]].
-A standalone server might be launched using the {{Code|sugar-stats-server}} command from project sources. The easiest way is using the binary package [http://download.sugarlabs.org/packages/Server:/Factory/ sugar-stats-server]. The package contains these components:
+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.
-* {{Code|sugar-stats-server}} command,
+See the [http://git.sugarlabs.org/desktop/stats/trees/master/examples examples/] subdirectory in the sources tree for usage examples.
-* {{Code|/etc/sugar-stats.conf}} default configuration,
-* {{Code|/etc/init.d/sugar-stats}} daemon.
-For stats transferring from clients, it is useful to use secure, SSL connections. The server configuration needs to be tweaked (and the [[Sugar_Server_Kit/sugar-client#Usage statistics|client]] should use the same certificate):
+=== Library requirements ===
-* {{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 the client side by Sugar Shell. To let the server check client signatures, OpenSSH-5.6+ should be installed on the server side. For versions lower than 5.6, authentication needs to be disabled using the {{Code|trust-users}} parameter.
-=== Configuration ===
-Read the {{Code|/etc/sugar-stats.conf}} for explanation, or run the following command to get the current configuration with comments:
- sugar-stats-server config
-These important parameters need to be set before using the server. (When sugar-stats-server is installed from packages, they are initialized to meaningful values.):
-* {{Code|stats/stats-root <nowiki>=</nowiki> /var/lib/sugar-stats/rrd}}<br>Path to the root directory for placing stats;
-* {{Code|active-document/data-root <nowiki>=</nowiki> /var/lib/sugar-stats/users}}<br>Path to the root directory for placing 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 requirements===
 * RRDtool [http://oss.oetiker.ch/rrdtool/prog/rrdpython.en.html python binding].
-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.
-See the [http://git.sugarlabs.org/server/stats/trees/master/examples examples/] subdirectory in the sources tree for usage examples.
 == 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 ==
 * [http://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 [http://git.sugarlabs.org/desktop/stats/blobs/master/HACKING HACKING] file to know how to contribute with code.

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

Latest revision as of 16:05, 8 October 2012

Contents

Summary

Supported Sugars

Getting the code

Library requirements

See also

Getting involved

Navigation menu

Search