Merge pull request #1919 from mozilla/Bug1888430

Bug 1888430 - Add `page_id`  to Glean automatic events

glean/src/core/glean_metrics.ts

@@ -3,6 +3,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { Context } from "./context.js";
+import UUIDMetric from "./metrics/types/uuid.js";
 import EventMetricType from "./metrics/types/event.js";
 import { EVENTS_PING_NAME } from "./constants.js";
 import { Lifetime } from "./metrics/lifetime.js";
@@ -51,6 +52,15 @@ namespace GleanMetrics {
       },
       // extras defined in `src/metrics.yaml`.
       ["id", "type", "label"]
+    ),
+    pageId: new UUIDMetric(
+      {
+        category: "glean",
+        name: "page_id",
+        sendInPings: [EVENTS_PING_NAME],
+        lifetime: Lifetime.Application,
+        disabled: false,
+      }
     )
   };
 
@@ -72,6 +82,9 @@ namespace GleanMetrics {
       return;
     }
 
+    // Rotate the page_id for each page_load event.
+    metrics.pageId.generateAndSet();
+
     // Each key defaults to the override. If no override is provided, we fall
     // back to the default value IF the `window` or the `document` objects
     // are available.

glean/src/metrics.yaml

@@ -539,3 +539,20 @@ glean:
       label:
         description: The label of the element clicked. For automatic collection, its value is the element's `data-glean-label` data attribute value.
         type: string
+  page_id:
+    type: uuid
+    description: |
+      Uniquely identifies a page_load, not the page itself, for the purpose of associating other events with the specific page load event. This gets
+      rotated with each page load and is sent along with each event ping.
+    send_in_pings:
+      - events
+    lifetime: application
+    bugs:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1888430
+    data_reviews:
+      - https://bugzilla.mozilla.org/show_bug.cgi?id=1888430
+    data_sensitivity:
+      - technical
+    notification_emails:
+      - glean-team@mozilla.com
+    expires: never