This repository has been archived by the owner on Sep 27, 2024. It is now read-only.
forked from elk-zone/elk
-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathmetrics.yaml
346 lines (316 loc) · 11.7 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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
identifiers:
fxa_account_id: # not used by web, but requested by Kirill to keep in here
type: string
description: >
The user's FxA account ID, if available.
data_taxonomy:
data_categories: [user.unique_id]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer]
data_qualifier: [identified]
bugs:
- https://mozilla-hub.atlassian.net/browse/MSDO-49
data_reviews:
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
lifetime: application
expires: never
send_in_pings:
- events
mastodon_account_id:
type: string
description: >
The user's numeric account ID from Mastodon.
data_taxonomy:
data_categories: [user.unique_id]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer]
data_qualifier: [identified]
bugs:
- https://mozilla-hub.atlassian.net/browse/MSDO-49
data_reviews:
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
lifetime: application
expires: never
send_in_pings:
- events
mastodon_account_handle:
type: string
description: >
The user's full account handle, with domain.
For example, `account_name@mozilla.social`.
data_taxonomy:
data_categories: [user.account.username]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer]
bugs:
- https://mozilla-hub.atlassian.net/browse/MSDO-49
data_reviews:
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
lifetime: application
expires: never
send_in_pings:
- events
user_agent:
type: string
description: >
The device user agent string.
data_taxonomy:
data_categories: [user.device]
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- https://mozilla-hub.atlassian.net/browse/MSDO-49
data_reviews:
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
lifetime: application
expires: never
send_in_pings:
- events
ui:
impression:
type: event
description: >
Event triggered when a user views a notable UI element.
Triggered once per page load, as soon as any pixel of that UI
element is visible in the foreground for any length of time.
UI elements may include: content, pages, CTAs, etc.
data_taxonomy:
data_categories: [user.behavior]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- https://mozilla-hub.atlassian.net/browse/MSDO-49
data_reviews:
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
expires: never
extra_keys:
ui_identifier: &ui_identifier
description: >
The string id of the UI element that was seen/interacted
with by the user (e.g. `home.rec` or `home.boost`).
The identifier is a period-delimited string, ordered in
increasing order of specificity (e.g. `[SCREEN].[BUTTON]`).
All existing identifier values are being tracked here:
https://docs.google.com/spreadsheets/d/1KX6TiyXXg2fE0a1IDKsy5O97ZrHYvjKohmIX_m8ECXY/edit?usp=sharing
data_taxonomy:
data_categories: [system.operations]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
ui_additional_detail: &ui_additional_detail
description: >
An optional string to record further information about the UI
element, such as its starting value if it is a toggle or setting.
data_taxonomy:
data_categories: [system.operations, personalize.content]
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
mastodon_status_id: &mastodon_status_id
description: >
The Mastodon status ID of the post that was seen/interacted
with by the user, if any.
The Mastodon API calls statuses "posts", but they are one and the same.
data_taxonomy:
data_categories: [user.behavior.browsing_history]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
mastodon_account_id: &mastodon_account_id
description: >
The Mastodon account ID of the UI element that was seen/interacted
with by the user, if any.
For example, the account ID of the user who created a post that was
seen/interacted with. Or, the account ID of the user that was followed.
data_taxonomy:
data_categories: [user.behavior.browsing_history]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
mastodon_account_handle: &mastodon_account_handle
description: >
The Mastodon account handle of the UI element that was seen/interacted
with by the user, if any.
For example, the account handle of the user who created a post that was
seen/interacted with. Or, the account handle of the user that was followed.
data_taxonomy:
data_categories: [user.behavior.browsing_history]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
recommendation_id: &recommendation_id
description: >
TBD recommendation identifier of the content
that was seen/interacted with by the user, if any.
data_taxonomy:
data_categories: [user.behavior.browsing_history]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
engagement:
type: event
description: >
Event triggered when a user taps/clicks on a UI element,
triggering a change in app state.
data_taxonomy:
data_categories: [user.behavior]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- https://mozilla-hub.atlassian.net/browse/MSDO-49
data_reviews:
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
expires: never
extra_keys:
ui_identifier: *ui_identifier
ui_additional_detail: *ui_additional_detail
mastodon_status_id: *mastodon_status_id
mastodon_account_id: *mastodon_account_id
mastodon_account_handle: *mastodon_account_handle
recommendation_id: *recommendation_id
engagement_type:
description: >
The type of user engagement that triggered this event.
One of:
* `follow`
* `post`
* `reply`
* `favorite`
* `boost`
* `bookmark`
* `share`
* `general`
data_taxonomy:
data_categories: [user.behavior]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
engagement_value:
description: >
If the UI element is a toggle or setting, the value of the
toggle/setting after user interaction has taken place.
data_taxonomy:
data_categories: [system.operations]
data_uses: [analytics.reporting, personalize.content]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
web:
page_url:
type: url
description: >
The full URL of the page that was visited,
along with URL query parameters.
For example, `https://mozilla.social/home?utm_source=test`.
data_taxonomy:
data_categories: [user.behavior.browsing_history]
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- https://mozilla-hub.atlassian.net/browse/MSDO-49
data_reviews:
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
lifetime: application
expires: never
send_in_pings:
- events
referrer_url:
type: url
description: >
The full URL of the previous web page from which a link was followed
in order to trigger the page view.
Comes from the `referrer` field of the HTTP header.
May not always be available.
For example, `https://www.google.com`.
data_taxonomy:
data_categories: []
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- https://mozilla-hub.atlassian.net/browse/MSDO-49
data_reviews:
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
lifetime: application
expires: never
send_in_pings:
- events
page_view:
type: event
description: >
Event triggered when a user requests to load a web page.
data_taxonomy:
data_categories: [user.behavior]
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- https://mozilla-hub.atlassian.net/browse/MSDO-49
data_reviews:
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
expires: never
link_click:
type: event
description: >
Event triggered when a user clicks a link on a web page.
data_taxonomy:
data_categories: [user.behavior]
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
bugs:
- https://mozilla-hub.atlassian.net/browse/MSDO-49
data_reviews:
- https://docs.google.com/document/d/17vK3r7Sihb_S4-_8oKNoAraWeb_QiomC3UL-2W7PHgY/edit?usp=sharing
notification_emails:
- kdemtchouk@mozilla.com
expires: never
extra_keys:
target_url:
description: >
The destination URL of the link that the user clicked.
data_taxonomy:
data_categories: [user.behavior.browsing_history]
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string
element_id:
description: >
The HTML element ID of the link that the user clicked.
data_taxonomy:
data_categories: []
data_uses: [analytics.reporting]
data_subjects: [customer, visitor]
data_qualifier: [n/a]
type: string