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

Revision as of 19:41, 7 March 2012

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.

Stats server

This project also contains a server, which is based on active-document and restful-document, and is designed to be a part of the Sugar Network and sugar-server implementations.

A standalone server might be launched using the sugar-stats-server command from project sources. The easiest way is using the binary package sugar-stats-server. The package contains these components:

sugar-stats-server command,
/etc/init.d/sugar-stats-server daemon.

For stats transferring from clients, it is useful to use secure, SSL connections. The server configuration needs to be tweaked (and the client should use the same certificate):

keyfile, path to server's private key,
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 trust-users parameter.

Configuration

Run the following command to get the current configuration with comments:

sugar-stats-server config

To tweak current configuration, change/create /etc/sugar-stats-server.conf configuration file.

The following important parameters need to be set before using the server. (When sugar-stats-server is installed from packages, they are initialized to meaningful values.):

stats/stats-root = /var/lib/sugar-network/rrd
Path to the root directory for placing stats;
active-document/data-root = /var/lib/sugar-network/users
Path to the root directory for placing users' metadata;

Implementation notes

Calculating network.school stat.

Detecting if client host is in school network or not is based on resolving am.i.at.school hostname.

Getting the code

Gitorious sources repository.
Binary packages build for distributions supported by SSK.

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 16: / Line 16: @@
 * {{Code|sugar-stats-server}} command,
-* {{Code|/etc/sugar-stats.conf}} default configuration,
+* {{Code|/etc/init.d/sugar-stats-server}} daemon.
-* {{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):
-* {{Code|stats-keyfile}}, path to server's private key,
+* {{Code|keyfile}}, path to server's private key,
-* {{Code|stats-certificate}}, path to server's certificate file.
+* {{Code|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.
@@ Line 28: / Line 27: @@
 === Configuration ===
-Read the {{Code|/etc/sugar-stats.conf}} for explanation, or run the following command to get the current configuration with comments:
+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.):
+To tweak current configuration, change/create {{Code|/etc/sugar-stats-server.conf}} configuration file.
-* {{Code|stats/stats-root <nowiki>=</nowiki> /var/lib/sugar-stats/rrd}}<br>Path to the root directory for placing stats;
+The following 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|active-document/data-root <nowiki>=</nowiki> /var/lib/sugar-stats/users}}<br>Path to the root directory for placing users' metadata;
+* {{Code|stats/stats-root <nowiki>=</nowiki> /var/lib/sugar-network/rrd}}<br>Path to the root directory for placing stats;
+* {{Code|active-document/data-root <nowiki>=</nowiki> /var/lib/sugar-network/users}}<br>Path to the root directory for placing users' metadata;
 == Implementation notes ==