Standards instrumentation

[clareconstantine]

We want to add instrumentation to track various actions related to Standards in the teacher dashboard. This adds logging for the following events:

• Click "Update Unplugged Lessons" button (event: 'click_update_unplugged_lessons')
• Click "Generate Report" button (event: 'open_generate_report_dialog')
• Click button in generate report dialog to actually generate report (event: 'generate_report')
• Adding a comment to the report (when they click to generate a report (event: 'generate_report'), data_json.added_or_updated_comment: true or false)
• Clicking lesson links in the table in the report (event: 'click_lesson_progress_box', data_json: {link: lesson plan link clicked, in_report: true or false in the print report view})
• Clicking lesson links in the unplugged lesson dialog (event: 'click_unplugged_lesson_link', data_json: {link: lesson plan link clicked})
• Updating unplugged lesson status (event: 'update_unplugged_lesson_list', data_json: changed_lesson_id: id of the lesson that was selected or unselected, lesson_selected: true or false if the lesson was selected , dialog: which dialog it was clicked in (LessonStatusDialog or CreateStandardsReportDialog) )
• View within the progress tab (This is an existing firehose event from adding metrics to progress tab previously:

        study: 'teacher_dashboard_actions',
        study_group: 'progress',
        event: 'view_change_toggle'
        data_json:
              old_view: which area of progress tab you are coming from (summary, detail, standards)
              new_view: which area of the progress tab you are going to

The firehose events are formatted following this convention, initially defined here:

      {
        study: 'teacher_dashboard_actions',
        study_group: 'standards',
        event: <name of event>,
        user_id: <teacher ID>,
        data_json: JSON.stringify({
          section_id: this.props.sectionId,
          script_id: this.props.scriptId
        })
      }
    );

Links

• spec
• jira

Testing story

Tested metrics logging locally

Reviewer Checklist:

• Tests provide adequate coverage
• Code is well-commented
• New features are translatable or updates will not break translations
• Relevant documentation has been added or updated
• User impact is well-understood and desirable
• Pull Request is labeled appropriately
• Follow-up work items (including potential tech debt) are tracked and linked

[Erin007]

So much good data here! Excited to see how this feature is used and best ways to modify to better help teachers.

[fontie715]

This looks good to me - the only thing I'd say is making sure we're recording section_id and script_id with most (if not all) of these data points. Thanks Dani!

[dmcavoy]

@fontie715 - We are recording section id and script id for everything. I didn't mention it because I was just calling out the specifics for each one.