Skip to content

Commit

Permalink
fix: address PR review
Browse files Browse the repository at this point in the history
  • Loading branch information
pomegranited committed Jun 20, 2024
1 parent 29f6b89 commit 1a4d5f6
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ Event tracking

Like other parts of Open edX, the completion aggregator emits "tracking logs" events whenever completion aggregator records are created or updated by this plugin. These events can be used for analytics, for example to track learner progress in a course.

Event tracking is enabled by default for edx-platform, and so event tracking is also enabled by default in the completion aggregator. This can result in a lot of events being generated -- for example when a user completes the final block in a course, aggregator completion events will be generated for the containing unit, subsection, section, and course.
Event tracking is enabled by default for edx-platform, and so event tracking is also enabled by default in the completion aggregator. This can result in a lot of events being generated for example when a user completes the final block in a course, aggregator completion events will be generated for the containing unit, subsection, section, and course.

You can limit which aggregator events are emitted by modifying the `COMPLETION_AGGREGATOR_TRACKING_EVENT_TYPES` setting to limit which block types (`course`, `chapter`, `sequential`, `vertical`) cause tracking events to be emitted. To disable sending any completion aggregator tracking events, set `COMPLETION_AGGREGATOR_TRACKING_EVENT_TYPES = None`.
You can limit which aggregator events are emitted by modifying the ``COMPLETION_AGGREGATOR_TRACKING_EVENT_TYPES`` setting to limit which block types (``course``, ``chapter``, ``sequential``, ``vertical``) cause tracking events to be emitted. To disable sending any completion aggregator tracking events, set ``COMPLETION_AGGREGATOR_TRACKING_EVENT_TYPES = None``.

Installation and Configuration
------------------------------
Expand Down
2 changes: 1 addition & 1 deletion completion_aggregator/settings/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def plugin_settings(settings):
# Emit feature publishes progress events to track aggregated completion.
# Defaults to the full set of block types subject to completion aggregation.
# Block types may be removed from this list to limit the tracking log events emitted.
settings.COMPLETION_AGGREGATOR_TRACKING_EVENT_TYPES = settings.COMPLETION_AGGREGATOR_BLOCK_TYPES
settings.COMPLETION_AGGREGATOR_TRACKING_EVENT_TYPES = settings.COMPLETION_AGGREGATOR_BLOCK_TYPES.copy()

# Synchronous completion aggregation is enabled by default
settings.COMPLETION_AGGREGATOR_ASYNC_AGGREGATION = False
Expand Down

0 comments on commit 1a4d5f6

Please sign in to comment.