1888430 - Feature Request: Add page_id to glean.js metrics

Status: RESOLVED FIXED

(Data Platform and Tools :: Glean: SDK, enhancement, P1)

Description

[Wil Stuckey]

Because we are not including page url on click or other non page_load events. It would be very helpful for analysis of what happens on a given page to have a page_id metric on all the glean.js pings that is incremented or updated on whenever a new page is loaded.

We can create this in analysis but it makes for more complicated queries, see the following query to build page_ids:

select
    *,
    -- Increment the page_id every time we see a page_load per session and ordered by submission time.
    sum(if(event_name = 'page_load', 1, 0)) over (sessison_window) page_id
  from `moz-fx-data-shared-prod.debug_ping_view.events_stream`
  where submission_timestamp >= timestamp_sub(current_timestamp(), interval 3 day)
  window session_window as (partition by client_info.session_id order by submission_timestamp)

Comment 1

[Alessio Placitelli [:Dexter]]

Would you kindly set this up as a mentored bug for somebody on our team? I'd like somebody other than you to work on it :)

Comment 2

[Travis Long [:travis_]]

I can do this, probably in the next week or so

Comment 3

[BMO Github Automation]

Attachment: [mozilla/glean.js] Bug 1888430 - Add `page_id` to Glean automatic events (#1919)

Comment 4

[Travis Long [:travis_]]

Attachment: Data Collection Request

Comment 5

[Charlie Humphreys [:charlie] [:jeddai]]

Comment on attachment 9397568 [details]
Data Collection Request

Data Review Form

1. Is there or will there be documentation that describes the schema for the ultimate data set in a public, complete, and accurate way?
   This collection is documented in the Glean Dictionary for any Glean.js consuming application

2. Is there a control mechanism that allows the user to turn the data collection on and off? (Note, for data collection not needed for security purposes, Mozilla provides such a control mechanism) Provide details as to the control mechanism available.
   Through the standard telemetry preference in the application settings

3. If the request is for permanent data collection, is there someone who will monitor the data over time?
   Travis Long ([e-mail])

4. Using the category system of data types on the Mozilla wiki, what collection type of data do the requested measurements fall under?
   Category 1 — technical data

5. Is the data collection request for default-on or default-off?
   default-on

6. Does the instrumentation include the addition of any new identifiers (whether anonymous or otherwise; e.g., username, random IDs, etc. See the appendix for more details)?
   No

7. Is the data collection covered by the existing Firefox privacy notice? If unsure: escalate to legal if:
   Yes

8. Does the data collection use a third-party collection tool?
   No

r+

Comment 6

[Travis Long [:travis_]]

Please note, after some discussion with the Glean team, it turns out that we probably need a UUID rather than a sequential counter for this to work properly in all situations.

For that reason, I'm amending the data-collection request line 1 from:

1) What questions will you answer with this data?

The `page_id` counter metric will increment with each page load and be sent along with the events pings in order to connect other events to a particular page load for the purpose of analysis.

to

1) What questions will you answer with this data?

The `page_id` uuid metric will rotate with each page load and be sent along with the events pings in order to connect other events to a particular page load for the purpose of analysis.

ni? :jeddai to ensure that the data-review approval still stands.

Comment 7

[Charlie Humphreys [:charlie] [:jeddai]]

Yep, existing r+ stands