Add tracking logs #206
Add tracking logs #206
Conversation
and adds CHANGELOG entry.
test settings and plugin settings. The previous commit resulted in the COMPLETION_AGGREGATOR_ASYNC_AGGREGATION flag being flipped for some tests -- it was True in test_settings, but False in plugin_settings() So for these tests, we're now overriding that setting as needed.
Ordinary completion events are simply "progress" events with a recorded progress %, so we should do the same here -- no need for "completed" events.
There was a problem hiding this comment.
@pomegranited, before merging this, could you please add information about the tracking logs to the README along with a warning that this can generate plenty of additional events? We should also mention how to turn this off. Please see the "Synchronous vs. Asynchronous calculations" for an example format of this warning.
👍
- I tested this: checked that the tracking events are emitted correctly in sync/async modes, and that they can be turned off
- I read through the code
- I checked for accessibility issues: n/a
- Includes documentation:
⚠️
|
Thank you for your review @Agrendalath !
Good point -- I added a section to the README -- is that clear enough? |
There was a problem hiding this comment.
@pomegranited, the changes look good. I just left some minor suggestions.
|
Thank you @Agrendalath :) I've addressed your comments, thank you! Will merge and tag this change. |
Description:
This PR is the first step for openedx/openedx-aspects#222
It is a rebase of #173 plus:
openedxinstead ofedxopenedx.completion_aggregator.completion.*events -- only emittingprogressProgress events will be emitted indicating any changes to aggregated progress for these block types:
JIRA: FAL-3766 (private link)
Dependencies: dependencies on other outstanding PRs, issues, etc.
Merge deadline: ASAP -- there's follow-up work to come soon.
Installation instructions:
Testing instructions:
tail -f $(tutor config printroot)/data/lms/logs/tracking.log | grep completion_aggregatoropenedx.completion_aggregator.progress.*events coming through to mark the progress towards completion of the units (vertical), subsections (sequential), sections (chapter), and course.Reviewers:
Merge checklist:
Post merge:
finished.