Skip to content
This repository has been archived by the owner on Sep 27, 2024. It is now read-only.

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(metrics.yaml): include new data_taxonomy & data_reviews info
Browse files Browse the repository at this point in the history
wtfluckey committed Nov 15, 2023
1 parent 83e8ce4 commit 63a39e8
Showing 4 changed files with 171 additions and 13 deletions.
14 changes: 14 additions & 0 deletions telemetry/generated/identifiers.ts
Original file line number Diff line number Diff line change
@@ -9,6 +9,10 @@ import StringMetricType from "@mozilla/glean/private/metrics/string";
/**
* The user's full account handle, with domain. For example,
* `account_name@mozilla.social`.
* data_taxonomy:
* data_categories: [user.account.username]
* data_uses: [analytics.reporting, personalize.content]
* data_subjects: [customer]
*
* Generated from `identifiers.mastodon_account_handle`.
*/
@@ -22,6 +26,11 @@ export const mastodonAccountHandle = new StringMetricType({

/**
* The user's numeric account ID from Mastodon.
* data_taxonomy:
* data_categories: [user.unique_id]
* data_uses: [analytics.reporting, personalize.content]
* data_subjects: [customer]
* data_qualifier: [identified]
*
* Generated from `identifiers.mastodon_account_id`.
*/
@@ -35,6 +44,11 @@ export const mastodonAccountId = new StringMetricType({

/**
* The device user agent string.
* data_taxonomy:
* data_categories: [user.device]
* data_uses: [analytics.reporting]
* data_subjects: [customer, visitor]
* data_qualifier: [n/a]
*
* Generated from `identifiers.user_agent`.
*/
16 changes: 13 additions & 3 deletions telemetry/generated/ui.ts
Original file line number Diff line number Diff line change
@@ -7,8 +7,13 @@
import EventMetricType from "@mozilla/glean/private/metrics/event";

/**
* Event triggered when a user taps/clicks on a UI element, triggering a change in
* app state.
* Event triggered when a user taps/clicks on a UI element, triggering a change
* in app state.
* data_taxonomy:
* data_categories: [user.behavior]
* data_uses: [analytics.reporting, personalize.content]
* data_subjects: [customer, visitor]
* data_qualifier: [n/a]
*
* Generated from `ui.engagement`.
*/
@@ -31,8 +36,13 @@ export const engagement = new EventMetricType<{

/**
* Event triggered when a user views a notable UI element. Triggered once per page
* load, as soon as any pixel of that UI element is visible in the foreground for
* load, as soon as any pixel of that UI element is visible in the foreground for
* any length of time. UI elements may include: content, pages, CTAs, etc.
* data_taxonomy:
* data_categories: [user.behavior]
* data_uses: [analytics.reporting, personalize.content]
* data_subjects: [customer, visitor]
* data_qualifier: [n/a]
*
* Generated from `ui.impression`.
*/
22 changes: 21 additions & 1 deletion telemetry/generated/web.ts
Original file line number Diff line number Diff line change
@@ -4,11 +4,16 @@

// AUTOGENERATED BY glean_parser v8.1.1. DO NOT EDIT. DO NOT COMMIT.

import StringMetricType from "@mozilla/glean/private/metrics/string";
import EventMetricType from "@mozilla/glean/private/metrics/event";
import StringMetricType from "@mozilla/glean/private/metrics/string";

/**
* Event triggered when a user clicks a link on a web page.
* data_taxonomy:
* data_categories: [user.behavior]
* data_uses: [analytics.reporting]
* data_subjects: [customer, visitor]
* data_qualifier: [n/a]
*
* Generated from `web.link_click`.
*/
@@ -26,6 +31,11 @@ export const linkClick = new EventMetricType<{
/**
* The full URL of the page that was visited, along with URL query parameters. For
* example, `https://mozilla.social/home?utm_source=test`.
* data_taxonomy:
* data_categories: [user.behavior.browsing_history]
* data_uses: [analytics.reporting]
* data_subjects: [customer, visitor]
* data_qualifier: [n/a]
*
* Generated from `web.page_url`.
*/
@@ -39,6 +49,11 @@ export const pageUrl = new StringMetricType({

/**
* Event triggered when a user requests to load a web page.
* data_taxonomy:
* data_categories: [user.behavior]
* data_uses: [analytics.reporting]
* data_subjects: [customer, visitor]
* data_qualifier: [n/a]
*
* Generated from `web.page_view`.
*/
@@ -54,6 +69,11 @@ export const pageView = new EventMetricType({
* The full URL of the previous web page from which a link was followed in order
* to trigger the page view. Comes from the `referer` field of the HTTP header.
* May not always be available. For example, `https://www.google.com`.
* data_taxonomy:
* data_categories: []
* data_uses: [analytics.reporting]
* data_subjects: [customer, visitor]
* data_qualifier: [n/a]
*
* Generated from `web.referrer_url`.
*/
132 changes: 123 additions & 9 deletions telemetry/metrics.yaml
Original file line number Diff line number Diff line change
@@ -6,10 +6,16 @@ identifiers:
lifetime: application
description: >
The user's numeric account ID from Mastodon.
data_taxonomy:
data_categories: [user.unique_id]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer]
data_qualifier: [identified]
bugs:
- TBD
data_reviews:
- TBD
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
expires: never
@@ -24,10 +30,15 @@ identifiers:
description: >
The user's full account handle, with domain.
For example, `account_name@mozilla.social`.
data_taxonomy:
data_categories: [user.account.username]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer]
bugs:
- TBD
data_reviews:
- TBD
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
expires: never
@@ -41,10 +52,16 @@ identifiers:
lifetime: application
description: >
The device user agent string.
data_taxonomy:
data_categories: [user.device]
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- TBD
data_reviews:
- TBD
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
expires: never
@@ -61,10 +78,16 @@ ui:
Triggered once per page load, as soon as any pixel of that UI
element is visible in the foreground for any length of time.
UI elements may include: content, pages, CTAs, etc.
data_taxonomy:
data_categories: [user.behavior]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- TBD
data_reviews:
- TBD
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
expires: never
@@ -77,47 +100,89 @@ ui:
increasing order of specificity (e.g. `[SCREEN].[BUTTON]`).
All existing identifier values are being tracked here:
https://docs.google.com/spreadsheets/d/1KX6TiyXXg2fE0a1IDKsy5O97ZrHYvjKohmIX_m8ECXY/edit?usp=sharing
data_taxonomy:
data_categories: [system.operations]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
ui_additional_detail: &ui_additional_detail
description: >
An optional string to record further informatin about the UI
element, such as its starting value if it is a toggle or setting.
data_taxonomy:
data_categories: [system.operations, personalize.content]
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
mastodon_status_id: &mastodon_status_id
description: >
The Mastodon status ID of the post that was seen/interacted
with by the user, if any.
The Mastodon API calls statuses "posts", but they are one and the same.
data_taxonomy:
data_categories: [user.behavior.browsing_history]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
mastodon_account_id: &mastodon_account_id
description: >
The Mastodon account ID of the UI element that was seen/interacted
with by the user, if any.
For example, the account ID of the user who created a post that was
seen/interacted with. Or, the account ID of the user that was followed.
data_taxonomy:
data_categories: [user.behavior.browsing_history]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
mastodon_account_handle: &mastodon_account_handle
description: >
The Mastodon account handle of the UI element that was seen/interacted
with by the user, if any.
For example, the account handle of the user who created a post that was
seen/interacted with. Or, the account handle of the user that was followed.
data_taxonomy:
data_categories: [user.behavior.browsing_history]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
recommendation_id: &recommendation_id
description: >
TBD recommendation identifier of the content
that was seen/interacted with by the user, if any.
data_taxonomy:
data_categories: [user.behavior.browsing_history]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string

engagement:
type: event
description: >
Event triggered when a user taps/clicks on a UI element,
triggering a change in app state.
data_taxonomy:
data_categories: [user.behavior]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- TBD
data_reviews:
- TBD
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
expires: never
@@ -138,12 +203,25 @@ ui:
* `favorite`
* `boost`
* `bookmark`
* `share`
* `general`
data_taxonomy:
data_categories: [user.behavior]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
engagement_value:
description: >
If the UI element is a toggle or setting, the value of the
toggle/setting after user interaction has taken place.
data_taxonomy:
data_categories: [system.operations]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string

web:
@@ -154,10 +232,16 @@ web:
The full URL of the page that was visited,
along with URL query parameters.
For example, `https://mozilla.social/home?utm_source=test`.
data_taxonomy:
data_categories: [user.behavior.browsing_history]
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- TBD
data_reviews:
- TBD
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
expires: never
@@ -173,10 +257,16 @@ web:
Comes from the `referer` field of the HTTP header.
May not always be available.
For example, `https://www.google.com`.
data_taxonomy:
data_categories: []
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- TBD
data_reviews:
- TBD
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
expires: never
@@ -187,10 +277,16 @@ web:
type: event
description: >
Event triggered when a user requests to load a web page.
data_taxonomy:
data_categories: [user.behavior]
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- TBD
data_reviews:
- TBD
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
expires: never
@@ -199,19 +295,37 @@ web:
type: event
description: >
Event triggered when a user clicks a link on a web page.
data_taxonomy:
data_categories: [user.behavior]
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- TBD
data_reviews:
- TBD
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
expires: never
extra_keys:
target_url:
description: >
The destination URL of the link that the user clicked.
data_taxonomy:
data_categories: [user.behavior.browsing_history]
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
element_id:
description: >
The HTML element ID of the link that the user clicked.
data_taxonomy:
data_categories: []
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string

0 comments on commit 63a39e8

Please sign in to comment.