Site Stats

Initial Documentation

What the project aims to accomplish and who should benefit from it - explained in clear, simple language.

The Sakai SiteStats tool allows authorized users to view site usage statistics. The tool aggregates events generated by other Sakai tools to present site-specific statistics regarding user visits, tool activity, and resource activity. The presented information is typically consulted by site maintainers, but is also useful for help desk and support activities. Current features are listed here.

Which institutions and individuals are committed to it, for how long, and in what roles.

Nuno Fernandes, from Universidade Fernando Pessoa (UFP), is leading the project since its conception and is responsible for the majority of the tool development. Feliz Gouveia and Luís Gouveia (UFP) worked on the design of v1.0, and revise and test current versions.

Occasional contributions are/have been made by David Roldán Martinez (Universidad Politecnica de Valencia), Anthony Whyte (University of Michigan), Jason Shao (CampusEAI Consortium) and Denny (Wicaksana).

At least, the following institutions have reported that are using SiteStats in production: Universidade Fernando Pessoa (UFP), University of Cape Town (UCT), UNISA, Universidad Politécnica de Valencia (UPV), Indiana University (IU), University of Colombia, Claremont Colleges, University of Windsor, Georgia Tech, University of Hawaii.

What other components or projects, if any, does this project relate to or depend upon?

The tool currently has compile and runtime dependencies on the following Sakai projects: K1, Scheduler (Quartz Jobs) and EntityBroker.

Links to any proof-of-concept code, wireframes, or other documentation that may exist at this point.

Source code repository is available at: https://source.sakaiproject.org/contrib/ufp/sitestats

The SiteStats confluence page provides information regarding feature list, installation, configuration, performance tips and screenshots. Additionally, the tool provides help contents available through the help context button when placed on a Sakai site.

What does the project know and not know about how it will achieve its aims at this point?

SiteStats have been growing and getting mature over the last 2.5 years, and all of the initial objectives have been accomplished with the 1.0 release. Currently at the 2.0 release, the tool has many UX, performance and feature improvements over the previous releases, and points its direction to UX improvements and improved reporting capabilities to end-users. SiteStats depends on events generated by other Sakai tools to do its work; as such, SiteStats has contributed in several ways to the event system of Sakai, by making more tools generate events, or more meaningful events, and by helping normalize the event information format.

What public communication methods are being used, how may a curious person contribute to or track the project?

The confluence page links to the SiteStats JIRA space where users can list/add feature requests, bugs and contributions. As alternative communication channels, the Sakai Development mailing list, the provided email address on confluence page and personal email address can be used to contact the development team.

For users aiming to logs their tools events to SiteStats, a separate page with instructions have been provided.

For deployers adopting a SiteStats branch (recommended for production), confluence page also provides RSS feeds for SiteStats 2.0 branch updates: 2.5.x and 2.6.x.

Ongoing Documentation