This repository has been archived by the owner on Jul 29, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathmetrics.yaml
304 lines (285 loc) · 8.79 KB
/
metrics.yaml
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
# 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 the Glean SDK.
# APIs to use these pings are automatically generated at build time using
# the `glean_parser` PyPI package.
# Metrics in this file may make use of SDK reserved ping names. See
# https://mozilla.github.io/glean/book/dev/core/internal/reserved-ping-names.html
# for additional information.
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
rally:
id:
type: uuid
lifetime: user
send_in_pings:
- study-enrollment
- deletion-request
- rs01-event
description: |
The id of the Rally client. This is generated by
the Rally Core Add-on. A value of 00000000-0000-0000-0000-000000000000
indicates a test payload. A value of 11111111-1111-1111-1111-111111111111
indicates that the Rally id was not found or properly set.
bugs:
- https://github.com/mozilla-rally/rally-core-addon/issues/117
data_reviews:
- https://github.com/mozilla-rally/rally-core-addon/pull/505#issuecomment-815826426
notification_emails:
expires: never
page:
id:
type: string
lifetime: ping
send_in_pings:
- rs01-event
description: |
A unique ID associated with a page visit. Each
page ID is 128-bit value, randomly generated with
the Web Crypto API and stored as a hexadecimal
string.
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
origin:
type: string
lifetime: ping
send_in_pings:
- rs01-event
description: |
The origin of the URL associated with the page
visit. Calculated by applying `new URL(url).origin`.
See the documentation for
[url.origin](https://developer.mozilla.org/en-US/docs/Web/API/URL/origin).
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
referrer_origin:
type: string
lifetime: ping
send_in_pings:
- rs01-event
description: |
The origin of the referrer URL for the page
loading in the tab.
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
title:
type: string
lifetime: ping
send_in_pings:
- rs01-event
description: |
The contents of the title element in the head
of the page.
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
og_type:
type: string
lifetime: ping
send_in_pings:
- rs01-event
description: |
The `og:type` meta tag contents (e.g. `<meta type="og:type"
contents="article" />`).
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
og_description:
type: string
lifetime: ping
send_in_pings:
- rs01-event
description: |
The `og:description` meta tag contents (e.g. `<meta
type="og:description" contents="..." />`). If this
isn't supplied, then attempts to look at the meta
description contents (e.g. `<meta name="description"
content="...">`).
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
page.attention:
max_relative_scroll_depth:
type: quantity
unit: percentage
lifetime: ping
send_in_pings:
- rs01-event
description: |
The largest depth reach on the page, as a
proportion of the total page height.
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
max_pixel_scroll_depth:
type: quantity
unit: pixels
lifetime: ping
send_in_pings:
- rs01-event
description: |
The largest scroll pixel depth reached on the page.
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
scroll_height:
type: quantity
unit: pixels
lifetime: ping
send_in_pings:
- rs01-event
description: |
The total scroll height of the page, taken
from `document.documentElement.scrollHeight` at
the same interval as the other scroll fields.
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
page.visit:
start:
type: datetime
time_unit: millisecond
lifetime: ping
send_in_pings:
- rs01-event
description: |
When did the page visit start.
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
stop:
type: datetime
time_unit: millisecond
lifetime: ping
send_in_pings:
- rs01-event
description: |
When did the page visit stop.
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
event:
start:
type: datetime
time_unit: millisecond
lifetime: ping
send_in_pings:
- rs01-event
description: |
Noting when the event started. If sent in a ping with
reason `attention`, this field notes when an inactive tab with
a page loaded in it has been given active focus
or a new page loads in an already-active tab.
If otherwise sent in a ping with reason `audio`, this
field notes when an unmuted audio element began
playing in the active tab.
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
stop:
type: datetime
time_unit: millisecond
lifetime: ping
send_in_pings:
- rs01-event
description: |
Noting when the event ended. If sent in a ping with
reason `attention`, this field notes when a user closed
the active tab, switched or closed the active window,
or loaded a new page into the active tab which ends
the current attention event. If otherwise sent in a ping
with reason `audio`, this field notes when an unmuted
audio element stopped playing in the active tab.
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
duration:
type: timespan
time_unit: millisecond
lifetime: ping
send_in_pings:
- rs01-event
description: |
How long the event occurred.
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never
termination_reason:
type: string
lifetime: ping
send_in_pings:
- rs01-event
description: |
The reason the user’s attention switched to the
current attention event (e.g. changed a tab,
loaded a new URL in the currently-active tab,
closed a tab, closed a window, created a new tab,
created a new window, stopped playing audio).
bugs:
- https://github.com/mozilla-rally/rally-study-01/issues/106
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1703279#c2
notification_emails:
expires: never