1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
|
# 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://firefox-source-docs.mozilla.org/toolkit/components/glean/user/new_definitions_file.html
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
- "Firefox :: 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:
- beth@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
normandy:
expose_nimbus_experiment:
type: event
description: >
This records an event at the moment the user is exposed to an
experiment treatment. The event is triggered either by the code
checking that a certain experiment feature is enabled or when that
feature value is used. This is different from enrollment or
experiment activation because it registers when a user actually gets
exposed to the experiment feature.
This event was generated to correspond to the Legacy Telemetry event
normandy.expose#nimbus_experiment.
bugs:
- https://bugzil.la/1675104
data_reviews:
- https://bugzil.la/1675104
notification_emails:
- ujet@mozilla.com
expires: never
extra_keys:
value:
description: >
The `value` of the event. Mirrors to the Legacy Telemetry
event's `value` parameter.
The experiment slug.
type: string
branchSlug:
description: >
The slug for the branch the user is enrolled in.
type: string
featureId:
description: >
The type of experiment variant the user was enrolled into.
type: string
telemetry_mirror: Normandy_Expose_NimbusExperiment
|
