https://github.com/javi-aranda/edx-analytics-logger

Simple yet powerful OpenEdX plugin to send event tracking logs to a remote service in order to store additional information about user activity to perform analytic research.
https://github.com/javi-aranda/edx-analytics-logger

openedx pypi-package python

Last synced: 7 days ago
JSON representation

Simple yet powerful OpenEdX plugin to send event tracking logs to a remote service in order to store additional information about user activity to perform analytic research.

• Host: GitHub
• URL: https://github.com/javi-aranda/edx-analytics-logger
• Owner: javi-aranda
• License: mit
• Created: 2023-02-10T15:19:21.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-08-07T12:25:53.000Z (over 1 year ago)
• Last Synced: 2024-12-17T13:09:20.066Z (20 days ago)
• Topics: openedx, pypi-package, python
• Language: Python
• Homepage:
• Size: 25.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![PyPI version](https://badge.fury.io/py/edx-analytics-logger.svg)](https://badge.fury.io/py/edx-analytics-logger)

[![codecov](https://codecov.io/gh/javi-aranda/edx-analytics-logger/branch/master/graph/badge.svg)](https://codecov.io/gh/javi-aranda/edx-analytics-logger)

# EdX Analytics Logger

Simple yet powerful OpenEdX plugin to send event tracking logs to a remote 

service in order to store additional information about user activity to perform

analytic research.

## Usage with Tutor

This plugin has been tested with OpenEdX Lilac running under Tutor.

For more information about how to add custom requirements to a OpenEdX running

under Tutor see: [XBlock and edx-platform plugin development](https://docs.tutor.overhang.io/dev.html#xblock-and-edx-platform-plugin-development)

Once the package is added, you can add the `ApiBackend` to your CMS/LMS

settings. To do this, you should override the default `TRACKING_BACKENDS` and

`EVENT_TRACKING_BACKENDS` from `cms/envs/common.py` and `lms/evns/common.py`

settings files.

```python

TRACKING_BACKENDS['api'] = {

    'ENGINE': 'edx_analytics_logger.api.ApiBackend',

    'OPTIONS': {

        'http_method': 'POST'

        'endpoint': '',

        'headers': {

            'Content-type': 'application/json',

            'Authorization': 'Token ',

            # ...

        }

    }

}

EVENT_TRACKING_BACKENDS['tracking_logs']['OPTIONS']['backends']['api'] = {

    'ENGINE': 'edx_analytics_logger.api.ApiBackend',

    'OPTIONS': {

        'http_method': 'POST'

        'endpoint': '',

        'headers': {

            'Content-type': 'application/json',

            'Authorization': 'Token ',

            # ...

        }

    }

}

```

This could be accomplished by writing a custom plugin to add these settings in

CMS/LMS settings.

## Additional notes

This project has been tested using Django REST Framework service as backend. 

OpenEdX Analytics Logger could be hugely improved to support more settings, 

authentication mechanisms and more options. Feel free to contribute by

reporting bugs, suggesting improvements or opening Pull Requests.