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
|
# 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/.
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
- 'Firefox :: Search'
search.engine.default:
engine_id:
type: string
description: |
The telemetry id of the search engine.
For application provided engines, this is either supplied by the
configuration or from the first part of the associated WebExtension Id.
For other engines, this is `other-<extensionName>`.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1089670
- https://bugzilla.mozilla.org/show_bug.cgi?id=1138503
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1755549
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
- rev-data@mozilla.com
expires: never
lifetime: application
send_in_pings:
- 'metrics'
- 'newtab'
display_name:
type: string
description: |
The display name of the user's default engine.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1164159
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1164159#c60
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
- rev-data@mozilla.com
expires: never
lifetime: application
send_in_pings:
- 'metrics'
load_path:
type: string
description: |
A path relating to where the search engine was installed/loaded from.
For example:
`[addon]<extension id>` for a WebExtension based
engine.
`[https]developer.mozilla.org/mdn-web-docs.xml` for an OpenSearch based
engine.
Note: this metric is truncated at 100 characters.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1164159
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1164159#c60
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_sensitivity:
- web_activity
notification_emails:
- fx-search-telemetry@mozilla.com
- rev-data@mozilla.com
expires: never
lifetime: application
send_in_pings:
- 'metrics'
submission_url:
type: url
description: |
The submission URL of the default engine. This is only reported in the
cases where:
The engine is an application provided engine.
The engine has the same name as an application provided engine.
The engine matches one of a specific list of well known search engines.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1164159
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1164159#c60
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_sensitivity:
- web_activity
notification_emails:
- fx-search-telemetry@mozilla.com
- rev-data@mozilla.com
expires: never
lifetime: application
send_in_pings:
- 'metrics'
verified:
type: string
description: |
The verified status of the search engine.
For application provided engines, this will always be `default`.
For other engines this will either be `verified` or `unverified` depending
on if the loadPathHash is valid.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1259139
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1259139#c6
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_sensitivity:
- technical
notification_emails:
- fx-search-telemetry@mozilla.com
- rev-data@mozilla.com
expires: never
lifetime: application
send_in_pings:
- 'metrics'
changed:
type: event
description: |
Recorded when the default search engine is changed.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1634555
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1634555
data_sensitivity:
- web_activity
notification_emails:
- fx-search-telemetry@mozilla.com
- rev-data@mozilla.com
expires: never
extra_keys:
previous_engine_id:
type: string
description: The id of the previous default engine.
new_engine_id:
type: string
description: The id of the new default engine.
new_display_name:
type: string
description: The display name of the new default engine.
new_load_path:
type: string
description: |
The path relating to where the new default engine was installed/loaded
from.
new_submission_url:
type: string
description: |
The new submission URL of the new default engine. This is
limited to 100 characters.
change_source:
type: string
description: |
The source of the change of engine. For possible values,
see `REASON_CHANGE_MAP` in
https://searchfox.org/mozilla-central/source/toolkit/components/search/SearchService.sys.mjs
search.engine.private:
engine_id:
type: string
description: |
The telemetry id of the search engine.
For application provided engines, this is either supplied by the
configuration or from the first part of the associated WebExtension Id.
For other engines, this is `other-<extensionName>`.
If this string is an empty string (`""`), this means that one or both of
the preferences `browser.search.separatePrivateDefault` and
`browser.search.separatePrivateDefault.ui.enabled` are set to false.
It is possible that the user selects the same private engine as for the
default engine, and hence both versions of these fields will be filled in.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1563016
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1563016#c8
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
- rev-data@mozilla.com
expires: never
lifetime: application
send_in_pings:
- 'metrics'
- 'newtab'
display_name:
type: string
description: |
The display name of the user's default engine.
If this string is an empty string (`""`), this means that one or both of
the preferences `browser.search.separatePrivateDefault` and
`browser.search.separatePrivateDefault.ui.enabled` are set to false.
It is possible that the user selects the same private engine as for the
default engine, and hence both versions of these fields will be filled in.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1563016
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1563016#c8
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_sensitivity:
- interaction
notification_emails:
- fx-search-telemetry@mozilla.com
- rev-data@mozilla.com
expires: never
lifetime: application
send_in_pings:
- 'metrics'
load_path:
type: string
description: |
A path relating to where the search engine was installed/loaded from.
For example:
`[addon]<extension id>` for a WebExtension based
engine.
`[https]developer.mozilla.org/mdn-web-docs.xml` for an OpenSearch based
engine.
Note: this metric is truncated at 100 characters.
If this string is an empty string (`""`), this means that one or both of
the preferences `browser.search.separatePrivateDefault` and
`browser.search.separatePrivateDefault.ui.enabled` are set to false.
It is possible that the user selects the same private engine as for the
default engine, and hence both versions of these fields will be filled in.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1563016
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1563016#c8
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_sensitivity:
- web_activity
notification_emails:
- fx-search-telemetry@mozilla.com
- rev-data@mozilla.com
expires: never
lifetime: application
send_in_pings:
- 'metrics'
submission_url:
type: url
description: |
The submission URL of the default engine. This is only reported in the
cases where:
The engine is an application provided engine.
The engine has the same name as an application provided engine.
The engine matches one of a specific list of well known search engines.
If this string is an empty string (`""`), this means that one or both of
the preferences `browser.search.separatePrivateDefault` and
`browser.search.separatePrivateDefault.ui.enabled` are set to false.
It is possible that the user selects the same private engine as for the
default engine, and hence both versions of these fields will be filled in.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1563016
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1563016#c8
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_sensitivity:
- web_activity
notification_emails:
- fx-search-telemetry@mozilla.com
- rev-data@mozilla.com
expires: never
lifetime: application
send_in_pings:
- 'metrics'
verified:
type: string
description: |
The verified status of the search engine.
For application provided engines, this will always be `default`.
For other engines this will either be `verified` or `unverified` depending
on if the loadPathHash is valid.
If this string is an empty string (`""`), this means that one or both of
the preferences `browser.search.separatePrivateDefault` and
`browser.search.separatePrivateDefault.ui.enabled` are set to false.
It is possible that the user selects the same private engine as for the
default engine, and hence both versions of these fields will be filled in.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1563016
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1563016#c8
- https://bugzilla.mozilla.org/show_bug.cgi?id=1766999
data_sensitivity:
- technical
notification_emails:
- fx-search-telemetry@mozilla.com
- rev-data@mozilla.com
expires: never
lifetime: application
send_in_pings:
- 'metrics'
changed:
type: event
description: |
Recorded when the default search engine is changed
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1634555
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1634555
data_sensitivity:
- web_activity
notification_emails:
- fx-search-telemetry@mozilla.com
- rev-data@mozilla.com
expires: never
extra_keys:
previous_engine_id:
type: string
description: The id of the previous default engine.
new_engine_id:
type: string
description: The id of the new default engine.
new_display_name:
type: string
description: The display name of the new default engine.
new_load_path:
type: string
description: |
The path relating to where the new default engine was installed/loaded
from.
new_submission_url:
type: string
description: |
The new submission URL of the new default engine. This is
limited to 100 characters.
change_source:
type: string
description: |
The source of the change of engine. For possible values,
see `REASON_CHANGE_MAP` in
https://searchfox.org/mozilla-central/source/toolkit/components/search/SearchService.sys.mjs
search.service:
startup_time:
type: timing_distribution
time_unit: nanosecond
description: |
The time duration it takes for the search service to start up.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1832509
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1832509#c3
notification_emails:
- fx-search-telemetry@mozilla.com
data_sensitivity:
- technical
expires: never
telemetry_mirror: SEARCH_SERVICE_INIT2_MS
initialization_status:
type: labeled_counter
description: |
Counts the type of initialization statuses on start up.
failedSettings - failed loading and migrating the search settings file.
failedFetchEngines - failed to load or parse the configuration from remote
settings.
failedLoadEngines - failed to create all the search engines from the
configuration or user installed engines.
success - search service successfully initialized.
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849013
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1849013
notification_emails:
- fx-search-telemetry@mozilla.com
data_sensitivity:
- technical
expires: never
labels:
- failedSettings
- failedFetchEngines
- failedLoadEngines
- success
|
