1298922 - Breakdown: Collect metrics on Activity Stream Usage

Status: RESOLVED FIXED

(Firefox for iOS :: General, defect, P1)

Description

[Stephan Leroux [:sleroux]]

Part of the validation phase of Activity Stream will require us to evaluate how users are using it. Desktop is using a small JSON API server for reporting metrics named Onyx (https://github.com/mozilla/onyx#v3linksactivity-stream). We should investigate what it would take to create a small client on iOS for reporting A-S metrics to the onyx service.

Comment 1

[Stephan Leroux [:sleroux]]

Going to give the new process a try and use this as a breakdown bug for collecting data for AS.

Comment 2

[Stephan Leroux [:sleroux]]

Looking at https://github.com/mozilla/activity-stream/blob/master/data_events.md I have a couple of questions about what we want to do for mobile. Specifically,

* For the source field, do we want to use FEATURED or HIGHLIGHTS for mobile? Not sure if there is a difference between desktop/mobile here.

* Since Activity Stream isn't implemented as an addon, do we want to use addon_version as the application version or does it lose meaning if we do that?

* tab_id, client_id - Are these fields desktop/gecko specific? I'm wondering what mobile should do for these fields.

* Can we send blank metadata_source on mobile? We currently don't use embedly or fathom for any metadata parsing. 

* Do we send url for ‘highlights’ or only for recommendation/pocket driven content? We don't have that on mobile yet.

Comment 3

[Nan Jiang [:nanj]]

Hi Stephan,

Q1: the "source" is a required field, but its values are open-ended and free to change

Q2: the "addon_version" is also a required one, it's being used to track the performance of different releases. If there is no such counterpart for iOS, I think you can use the Firefox version, or "N/A" if you really don't want to populate it

Q3: Yes, those fields are coming from Firefox directly, "client_id" is particularly useful for the following data analysis. For instance, we use this field to associate a couple of performance telemetries in order to do the engagement research

Q4: the "metadata_source" is an "optional" field, you don't need to include it in the payload

Q5: No, we only send urls for recommendation/pocket content, and this field is also optional  


Hope that works,

Nan

Comment 4

[Nan Jiang [:nanj]]

Oops, forgot to mention that "tab_id" and "client_id" are both required field, which means they should be included in the payload all the time, but you can just use some placeholders for them if they're not available on iOS.

Comment 5

[Stephan Leroux [:sleroux]]

Thanks for the input! Marking as closed as I have my work items defined now.