Skip to content

Commit

Permalink
feat: add signal for event-tracking emission
Browse files Browse the repository at this point in the history
  • Loading branch information
Ian2012 committed Jun 5, 2023
1 parent 7c0044a commit 2982b33
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ Change Log
Unreleased
----------
Added
~~~~~
* Added new event TRACKING_EVENT_EMITTED.

[8.0.1] - 2023-05-16
--------------------
Expand Down
6 changes: 6 additions & 0 deletions openedx_events/analytics/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
"""
Package where events related to the analytics subdomain are implemented.
The analytics subdomain corresponds to {Architecture Subdomain} defined in
the OEP-41.
"""
31 changes: 31 additions & 0 deletions openedx_events/analytics/data.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
"""
Data attributes for events within the architecture subdomain ``analytics``.
These attributes follow the form of attr objects specified in OEP-49 data
pattern.
The attributes for the events come from the CourseDetailView in the LMS, with some unused fields removed
(see deprecation proposal at https://github.com/openedx/public-engineering/issues/160)
"""

from datetime import datetime

import attr


@attr.s(frozen=True)
class TrackingLogData:
"""
Data describing tracking log data.
Arguments:
name (str): course name
timestamp (datetime): course start date
data (dict): dictionary of extra data (optional), e.g. {"course_id": "course-v1:edX+DemoX+Demo_Course"}
context (dict): dictionary of context data, defined in https://edx.readthedocs.io/projects/devdata/en/latest/internal_data_formats/tracking_logs/common_fields.html
"""

name = attr.ib(type=str)
timestamp = attr.ib(type=datetime)
data = attr.ib(type=dict, default={})
context = attr.ib(type=dict, factory=dict)
23 changes: 23 additions & 0 deletions openedx_events/analytics/signals.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
"""
Standardized signals definitions for events within the architecture subdomain ``analytics``.
All signals defined in this module must follow the name and versioning
conventions specified in OEP-41.
They also must comply with the payload definition specified in
docs/decisions/0003-events-payload.rst
"""

from openedx_events.analytics.data import TrackingLogData
from openedx_events.tooling import OpenEdxPublicSignal

# .. event_type: org.openedx.analytics.event_tracking.emitted.v1
# .. event_name: TRACKING_EVENT_EMITTED
# .. event_description: emitted when a tracking log is created.
# .. event_data: TrackingLogData
TRACKING_EVENT_EMITTED = OpenEdxPublicSignal(
event_type="org.openedx.analytics.event_tracking.emitted.v1",
data={
"tracking_log": TrackingLogData,
}
)

0 comments on commit 2982b33

Please sign in to comment.