Skip to main content

Open edX Caliper Tracking app can be used to transform Open edX tracking events into Caliper standard compliant events.

Project description


Open edX Caliper Tracking can be used to transform the edX traditional event logs into Caliper Analytics Specifications provided by IMS Global. Generated logs can be consumed by any analytics application which is compatible with Caliper Standard.


To install openedx-caliper-tracking in your Open edX installation, please add the following line to your requirements file. (For most Open edX installations it should be located at edx-platform/requirements/edx/base.txt):



To enable and use openedx-caliper-tracking:

Please add ENABLE_EVENT_CALIPERIZATION flag under FEATURES in the following files:

  • /edx/app/edxapp/lms.env.json
  • /edx/app/edxapp/cms.env.json

These files should be located at /edx/app/edxapp/ directory, see the example below:




Location of Transformed Logs

Transformed events are logged using ‘logging.handlers.SysLogHandler’ with ‘facility: local2’.

We need to create output files manually and set appropriate permissions for syslog user. To do so, please follow the steps below:

  1. Create a log file with read/write permissions given to syslog user e.g: /edx/var/log/caliper-analytics/caliper.log

  2. Create a mapping for ‘local2’ in the configuration files present in /etc/rsyslog.d/

    local2.*                 /edx/var/log/caliper-analytics/caliper.log


The code in this repository is licensed under the GPL v3.0 unless otherwise noted. Please see LICENSE for details.

How To Contribute

To contribute, please make a pull request in this repositry on Github: Open edX Caliper Tracking. If you have any question or issue, please feel free to open an issue on Github: Open edX Caliper Tracking.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for openedx-caliper-tracking, version 0.11.1
Filename, size File type Python version Upload date Hashes
Filename, size openedx_caliper_tracking-0.11.1-py2-none-any.whl (326.2 kB) File type Wheel Python version py2 Upload date Hashes View hashes
Filename, size openedx-caliper-tracking-0.11.1.tar.gz (124.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page