forked from mozilla-rally/study-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
metrics.yaml
184 lines (171 loc) · 3.92 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
# 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
- events
- user-journey
description: |
The id of the Rally client. This is generated by
the Rally SDKs. 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:
- TODO
data_reviews:
- TODO
notification_emails:
- TODO
expires: never
user_journey:
page_id:
type: string
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.
lifetime: ping
send_in_pings:
- user-journey
bugs:
- TODO
data_reviews:
- TODO
notification_emails:
- TODO
expires: never
url:
type: url
description: |
The URL visited.
lifetime: ping
send_in_pings:
- user-journey
bugs:
- TODO
data_reviews:
- TODO
notification_emails:
- TODO
expires: never
referrer:
type: url
description: |
The HTTP Referrer URL (if set).
lifetime: ping
send_in_pings:
- user-journey
bugs:
- TODO
data_reviews:
- TODO
notification_emails:
- TODO
expires: never
page_visit_start_date_time:
type: datetime
time_unit: millisecond
description: |
When did the page visit start.
lifetime: ping
send_in_pings:
- user-journey
bugs:
- TODO
data_reviews:
- TODO
notification_emails:
- TODO
expires: never
page_visit_stop_date_time:
type: datetime
time_unit: millisecond
description: |
When did the page visit stop.
lifetime: ping
send_in_pings:
- user-journey
bugs:
- TODO
data_reviews:
- TODO
notification_emails:
- TODO
expires: never
attention_duration:
type: quantity
unit: milliseconds
description: |
How long the user attention event occurred
(window/tab was focused and not idle).
lifetime: ping
send_in_pings:
- user-journey
bugs:
- TODO
data_reviews:
- TODO
notification_emails:
- TODO
expires: never
audio_duration:
type: quantity
unit: milliseconds
description: |
How long a user audio event occurred.
lifetime: ping
send_in_pings:
- user-journey
bugs:
- TODO
data_reviews:
- TODO
notification_emails:
- TODO
expires: never
attention_and_audio_duration:
type: quantity
unit: milliseconds
description: |
How long a user audio event occurred while attention
was focused on the tab.
lifetime: ping
send_in_pings:
- user-journey
bugs:
- TODO
data_reviews:
- TODO
notification_emails:
- TODO
expires: never
max_relative_scroll_depth:
type: quantity
unit: percentage
description: |
The largest depth reach on the page, as a
proportion of the total page height.
lifetime: ping
send_in_pings:
- user-journey
bugs:
- TODO
data_reviews:
- TODO
notification_emails:
- TODO
expires: never