/
schema.yaml
591 lines (565 loc) · 17.2 KB
/
schema.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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
fields:
- name: additional_properties
type: STRING
mode: NULLABLE
description: A JSON string containing any payload properties not present in the
schema
- name: client_info
type: RECORD
mode: NULLABLE
fields:
- name: android_sdk_version
type: STRING
mode: NULLABLE
description: The optional Android specific SDK version of the software running
on this hardware device.
- name: app_build
type: STRING
mode: NULLABLE
description: The build identifier generated by the CI system (e.g. "1234/A").
For language bindings that provide automatic detection for this value, (e.g.
Android/Kotlin), in the unlikely event that the build identifier can not be
retrieved from the OS, it is set to "inaccessible". For other language bindings,
if the value was not provided through configuration, this metric gets set to
`Unknown`.
- name: app_channel
type: STRING
mode: NULLABLE
description: The channel the application is being distributed on.
- name: app_display_version
type: STRING
mode: NULLABLE
description: The user visible version string (e.g. "1.0.3"). In the unlikely
event that the display version can not be retrieved, it is set to "inaccessible".
- name: architecture
type: STRING
mode: NULLABLE
description: The architecture of the device, (e.g. "arm", "x86").
- name: client_id
type: STRING
mode: NULLABLE
description: A UUID uniquely identifying the client.
- name: device_manufacturer
type: STRING
mode: NULLABLE
description: The manufacturer of the device the application is running on. Not
set if the device manufacturer can't be determined (e.g. on Desktop).
- name: device_model
type: STRING
mode: NULLABLE
description: The model of the device the application is running on. On Android,
this is Build.MODEL, the user-visible marketing name, like "Pixel 2 XL". Not
set if the device model can't be determined (e.g. on Desktop).
- name: first_run_date
type: STRING
mode: NULLABLE
description: The date of the first run of the application.
- name: locale
type: STRING
mode: NULLABLE
description: The locale of the application during initialization (e.g. "es-ES").
If the locale can't be determined on the system, the value is ["und"](https://unicode.org/reports/tr35/#Unknown_or_Invalid_Identifiers),
to indicate "undetermined".
- name: os
type: STRING
mode: NULLABLE
description: 'The name of the operating system. Possible values: Android, iOS,
Linux, Darwin, Windows, FreeBSD, NetBSD, OpenBSD, Solaris, unknown'
- name: os_version
type: STRING
mode: NULLABLE
description: The user-visible version of the operating system (e.g. "1.2.3").
If the version detection fails, this metric gets set to `Unknown`.
- name: telemetry_sdk_build
type: STRING
mode: NULLABLE
description: The version of the Glean SDK
- name: build_date
type: STRING
mode: NULLABLE
description: The date & time the application was built
- name: windows_build_number
type: INTEGER
mode: NULLABLE
description: The optional Windows build number, reported by Windows (e.g. 22000)
and not set for other platforms
- name: session_count
type: INTEGER
mode: NULLABLE
description: An optional running counter of the number of sessions for a client.
- name: session_id
type: STRING
mode: NULLABLE
description: An optional UUID uniquely identifying the client's current session.
- name: document_id
type: STRING
mode: NULLABLE
description: The document ID specified in the URI when the client sent this message
- name: events
type: RECORD
mode: REPEATED
fields:
- name: category
type: STRING
mode: NULLABLE
- name: extra
type: RECORD
mode: REPEATED
fields:
- name: key
type: STRING
mode: NULLABLE
- name: value
type: STRING
mode: NULLABLE
- name: name
type: STRING
mode: NULLABLE
- name: timestamp
type: INTEGER
mode: NULLABLE
- name: metadata
type: RECORD
mode: NULLABLE
fields:
- name: geo
type: RECORD
mode: NULLABLE
fields:
- name: city
type: STRING
mode: NULLABLE
- name: country
type: STRING
mode: NULLABLE
description: An ISO 3166-1 alpha-2 country code
- name: db_version
type: STRING
mode: NULLABLE
description: The specific geo database version used for this lookup
- name: subdivision1
type: STRING
mode: NULLABLE
description: First major country subdivision, typically a state, province, or
county
- name: subdivision2
type: STRING
mode: NULLABLE
description: Second major country subdivision; not applicable for most countries
description: Results of a geographic lookup based on the client's IP address
- name: header
type: RECORD
mode: NULLABLE
fields:
- name: date
type: STRING
mode: NULLABLE
description: Date HTTP header
- name: dnt
type: STRING
mode: NULLABLE
description: DNT (Do Not Track) HTTP header
- name: x_debug_id
type: STRING
mode: NULLABLE
description: X-Debug-Id HTTP header
- name: x_pingsender_version
type: STRING
mode: NULLABLE
description: X-PingSender-Version HTTP header
- name: x_source_tags
type: STRING
mode: NULLABLE
description: X-Source-Tags HTTP header
- name: x_telemetry_agent
type: STRING
mode: NULLABLE
description: X-Telemetry-Agent HTTP header
- name: x_foxsec_ip_reputation
type: STRING
mode: NULLABLE
description: X-Foxsec-IP-Reputation header
- name: x_lb_tags
type: STRING
mode: NULLABLE
description: X-LB-Tags HTTP header
- name: parsed_date
type: TIMESTAMP
mode: NULLABLE
- name: parsed_x_source_tags
type: STRING
mode: REPEATED
- name: parsed_x_lb_tags
type: RECORD
mode: NULLABLE
fields:
- name: tls_version
type: STRING
mode: NULLABLE
- name: tls_cipher_hex
type: STRING
mode: NULLABLE
description: Headers included in the client's HTTP request
- name: user_agent
type: RECORD
mode: NULLABLE
fields:
- name: browser
type: STRING
mode: NULLABLE
- name: os
type: STRING
mode: NULLABLE
- name: version
type: STRING
mode: NULLABLE
description: Parsed components of the client's user agent string
- name: isp
type: RECORD
mode: NULLABLE
fields:
- name: db_version
type: STRING
mode: NULLABLE
description: The specific geo ISP database version used for this lookup
- name: name
type: STRING
mode: NULLABLE
description: The name of the ISP associated with the client's IP address
- name: organization
type: STRING
mode: NULLABLE
description: The name of a specific business entity associated with the client's
IP address when available; otherwise the ISP name
description: Results of ISP lookup based on the client's IP address
- name: metrics
type: RECORD
mode: NULLABLE
fields:
- name: counter
type: RECORD
mode: NULLABLE
fields:
- name: history_sync_outgoing_batches
type: INTEGER
mode: NULLABLE
description: 'Records the number of batches needed to upload all outgoing records.
The Sync server has a hard limit on the number of records (and request body
bytes) on the number of records that can fit into a single batch, and large
syncs may require multiple batches.
'
- name: history_sync_v2_outgoing_batches
type: INTEGER
mode: NULLABLE
description: 'Records the number of batches needed to upload all outgoing records.
The Sync server has a hard limit on the number of records (and request body
bytes) on the number of records that can fit into a single batch, and large
syncs may require multiple batches.
'
- name: datetime
type: RECORD
mode: NULLABLE
fields:
- name: history_sync_finished_at
type: TIMESTAMP
mode: NULLABLE
description: 'Records when the history sync finished. This includes the time
to download, apply, and upload all records.
'
- name: raw_history_sync_finished_at
type: STRING
mode: NULLABLE
- name: history_sync_started_at
type: TIMESTAMP
mode: NULLABLE
description: 'Records when the history sync started.
'
- name: raw_history_sync_started_at
type: STRING
mode: NULLABLE
- name: history_sync_v2_finished_at
type: TIMESTAMP
mode: NULLABLE
description: 'Records when the history sync finished. This includes the time
to download, apply, and upload all records.
'
- name: raw_history_sync_v2_finished_at
type: STRING
mode: NULLABLE
- name: history_sync_v2_started_at
type: TIMESTAMP
mode: NULLABLE
description: 'Records when the history sync started.
'
- name: raw_history_sync_v2_started_at
type: STRING
mode: NULLABLE
- name: labeled_counter
type: RECORD
mode: NULLABLE
fields:
- name: glean_error_invalid_label
type: RECORD
mode: REPEATED
fields:
- name: key
type: STRING
mode: NULLABLE
- name: value
type: INTEGER
mode: NULLABLE
description: 'Counts the number of times a metric was set with an invalid label.
The labels are the `category.name` identifier of the metric.
'
- name: glean_error_invalid_overflow
type: RECORD
mode: REPEATED
fields:
- name: key
type: STRING
mode: NULLABLE
- name: value
type: INTEGER
mode: NULLABLE
description: 'Counts the number of times a metric was set a value that overflowed.
The labels are the `category.name` identifier of the metric.
'
- name: glean_error_invalid_state
type: RECORD
mode: REPEATED
fields:
- name: key
type: STRING
mode: NULLABLE
- name: value
type: INTEGER
mode: NULLABLE
description: 'Counts the number of times a timing metric was used incorrectly.
The labels are the `category.name` identifier of the metric.
'
- name: glean_error_invalid_value
type: RECORD
mode: REPEATED
fields:
- name: key
type: STRING
mode: NULLABLE
- name: value
type: INTEGER
mode: NULLABLE
description: 'Counts the number of times a metric was set to an invalid value.
The labels are the `category.name` identifier of the metric.
'
- name: history_sync_incoming
type: RECORD
mode: REPEATED
fields:
- name: key
type: STRING
mode: NULLABLE
- name: value
type: INTEGER
mode: NULLABLE
description: 'Records incoming history record counts. `applied` is the number
of incoming history pages that were successfully stored or updated in the
local database. `failed_to_apply` is the number of pages that were ignored
due to errors. `reconciled` is the number of pages with new visits locally
and remotely, and had their visits merged.
'
- name: history_sync_outgoing
type: RECORD
mode: REPEATED
fields:
- name: key
type: STRING
mode: NULLABLE
- name: value
type: INTEGER
mode: NULLABLE
description: 'Records outgoing history record counts. `uploaded` is the number
of records that were successfully sent to the server. `failed_to_upload` is
the number of records that weren''t uploaded, and will be retried on the next
sync.
'
- name: history_sync_v2_incoming
type: RECORD
mode: REPEATED
fields:
- name: key
type: STRING
mode: NULLABLE
- name: value
type: INTEGER
mode: NULLABLE
description: 'Records incoming history record counts. `applied` is the number
of incoming history pages that were successfully stored or updated in the
local database. `failed_to_apply` is the number of pages that were ignored
due to errors. `reconciled` is the number of pages with new visits locally
and remotely, and had their visits merged.
'
- name: history_sync_v2_outgoing
type: RECORD
mode: REPEATED
fields:
- name: key
type: STRING
mode: NULLABLE
- name: value
type: INTEGER
mode: NULLABLE
description: 'Records outgoing history record counts. `uploaded` is the number
of records that were successfully sent to the server. `failed_to_upload` is
the number of records that weren''t uploaded, and will be retried on the next
sync.
'
- name: labeled_string
type: RECORD
mode: NULLABLE
fields:
- name: history_sync_failure_reason
type: RECORD
mode: REPEATED
fields:
- name: key
type: STRING
mode: NULLABLE
- name: value
type: STRING
mode: NULLABLE
description: 'Records why the history sync failed: either due to an authentication
error, unexpected exception, or other error. The error strings are truncated
and sanitized to omit PII, like URLs and file system paths.
'
- name: history_sync_v2_failure_reason
type: RECORD
mode: REPEATED
fields:
- name: key
type: STRING
mode: NULLABLE
- name: value
type: STRING
mode: NULLABLE
description: 'Records why the history sync failed: either due to an authentication
error, unexpected exception, or other error. The error strings are truncated
and sanitized to omit PII, like URLs and file system paths.
'
- name: string
type: RECORD
mode: NULLABLE
fields:
- name: history_sync_uid
type: STRING
mode: NULLABLE
description: 'The user''s hashed Firefox Account ID.
'
- name: history_sync_v2_uid
type: STRING
mode: NULLABLE
description: 'The user''s hashed Firefox Account ID.
'
- name: glean_client_annotation_experimentation_id
type: STRING
mode: NULLABLE
description: 'An experimentation identifier derived and provided by the application
for the purpose of experimentation enrollment.
'
- name: uuid
type: RECORD
mode: NULLABLE
fields:
- name: sync_sync_uuid
type: STRING
mode: NULLABLE
description: 'Unique identifier for this sync, used to correlate together individual
pings for data types that were synchronized together (history, bookmarks,
logins). If a data type is synchronized by itself via the legacy ''sync''
API (as opposed to the Sync Manager), then this field will not be set on the
corresponding ping.
'
- name: sync_v2_sync_uuid
type: STRING
mode: NULLABLE
description: 'Unique identifier for this sync, used to correlate together individual
pings for data types that were synchronized together (history, bookmarks,
logins). If a data type is synchronized by itself via the legacy ''sync''
API (as opposed to the Sync Manager), then this field will not be set on the
corresponding ping.
'
- name: normalized_app_name
type: STRING
mode: NULLABLE
description: Set to "Other" if this message contained an unrecognized app name
- name: normalized_channel
type: STRING
mode: NULLABLE
description: Set to "Other" if this message contained an unrecognized channel name
- name: normalized_country_code
type: STRING
mode: NULLABLE
description: An ISO 3166-1 alpha-2 country code
- name: normalized_os
type: STRING
mode: NULLABLE
description: Set to "Other" if this message contained an unrecognized OS name
- name: normalized_os_version
type: STRING
mode: NULLABLE
- name: ping_info
type: RECORD
mode: NULLABLE
fields:
- name: end_time
type: STRING
mode: NULLABLE
- name: experiments
type: RECORD
mode: REPEATED
fields:
- name: key
type: STRING
mode: NULLABLE
- name: value
type: RECORD
mode: NULLABLE
fields:
- name: branch
type: STRING
mode: NULLABLE
- name: extra
type: RECORD
mode: NULLABLE
fields:
- name: type
type: STRING
mode: NULLABLE
- name: enrollment_id
type: STRING
mode: NULLABLE
- name: ping_type
type: STRING
mode: NULLABLE
- name: reason
type: STRING
mode: NULLABLE
- name: seq
type: INTEGER
mode: NULLABLE
- name: start_time
type: STRING
mode: NULLABLE
- name: parsed_start_time
type: TIMESTAMP
mode: NULLABLE
- name: parsed_end_time
type: TIMESTAMP
mode: NULLABLE
- name: sample_id
type: INTEGER
mode: NULLABLE
description: Hashed version of client_id (if present) useful for partitioning; ranges
from 0 to 99
- name: submission_timestamp
type: TIMESTAMP
mode: NULLABLE
description: Time when the ingestion edge server accepted this message