Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Part of edX code
__.
The event-tracking
library tracks context-aware semi-structured system events.
It captures and stores events with nested data structures in order to truly
take advantage of schemaless data storage systems.
Key features:
Example::
from eventtracking import tracker
tracker = tracker.get_tracker()
tracker.enter_context('outer', {'user_id': 10938})
tracker.emit('navigation.request', {'url': 'http://www.edx.org/some/path/1'})
with tracker.context({'user_id': 11111, 'session_id': '2987lkjdyoioey'}):
tracker.emit('navigation.request', {'url': 'http://www.edx.org/some/path/2'})
tracker.emit(
'address.create',
{
'name': 'foo',
'address': {
'postal_code': '90210',
'country': 'United States'
}
}
)
Running the above example produces the following events::
{
"name": "navigation.request",
"timestamp": ...,
"context": {
"user_id": 10938
},
"data": {
"url": "http://www.edx.org/some/path/1"
}
},
{
"name": "navigation.request",
"timestamp": ...,
"context": {
"user_id": 11111,
"session_id": "2987lkjdyoioey"
},
"data": {
"url": "http://www.edx.org/some/path/2"
}
},
{
"name": "address.create",
"timestamp": ...,
"context": {
"user_id": 10938
},
"data": {
"name": "foo",
"address": {
"postal_code": "90210",
"country": "United States"
}
}
}
Configuration for event-tracking
takes the form of a tree of backends. When a Tracker
is instantiated, it creates a root RoutingBackend
object using the top-level backends and processors that are passed to it. (Or in the case of the DjangoTracker
, the backends and processors are constructed according to the appropriate Django settings.)
In this RoutingBackend
, each event is first passed through the chain of processors in series, and then distributed to each backend in turn. Theoretically, these backends might be the Mongo, Segment, or logger backends, but in practice these are wrapped by another layer of RoutingBackend
. This allows each one to have its own set of processors that are not shared with other backends, allowing independent filtering or event emit cancellation.
Considering the volume of the events being generated, we would want to avoid processing events in the main thread that could cause delays in response depending upon the operations and event processors.
event-tracking
provides a solution for this i.e. AsyncRoutingBackend
.
It extends RoutingBackend
but performs its operations asynchronously.
It can:
Handling the operations asynchronously would avoid overburdening the main thread and pass the intensive processing tasks to celery workers.
Limitations: Although backends for RoutingBackend
can be configured
at any level of EVENT_TRACKING_BACKENDS
configuration tree,
AsyncRoutingBackend
only supports backends defined at the root level of
EVENT_TRACKING_BACKENDS
setting. It is also only possible to use it
successfully from the default tracker.
An example configuration for AsyncRoutingBackend
is provided below::
EVENT_TRACKING_BACKENDS = {
'caliper': {
'ENGINE': 'eventtracking.backends.async_routing.AsyncRoutingBackend',
'OPTIONS': {
'backend_name': 'caliper',
'processors': [
{
'ENGINE': 'eventtracking.processors.regex_filter.RegexFilter',
'OPTIONS':{
'filter_type': 'allowlist',
'regular_expressions': [
'edx.course.enrollment.activated',
'edx.course.enrollment.deactivated',
]
}
}
],
'backends': {
'caliper': {
'ENGINE': 'dummy.backend.engine',
'OPTIONS': {
...
}
}
},
},
},
'tracking_logs': {
...
}
...
}
event-tracking
provides a solution for routing events to the Event Bus
using the EventBusBackend
. It extends RoutingBackend
but sends events
to the Event Bus.
It can:
EVENT_BUS_TRACKING_LOGS
, send it to the Event Bus.Make sure to enable the setting: SEND_TRACKING_EVENT_EMITTED_SIGNAL
to allow the
EventBusBackend
to send events to the Event Bus.
An example configuration for EventBusBackend
is provided below::
EVENT_TRACKING_BACKENDS = {
'xapi': {
'ENGINE': 'eventtracking.backends.event_bus.EventBusBackend',
'OPTIONS': {
'backend_name': 'xapi',
'processors': [
{
'ENGINE': 'eventtracking.processors.regex_filter.RegexFilter',
'OPTIONS':{
'filter_type': 'allowlist',
'regular_expressions': [
'edx.course.enrollment.activated',
'edx.course.enrollment.deactivated',
]
}
}
],
'backends': {
'xapi': {
'ENGINE': 'dummy.backend.engine',
'OPTIONS': {
...
}
}
},
},
},
'tracking_logs': {
...
}
...
}
EVENT_BUS_TRACKING_LOGS = [
'edx.course.enrollment.activated',
'edx.course.enrollment.deactivated',
]
In the very near future the following features are planned:
Latest documentation <http://event-tracking.readthedocs.org/en/latest/>
_ (Hosted on Read the Docs)
The code in this repository is licensed under version 3 of the AGPL unless otherwise noted.
Please see LICENSE.txt
for details.
Contributions are very welcome.
Please read How To Contribute <https://github.com/openedx/edx-platform/wiki/How-To-Contribute>
_ for details.
Please do not report security issues in public. Please email security@openedx.org
You can discuss this code on the edx-code Google Group
__ or in the
edx-code
IRC channel on Freenode.
__ https://groups.google.com/forum/#!forum/edx-code
.. |build-status| image:: https://github.com/openedx/event-tracking/workflows/Python%20CI/badge.svg?branch=master :target: https://github.com/openedx/event-tracking/actions?query=workflow%3A%22Python+CI%22
FAQs
A simple event tracking system.
We found that event-tracking demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.