286 lines
9.6 KiB
YAML
286 lines
9.6 KiB
YAML
# This Source Code Form is subject to the terms of the Mozilla Public
|
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
# Adding a new metric? We have docs for that!
|
|
# https://icecat-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html
|
|
|
|
---
|
|
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
|
|
$tags:
|
|
- "IceCat :: Nimbus Desktop Client"
|
|
|
|
nimbus_events:
|
|
enrollment:
|
|
type: event
|
|
description: >
|
|
Recorded when a user has met the conditions and is first bucketed into an
|
|
experiment (i.e. targeting matched and they were randomized into a bucket
|
|
and branch of the experiment). Expected a maximum of once per experiment
|
|
per user.
|
|
extra_keys:
|
|
experiment:
|
|
type: string
|
|
description: The slug/unique identifier of the experiment
|
|
branch:
|
|
type: string
|
|
description: The branch slug/identifier that was randomly chosen
|
|
experiment_type:
|
|
type: string
|
|
description: Indicates whether this is an experiemnt or rollout
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1773563
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781953
|
|
data_reviews:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1773563
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781953
|
|
data_sensitivity:
|
|
- technical
|
|
notification_emails:
|
|
- tlong@mozilla.com
|
|
- nimbus-team@mozilla.com
|
|
expires: never
|
|
send_in_pings:
|
|
- background-update
|
|
- events
|
|
enroll_failed:
|
|
type: event
|
|
description: >
|
|
Recorded when an enrollment fails, including the reason for the failure.
|
|
extra_keys:
|
|
experiment:
|
|
type: string
|
|
description: The slug/unique identifier of the experiment
|
|
reason:
|
|
type: string
|
|
description: The reason for the enrollment failure
|
|
branch:
|
|
type: string
|
|
description: If reason == "invalid-branch", this is the invalid branch.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1773563
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781953
|
|
data_reviews:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1773563
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781953
|
|
data_sensitivity:
|
|
- technical
|
|
notification_emails:
|
|
- tlong@mozilla.com
|
|
- nimbus-team@mozilla.com
|
|
expires: never
|
|
send_in_pings:
|
|
- background-update
|
|
- events
|
|
unenrollment:
|
|
type: event
|
|
description: >
|
|
Recorded when either telemetry is disabled, or the experiment has run
|
|
for its designed duration (i.e. it is no longer present in the Nimbus
|
|
Remote Settings collection)
|
|
extra_keys:
|
|
experiment:
|
|
type: string
|
|
description: The slug/unique identifier of the experiment
|
|
branch:
|
|
type: string
|
|
description: The branch slug/identifier that was randomly chosen
|
|
reason:
|
|
type: string
|
|
description: The reason for the unenrollment
|
|
changed_pref:
|
|
type: string
|
|
description: >
|
|
If reason == "changed-pref", then this contains the name of the pref
|
|
that changed that caused the unenrollment.
|
|
conflicting_slug:
|
|
type: string
|
|
description: >
|
|
If reason == "prefFlips-conflict", the slug of the conflicting
|
|
experiment that caused the unenrollment.
|
|
pref_name:
|
|
type: string
|
|
description: >
|
|
If reason == "prefFlips-failed", the name of the pref that failed to set.
|
|
pref_type:
|
|
type: string
|
|
description: >
|
|
If reason == "prefFlips-failed", The type of the existing pref value
|
|
(one of "bool", "string", "int", or "invalid").
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1773563
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781953
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1843126
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1896718
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1907649
|
|
data_reviews:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1773563
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781953
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1843126
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1896718
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1907649
|
|
data_sensitivity:
|
|
- technical
|
|
notification_emails:
|
|
- tlong@mozilla.com
|
|
- nimbus-team@mozilla.com
|
|
expires: never
|
|
send_in_pings:
|
|
- background-update
|
|
- events
|
|
unenroll_failed:
|
|
type: event
|
|
description: >
|
|
Recorded when an unenrollment fails, including the reason for the failure.
|
|
extra_keys:
|
|
experiment:
|
|
type: string
|
|
description: The slug/unique identifier of the experiment
|
|
reason:
|
|
type: string
|
|
description: The reason for the unenrollment failure
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1773563
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781953
|
|
data_reviews:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1773563
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781953
|
|
data_sensitivity:
|
|
- technical
|
|
notification_emails:
|
|
- tlong@mozilla.com
|
|
- nimbus-team@mozilla.com
|
|
expires: never
|
|
send_in_pings:
|
|
- background-update
|
|
- events
|
|
exposure:
|
|
type: event
|
|
description: >
|
|
Recorded when a user actually observes an experimental treatment, or
|
|
would have observed an experimental treatment if they had been in a
|
|
branch that would have shown one.
|
|
extra_keys:
|
|
experiment:
|
|
type: string
|
|
description: The slug/unique identifier of the experiment
|
|
branch:
|
|
type: string
|
|
description: The branch slug/identifier that was randomly chosen
|
|
feature_id:
|
|
type: string
|
|
description: A unique identifier for the feature that was exposed
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1773563
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781953
|
|
data_reviews:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1773563
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781953
|
|
data_sensitivity:
|
|
- technical
|
|
notification_emails:
|
|
- tlong@mozilla.com
|
|
- nimbus-team@mozilla.com
|
|
expires: never
|
|
send_in_pings:
|
|
- background-update
|
|
- events
|
|
validation_failed:
|
|
type: event
|
|
description: >
|
|
This records when validation of a recipe fails.
|
|
extra_keys:
|
|
experiment:
|
|
type: string
|
|
description: The slug/unique identifier of the experiment
|
|
reason:
|
|
type: string
|
|
description: >
|
|
Why validation failed (one of "invalid-recipe", "invalid-branch",
|
|
"invalid-reason", "missing-locale", or "missing-l10n-entry").
|
|
branch:
|
|
type: string
|
|
description: >
|
|
If reason == invalid-branch, the branch that failed validation.
|
|
feature:
|
|
type: string
|
|
description: If reason == invalid-feature, the invalid feature ID.
|
|
locale:
|
|
type: string
|
|
description: >
|
|
If reason == missing-locale, the locale that was missing from the
|
|
localization table.
|
|
If reason == missing-l10n-entry, the locale that was missing the
|
|
localization entries.
|
|
l10n_ids:
|
|
type: string
|
|
description: >
|
|
If reason == missing-l10n-entry, a comma-sparated list of missing
|
|
localization entries.
|
|
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1762652
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781953
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1821092
|
|
data_reviews:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1762652
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1781953
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1821092
|
|
data_sensitivity:
|
|
- technical
|
|
notification_emails:
|
|
- barret@mozilla.com
|
|
expires: never
|
|
send_in_pings:
|
|
- background-update
|
|
- events
|
|
|
|
is_ready:
|
|
type: event
|
|
description: >
|
|
An event sent when Nimbus is ready — sent upon completion of each update of the recipes.
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1875510
|
|
data_reviews:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1875510
|
|
data_sensitivity:
|
|
- technical
|
|
notification_emails:
|
|
- chumphreys@mozilla.com
|
|
- project-nimbus@mozilla.com
|
|
expires: 180
|
|
|
|
enrollment_status:
|
|
type: event
|
|
description: >
|
|
Recorded for each enrollment status each time the SDK completes application of pending experiments.
|
|
extra_keys:
|
|
slug:
|
|
type: string
|
|
description: The slug/unique identifier of the experiment
|
|
status:
|
|
type: string
|
|
description: The status of this enrollment
|
|
reason:
|
|
type: string
|
|
description: The reason the client is in the noted status
|
|
branch:
|
|
type: string
|
|
description: The branch slug/identifier that was randomly chosen (if the client is enrolled)
|
|
error_string:
|
|
type: string
|
|
description: If the enrollment resulted in an error, the associated error string
|
|
conflict_slug:
|
|
type: string
|
|
description: If the enrollment hit a feature conflict, the slug of the conflicting experiment/rollout
|
|
bugs:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1817481
|
|
data_reviews:
|
|
- https://bugzilla.mozilla.org/show_bug.cgi?id=1817481
|
|
data_sensitivity:
|
|
- technical
|
|
notification_emails:
|
|
- chumphreys@mozilla.com
|
|
- project-nimbus@mozilla.com
|
|
expires: never
|
|
disabled: true
|