application-services/components/nimbus/metrics.yaml at main · MatthewTighe/application-services · GitHub

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
# 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/.

# This file defines the metrics that are recorded by glean telemetry. They are
# automatically converted to Kotlin code at build time using the `glean_parser`
# PyPI package.
---

$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0

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
      enrollment_id:
        type: string
        description: A unique identifier generated at enrollment time
      experiment_type:
        type: string
        description: Indicates whether this is an experiment or rollout
    bugs:
      - https://jira.mozilla.com/browse/SDK-61
    data_reviews:
      - https://github.com/mozilla-mobile/android-components/pull/9168#issuecomment-743461975
    data_sensitivity:
      - technical
    notification_emails:
      - tlong@mozilla.com
      - telemetry-team@mozilla.com
    expires: never
  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://mozilla-hub.atlassian.net/browse/EXP-2534
    data_reviews:
      - TODO
    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
      enrollment_id:
        type: string
        description: A unique identifier generated at enrollment time
      reason:
        type: string
        description: The reason for the unenrollment
    bugs:
      - https://jira.mozilla.com/browse/SDK-126
    data_reviews:
      - https://github.com/mozilla-mobile/android-components/pull/9168#issuecomment-743461975
    data_sensitivity:
      - technical
    notification_emails:
      - tlong@mozilla.com
      - telemetry-team@mozilla.com
    expires: never
  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://mozilla-hub.atlassian.net/browse/EXP-2534
    data_reviews:
      - TODO
    data_sensitivity:
      - technical
    notification_emails:
      - tlong@mozilla.com
      - nimbus-team@mozilla.com
    expires: never
    send_in_pings:
      - background-update
      - events
  disqualification:
    type: event
    description: >
      Recorded when a user becomes ineligible to continue receiving the
      treatment for an enrolled experiment, for reasons such as the user
      opting out of the experiment or no longer matching targeting for the
      experiment.
    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
      enrollment_id:
        type: string
        description: A unique identifier generated at enrollment time
    bugs:
      - https://jira.mozilla.com/browse/SDK-126
    data_reviews:
      - https://github.com/mozilla-mobile/android-components/pull/9168#issuecomment-743461975
    data_sensitivity:
      - technical
    notification_emails:
      - tlong@mozilla.com
      - telemetry-team@mozilla.com
    expires: never
  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: The identifier of the feature that is recording an exposure
    bugs:
      - https://jira.mozilla.com/browse/SDK-65
    data_reviews:
      - https://github.com/mozilla-mobile/android-components/pull/9168#issuecomment-743461975
    data_sensitivity:
      - technical
    notification_emails:
      - tlong@mozilla.com
      - telemetry-team@mozilla.com
    expires: never
  malformed_feature:
    type: event
    description: >
      Recorded when feature code detects a problem with some part of the
      feature configuration.
    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: The identifier of the feature that is has a malformed
          configuration
      part_id:
        type: string
        description: The identifier of the feature-specific part that is
          malformed. e.g. the card or message id.
    bugs:
      - https://jira.mozilla.com/browse/EXP-3310
    data_reviews:
      - https://github.com/mozilla/application-services/pull/5440#pullrequestreview-1356564351
    data_sensitivity:
      - technical
    notification_emails:
      - jhugman@mozilla.com
      - nimbus-team@mozilla.com
    expires: never
nimbus_health:
  cache_not_ready_for_feature:
    type: event
    description: >
      Recorded when an application or library requests a feature configuration
      before the in memory cache has been populated from the database
    extra_keys:
      feature_id:
        type: string
        description: The feature id of the configuration that was requested
    disabled: true
    bugs:
      - https://mozilla-hub.atlassian.net/browse/EXP-2743
      - https://mozilla-hub.atlassian.net/browse/EXP-2852
    data_reviews:
      - https://github.com/mozilla/application-services/pull/5118#issuecomment-1235827006
    data_sensitivity:
      - technical
    notification_emails:
      - tlong@mozilla.com
    expires: never
  apply_pending_experiments_time:
    send_in_pings:
      - metrics
    type: timing_distribution
    time_unit: millisecond
    description: |
      Measure how long `applyPendingExperiments` takes.
      `applyPendingExperiments` uses disk I/O, and happens at
      startup, as part of the initialization sequence.
    bugs:
      - https://mozilla-hub.atlassian.net/browse/EXP-3083
    data_reviews:
      - https://github.com/mozilla/application-services/pull/5344#issuecomment-1402584994
    data_sensitivity:
      - technical
    notification_emails:
      - jhugman@mozilla.com
      - nimbus-dev@mozilla.com
    expires: never
  fetch_experiments_time:
    send_in_pings:
      - metrics
    type: timing_distribution
    time_unit: millisecond
    description: |
      Measures how long `fetchExperiments` takes.
    bugs:
      - https://mozilla-hub.atlassian.net/browse/EXP-3083
    data_reviews:
      - https://github.com/mozilla/application-services/pull/5344#issuecomment-1402584994
    data_sensitivity:
      - technical
    notification_emails:
      - jhugman@mozilla.com
      - nimbus-dev@mozilla.com
    expires: never