151bd13666
* Generate common/djangoapps import shims for LMS * Generate common/djangoapps import shims for Studio * Stop appending project root to sys.path * Stop appending common/djangoapps to sys.path * Import from common.djangoapps.course_action_state instead of course_action_state * Import from common.djangoapps.course_modes instead of course_modes * Import from common.djangoapps.database_fixups instead of database_fixups * Import from common.djangoapps.edxmako instead of edxmako * Import from common.djangoapps.entitlements instead of entitlements * Import from common.djangoapps.pipline_mako instead of pipeline_mako * Import from common.djangoapps.static_replace instead of static_replace * Import from common.djangoapps.student instead of student * Import from common.djangoapps.terrain instead of terrain * Import from common.djangoapps.third_party_auth instead of third_party_auth * Import from common.djangoapps.track instead of track * Import from common.djangoapps.util instead of util * Import from common.djangoapps.xblock_django instead of xblock_django * Add empty common/djangoapps/__init__.py to fix pytest collection * Fix pylint formatting violations * Exclude import_shims/ directory tree from linting
100 lines
2.4 KiB
Python
100 lines
2.4 KiB
Python
"""
|
|
WARNING! track.tracker module is deprecated please use eventtracking app to track events
|
|
Module that tracks analytics events by sending them to different
|
|
configurable backends.
|
|
|
|
The backends can be configured using Django settings as the example
|
|
below::
|
|
|
|
TRACKING_BACKENDS = {
|
|
'tracker_name': {
|
|
'ENGINE': 'class.name.for.backend',
|
|
'OPTIONS': {
|
|
'host': ... ,
|
|
'port': ... ,
|
|
...
|
|
}
|
|
}
|
|
}
|
|
|
|
"""
|
|
|
|
|
|
import inspect
|
|
import warnings
|
|
from importlib import import_module
|
|
|
|
import six
|
|
from django.conf import settings
|
|
|
|
from common.djangoapps.track.backends import BaseBackend
|
|
|
|
__all__ = ['send']
|
|
|
|
|
|
backends = {}
|
|
|
|
|
|
def _initialize_backends_from_django_settings():
|
|
"""
|
|
Initialize the event tracking backends according to the
|
|
configuration in django settings
|
|
|
|
"""
|
|
backends.clear()
|
|
|
|
config = getattr(settings, 'TRACKING_BACKENDS', {})
|
|
|
|
for name, values in six.iteritems(config):
|
|
# Ignore empty values to turn-off default tracker backends
|
|
if values:
|
|
engine = values['ENGINE']
|
|
options = values.get('OPTIONS', {})
|
|
backends[name] = _instantiate_backend_from_name(engine, options)
|
|
|
|
|
|
def _instantiate_backend_from_name(name, options):
|
|
"""
|
|
Instantiate an event tracker backend from the full module path to
|
|
the backend class. Useful when setting backends from configuration
|
|
files.
|
|
|
|
"""
|
|
# Parse backend name
|
|
|
|
try:
|
|
parts = name.split('.')
|
|
module_name = '.'.join(parts[:-1])
|
|
class_name = parts[-1]
|
|
except IndexError:
|
|
raise ValueError('Invalid event track backend %s' % name)
|
|
|
|
# Get and verify the backend class
|
|
|
|
try:
|
|
module = import_module(module_name)
|
|
cls = getattr(module, class_name)
|
|
if not inspect.isclass(cls) or not issubclass(cls, BaseBackend):
|
|
raise TypeError
|
|
except (ValueError, AttributeError, TypeError, ImportError):
|
|
raise ValueError('Cannot find event track backend %s' % name)
|
|
|
|
backend = cls(**options)
|
|
|
|
return backend
|
|
|
|
|
|
def send(event):
|
|
"""
|
|
Send an event object to all the initialized backends.
|
|
|
|
"""
|
|
warnings.warn(
|
|
'track.tracker module is deprecated. Please use eventtracking to send events.', DeprecationWarning
|
|
)
|
|
for name, backend in six.iteritems(backends):
|
|
backend.send(event)
|
|
|
|
|
|
_initialize_backends_from_django_settings()
|