Skip to content

Islandora/islandora_usage_stats

 
 

Repository files navigation

Islandora Usage Stats Build Status

Introduction

A module that tracks views and downloads of Islandora items, as well as solr searches, in the Drupal database.

Features include:

  • ability to ignore common bots, with a configurable regex bot filter
  • ability to ignore repeated requests based on session variables, with a default cooldown period of 5 minutes
  • ability to ignore requests from specific IP addresses for testing/developing/administration
  • Views integration

Islandora Usage Stats provides the back-end framework and gathers usage data, which can be exposed through custom Views or additional modules. It also provides some built-in tools for exposing usage information.

Caution:

  • This module, and the views/blocks it generates, does not respect XACML or namespace restrictions.
  • As this is a server-side tracking solution, a caching layer can prevent usage from being accurately recorded. If this is impacting you, a solution using JavaScript may work better for you. Community solutions include discoverygarden's Google Analytics module and Diego Pino's Matomo module.

Requirements

This module requires the following modules/libraries:

This module can be extended with the following Islandora community/Drupal contrib modules:

Installation

Install as usual, see this for further information.

Usage

The data collected by Islandora Usage Stats is made available to Views, so custom reports can be created. It also works with community modules such as Islandora Usage Stats Callbacks or Islandora Usage Stats Charts to provide more functionality. These modules are not part of Islandora's official releases.

Out of the box, Islandora usage stats can also provide:

  • Views of usage stats on Collection overview pages
  • A View of object page views at Reports > Islandora Usage Stats Reports
  • Several customizable blocks to display the most popular objects
  • A customizable block to show collection usage stats

Configuration

Configuration options are available at Islandora » Islandora Utility Modules » Islandora Usage Stats Settings (admin/islandora/tools/islandora_usage_stats).

Configuration

Documentation

Further documentation for this module is available at our wiki.

Troubleshooting/Issues

Having problems or solved a problem? Check out the Islandora google groups for a solution.

Maintainers/Sponsors

Work based on code from https://github.com/roblib/islandora_scholar_upei and the scholar_tracking module for Drupal 6. Iterated on by Ryerson University Library and Archives (RULA) and discoverygarden inc.

Current maintainers:

Sponsors:

Development

If you would like to contribute to this module, please check out CONTRIBUTING.md. In addition, we have helpful Documentation for Developers info, as well as our Developers section on the Islandora.ca site.

License

GPLv3

About

Track views of islandora items

Topics

Resources

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 99.9%
  • CSS 0.1%