Pull all reports from Insights

[bmtcril]

To help build the list of reports needed for OARS we need to go through the Insights code and organize a list of the reports.

Reports in the dashboard should all be listed here: https://github.com/openedx/edx-analytics-dashboard/blob/master/analytics_dashboard/courses/urls.py

Most upstream pipeline code that generates the backing tables is here: https://github.com/openedx/edx-analytics-pipeline

Reports should be labeled into buckets:

• Can be done in OARS v1 with existing xAPI events
• Can be done in OARS v1 with new xAPI events
• Cannot be done in OARS v1

And a level of effort for ones that can be done with existing events:

• Low - can be done in less than a day
• Medium - can be done in one-two days
• High - can be done in a week
• Epic - will likely take more than a week

AC:

• A spreadsheet with all existing Insights events with columns for:
  • Links to their locations in GitHub (in dashboard and any upstream pipeline jobs)
  • The above fields for difficulty and ability to be done with existing events
  • Is the report documented and on by default, or is it one of the "too slow to be run by default" / hidden ones
  • What data sources and tracking event types does this report use?
  • Any notes that may be of interest to the implementer

[Ian2012]

Here is a template with the report list https://docs.google.com/spreadsheets/d/1PpnzmJDuZ69P8NMzDCDkwnxyIgwnvmKpIxFnjI-LW7U/edit#gid=0 (WIP)

For the column "Link in any upstream pipeline jobs" should I link the reducer code?

[bmtcril]

This is looking great, thanks for taking on the work! Yes, I was hoping to link back to relevant reducer code there so we can learn from any adjustments that may be present there (if they're relevant).

If you're taking the whole task on, you should be able to comment assign me on this ticket to get it assigned to you. It's done via GH action, so let me know if you run into any issues. Then if you could please update the status to doing that would be great!

[Ian2012]

assign me

[bmtcril]

@Ian2012 are you still doing this task?

[Ian2012]

Not currently @bmtcril

[bmtcril]

Thanks @Ian2012 , I think I've got it as far as it needs to go. Details on the calculations are included in the Insights docs and we won't have anything like the source data they had, so chasing down all of the links to code is probably not worthwhile. I'm going to call this one done!