1259786 - Send telemetry data in new Heartbeat action

Status: RESOLVED FIXED

(Shield :: General, defect)

Description

[Osmose [:osmose, :mkelly]]

The existing heartbeat recipe sends some extra data to telemetry via the call to showHeartbeat: https://github.com/mozilla/self-repair-server/blob/2bd2b44508110152f4bc724cbec64c8276a6da5f/src/recipes/heartbeat-by-user-first-impression/index.js#L218

The survey ID appears to be a unique slug of some kind. Recipes don't have any unique slugs in the database, so I think instead we'll need to add another argument to the action and have admins manually enter the survey ID.

The variation ID seems to be a version number that is increased every time a change is made to the survey code. We have a revision_id value on recipes that increases automatically whenever they're saved that we can use for this. However, the name of the parameter suggests that it's meant to identify which variant of the survey the user has received. Using the revision_id would give the same variation ID even if we sent three survey variants to the user and they only see one of them.

Alternatively, we could use the positional ID of the survey variants (survey 1, survey 2, etc. in the admin interface) and pass that as the variant ID. This would run into problems when someone in the admin changes those variants, because we'd be using different language but the same ID. But maybe that's okay.

Comment 1

[Osmose [:osmose, :mkelly]]

gregglind: Can you shed some light on the purpose of these values and what data we should be passing for them with the new Heartbeat action?

Comment 2

[Gregg Lind (Fx Strategy and Insights - Shield - Heartbeat )]

Some notes on heartbeat as she is spoke:

- survey_id:  is a controlled field.  Unless it's whitelisted, it won't upload. 
  (controlled at:  https://input.mozilla.org/en-US/analytics/hbsurveys)
  
  This *should* be a 'recipe' level field, probably.

- question_id, question_text, variation_id:  3 fields to 'say more', so that `group by` works in analysis well.


http://fjord.readthedocs.org/en/latest/hb_api.html

Comment 3

[Osmose [:osmose, :mkelly]]

Fixed in https://github.com/mozilla/normandy-actions/commit/8140a5250301b260c5ec4b842896c3f6acba19e9.