| blob | 3f7a165f3d1f51d5a6761758d1e6f4f0f2334bdb |
1 Telemetry
2 =========
4 This section describes existing telemetry probes measuring interaction with the
5 Address Bar.
7 For telemetry specific to Firefox Suggest, see the
8 :doc:`firefox-suggest-telemetry` document.
10 .. contents::
11 :depth: 2
14 Histograms
15 ----------
17 PLACES_AUTOCOMPLETE_1ST_RESULT_TIME_MS
18 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 This probe tracks the amount of time it takes to get the first result.
21 It is an exponential histogram with values between 5 and 100.
23 PLACES_AUTOCOMPLETE_6_FIRST_RESULTS_TIME_MS
24 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 This probe tracks the amount of time it takes to get the first six results.
27 It is an exponential histogram with values between 50 and 1000.
29 FX_URLBAR_SELECTED_RESULT_METHOD
30 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 This probe tracks how a result was picked by the user from the list.
33 It is a categorical histogram with these values:
35 - ``enter``
36 The user pressed Enter without selecting a result first.
37 This most likely happens when the user confirms the default preselected
38 result (aka *heuristic result*), or when they select with the keyboard a
39 one-off search button and confirm with Enter.
40 - ``enterSelection``
41 The user selected a result, but not using Tab or the arrow keys, and then
42 pressed Enter. This is a rare and generally unexpected event, there may be
43 exotic ways to select a result we didn't consider, that are tracked here.
44 Look at arrowEnterSelection and tabEnterSelection for more common actions.
45 - ``click``
46 The user clicked on a result.
47 - ``arrowEnterSelection``
48 The user selected a result using the arrow keys, and then pressed Enter.
49 - ``tabEnterSelection``
50 The first key the user pressed to select a result was the Tab key, and then
51 they pressed Enter. Note that this means the user could have used the arrow
52 keys after first pressing the Tab key.
53 - ``rightClickEnter``
54 Before QuantumBar, it was possible to right-click a result to highlight but
55 not pick it. Then the user could press Enter. This is no more possible.
57 FX_URLBAR_ZERO_PREFIX_DWELL_TIME_MS
58 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60 This probe records the amount of time the zero-prefix view was shown; that is,
61 the time from when it was opened to the time it was closed. "Zero-prefix"
62 means the search string was empty, so the zero-prefix view is the view that's
63 shown when the user clicks in the urlbar before typing a search string. Often
64 it's also called the "top sites" view since normally it shows the user's top
65 sites. This is an exponential histogram whose values range from 0 to 60,000
66 with 50 buckets. Values are in milliseconds. This histogram was introduced in
67 Firefox 110.0 in bug 1806765.
69 PLACES_FRECENCY_RECALC_CHUNK_TIME_MS
70 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72 This records the time necessary to recalculate frecency of a chunk of pages,
73 as defined in the `PlacesFrecencyRecalculator <https://searchfox.org/mozilla-central/source/toolkit/components/places/PlacesFrecencyRecalculator.sys.mjs>`_ module.
75 Scalars
76 -------
78 urlbar.abandonment
79 ~~~~~~~~~~~~~~~~~~
81 A uint recording the number of abandoned engagements in the urlbar. An
82 abandonment occurs when the user begins using the urlbar but stops before
83 completing the engagement. This can happen when the user clicks outside the
84 urlbar to focus a different part of the window. It can also happen when the
85 user switches to another window while the urlbar is focused.
87 urlbar.autofill_deletion
88 ~~~~~~~~~~~~~~~~~~~~~~~~
90 A uint recording the deletion count for autofilled string in the urlbar.
91 This occurs when the user deletes whole autofilled string by BACKSPACE or
92 DELETE key while the autofilled string is selected.
94 urlbar.engagement
95 ~~~~~~~~~~~~~~~~~
97 A uint recording the number of engagements the user completes in the urlbar.
98 An engagement occurs when the user navigates to a page using the urlbar, for
99 example by picking a result in the urlbar panel or typing a search term or URL
100 in the urlbar and pressing the enter key.
102 urlbar.impression.*
103 ~~~~~~~~~~~~~~~~~~~
105 A uint recording the number of impression that was displaying when user picks
106 any result.
108 - ``autofill_about``
109 For about-page type autofill.
110 - ``autofill_adaptive``
111 For adaptive history type autofill.
112 - ``autofill_origin``
113 For origin type autofill.
114 - ``autofill_other``
115 Counts how many times some other type of autofill result that does not have
116 a specific scalar was shown. This is a fallback that is used when the code is
117 not properly setting a specific autofill type, and it should not normally be
118 used. If it appears in the data, it means we need to investigate and fix the
119 code that is not properly setting a specific autofill type.
120 - ``autofill_url``
121 For url type autofill.
123 urlbar.persistedsearchterms.revert_by_popup_count
124 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
126 A uint that is incremented when search terms are persisted in the Urlbar and
127 the Urlbar is reverted to show a full URL due to a PopupNotification. This
128 can happen when a user is on a SERP and permissions are requested, e.g.
129 request access to location. If the popup is persistent and the user did not
130 dismiss it before switching tabs, the popup will reappear when they return to
131 the tab. Thus, when returning to the tab with the persistent popup, this
132 value will be incremented because it should have persisted search terms but
133 instead showed a full URL.
135 urlbar.persistedsearchterms.view_count
136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138 A uint that is incremented when search terms should be persisted in the
139 Urlbar. This will trigger when a user loads a SERP from any SAP that results
140 in the search terms persisting in the Urlbar, as well as switching to a tab
141 containing a SERP that should be persisting the search terms in the Urlbar,
142 regardless of whether a PopupNotification is present. Thus, for every
143 ``revert_by_popup_count``, there should be at least one corresponding
144 ``view_count``.
146 urlbar.tips
147 ~~~~~~~~~~~
149 This is a keyed scalar whose values are uints and are incremented each time a
150 tip result is shown, a tip is picked, and a tip's help button is picked. The
151 keys are:
153 - ``intervention_clear-help``
154 Incremented when the user picks the help button in the clear-history search
155 intervention.
156 - ``intervention_clear-picked``
157 Incremented when the user picks the clear-history search intervention.
158 - ``intervention_clear-shown``
159 Incremented when the clear-history search intervention is shown.
160 - ``intervention_refresh-help``
161 Incremented when the user picks the help button in the refresh-Firefox
162 search intervention.
163 - ``intervention_refresh-picked``
164 Incremented when the user picks the refresh-Firefox search intervention.
165 - ``intervention_refresh-shown``
166 Incremented when the refresh-Firefox search intervention is shown.
167 - ``intervention_update_ask-help``
168 Incremented when the user picks the help button in the update_ask search
169 intervention, which is shown when there's a Firefox update available but the
170 user's preference says we should ask them to download and apply it.
171 - ``intervention_update_ask-picked``
172 Incremented when the user picks the update_ask search intervention.
173 - ``intervention_update_ask-shown``
174 Incremented when the update_ask search intervention is shown.
175 - ``intervention_update_refresh-help``
176 Incremented when the user picks the help button in the update_refresh search
177 intervention, which is shown when the user's browser is up to date but they
178 triggered the update intervention. We show this special refresh intervention
179 instead.
180 - ``intervention_update_refresh-picked``
181 Incremented when the user picks the update_refresh search intervention.
182 - ``intervention_update_refresh-shown``
183 Incremented when the update_refresh search intervention is shown.
184 - ``intervention_update_restart-help``
185 Incremented when the user picks the help button in the update_restart search
186 intervention, which is shown when there's an update and it's been downloaded
187 and applied. The user needs to restart to finish.
188 - ``intervention_update_restart-picked``
189 Incremented when the user picks the update_restart search intervention.
190 - ``intervention_update_restart-shown``
191 Incremented when the update_restart search intervention is shown.
192 - ``intervention_update_web-help``
193 Incremented when the user picks the help button in the update_web search
194 intervention, which is shown when we can't update the browser or possibly
195 even check for updates for some reason, so the user should download the
196 latest version from the web.
197 - ``intervention_update_web-picked``
198 Incremented when the user picks the update_web search intervention.
199 - ``intervention_update_web-shown``
200 Incremented when the update_web search intervention is shown.
201 - ``tabtosearch-shown``
202 Increment when a non-onboarding tab-to-search result is shown, once per
203 engine per engagement. Please note that the number of times non-onboarding
204 tab-to-search results are picked is the sum of all keys in
205 ``urlbar.searchmode.tabtosearch``. Please also note that more detailed
206 telemetry is recorded about both onboarding and non-onboarding tab-to-search
207 results in urlbar.tabtosearch.*. These probes in ``urlbar.tips`` are still
208 recorded because ``urlbar.tabtosearch.*`` is not currently recorded
209 in Release.
210 - ``tabtosearch_onboard-shown``
211 Incremented when a tab-to-search onboarding result is shown, once per engine
212 per engagement. Please note that the number of times tab-to-search
213 onboarding results are picked is the sum of all keys in
214 ``urlbar.searchmode.tabtosearch_onboard``.
215 - ``searchTip_onboard-picked``
216 Incremented when the user picks the onboarding search tip.
217 - ``searchTip_onboard-shown``
218 Incremented when the onboarding search tip is shown.
219 - ``searchTip_redirect-picked``
220 Incremented when the user picks the redirect search tip.
221 - ``searchTip_redirect-shown``
222 Incremented when the redirect search tip is shown.
224 urlbar.searchmode.*
225 ~~~~~~~~~~~~~~~~~~~
227 This is a set of keyed scalars whose values are uints incremented each
228 time search mode is entered in the Urlbar. The suffix on the scalar name
229 describes how search mode was entered. Possibilities include:
231 - ``bookmarkmenu``
232 Used when the user selects the Search Bookmarks menu item in the Library
233 menu.
234 - ``handoff``
235 Used when the user uses the search box on the new tab page and is handed off
236 to the address bar. NOTE: This entry point was disabled from Firefox 88 to
237 91. Starting with 91, it will appear but in low volume. Users must have
238 searching in the Urlbar disabled to enter search mode via handoff.
239 - ``keywordoffer``
240 Used when the user selects a keyword offer result.
241 - ``oneoff``
242 Used when the user selects a one-off engine in the Urlbar.
243 - ``shortcut``
244 Used when the user enters search mode with a keyboard shortcut or menu bar
245 item (e.g. ``Accel+K``).
246 - ``tabmenu``
247 Used when the user selects the Search Tabs menu item in the tab overflow
248 menu.
249 - ``tabtosearch``
250 Used when the user selects a tab-to-search result. These results suggest a
251 search engine when the search engine's domain is autofilled.
252 - ``tabtosearch_onboard``
253 Used when the user selects a tab-to-search onboarding result. These are
254 shown the first few times the user encounters a tab-to-search result.
255 - ``topsites_newtab``
256 Used when the user selects a search shortcut Top Site from the New Tab Page.
257 - ``topsites_urlbar``
258 Used when the user selects a search shortcut Top Site from the Urlbar.
259 - ``touchbar``
260 Used when the user taps a search shortct on the Touch Bar, available on some
261 Macs.
262 - ``typed``
263 Used when the user types an engine alias in the Urlbar.
264 - ``historymenu``
265 Used when the user selects the Search History menu item in a History
266 menu.
267 - ``other``
268 Used as a catchall for other behaviour. We don't expect this scalar to hold
269 any values. If it does, we need to correct an issue with search mode entry
270 points.
272 The keys for the scalars above are engine and source names. If the user enters
273 a remote search mode with a built-in engine, we record the engine name. If the
274 user enters a remote search mode with an engine they installed (e.g. via
275 OpenSearch or a WebExtension), we record ``other`` (not to be confused with
276 the ``urlbar.searchmode.other`` scalar above).
278 When a user enters local search mode, we record the English name of the
279 result source (e.g., "bookmarks," "history," "tabs"). If they enter local
280 search mode via ``typed``, we record the result source name with the suffix
281 "keyword" or "symbol," depending on whether the user used a symbol
282 (``^, %, *, >``) or a keyword (``@tabs, @bookmarks, @history, @actions``).
283 If they enter local search mode through ``keywordoffer``, we record the
284 result source name with the suffix "keyword" when they select a restrict
285 keyword.
287 Note that we slightly modify the engine name for some built-in engines: we
288 flatten all localized Amazon sites (Amazon.com, Amazon.ca, Amazon.de, etc.)
289 to "Amazon" and we flatten all localized Wikipedia sites (Wikipedia (en),
290 Wikipedia (fr), etc.) to "Wikipedia". This is done to reduce the number of
291 keys used by these scalars.
293 Changelog
294 Firefox 132
295 The scalar keys for ``urlbar.searchmode.typed`` and
296 ``urlbar.searchmode.keywordoffer`` have been updated.
298 For ``urlbar.searchmode.typed``:
299 - If the user enters local search mode using a restrict keyword (@tabs,
300 @history, @bookmarks, @actions) the scalar key is prefixed with
301 "keyword".
302 - If the user enters via a symbol (``%, ^, *, >``) the key is prefixed
303 with "symbol".
305 For example, in history search mode:
306 - If entered via a restrict keyword, the scalar key recorded is
307 ``history_keyword``.
308 - If entered via a symbol, the scalar key recorded is ``history_symbol``.
310 For ``urlbar.searchmode.keywordoffer``:
311 - If the user uses a restrict keyword through the keywordoffer method,
312 the scalar key is prefixed with "keyword".
314 Please note that symbols cannot trigger the ``urlbar.searchmode.keywordoffer``
315 telemetry, as symbols are only valid for typed. [Bug `1919180`_]
318 urlbar.picked.*
319 ~~~~~~~~~~~~~~~
321 This is a set of keyed scalars whose values are uints incremented each
322 time a result is picked from the Urlbar. The suffix on the scalar name
323 is the result type. The keys for the scalars above are the 0-based index of
324 the result in the urlbar panel when it was picked.
326 .. note::
327 Available from Firefox 84 on. Use the *FX_URLBAR_SELECTED_** histograms in
328 earlier versions.
330 .. note::
331 Firefox 102 deprecated ``autofill`` and added ``autofill_about``,
332 ``autofill_adaptive``, ``autofill_origin``, ``autofill_other``,
333 ``autofill_preloaded``, and ``autofill_url``. In Firefox 116,
334 ``autofill_preloaded`` was removed.
336 Valid result types are:
338 - ``autofill``
339 This scalar was deprecated in Firefox 102 and replaced with
340 ``autofill_about``, ``autofill_adaptive``, ``autofill_origin``,
341 ``autofill_other``, ``autofill_preloaded``, and ``autofill_url``. Previously
342 it was recorded in each of the cases that the other scalars now cover.
343 - ``autofill_about``
344 An autofilled "about:" page URI (e.g., about:config). The user must first
345 type "about:" to trigger this type of autofill.
346 - ``autofill_adaptive``
347 An autofilled URL from the user's adaptive history. This type of autofill
348 differs from ``autofill_url`` in two ways: (1) It's based on the user's
349 adaptive history, a particular type of history that associates the user's
350 search string with the URL they pick in the address bar. (2) It autofills
351 full URLs instead of "up to the next slash" partial URLs. For more
352 information on this type of autofill, see this `adaptive history autofill
353 document`_.
354 - ``autofill_origin``
355 An autofilled origin_ from the user's history. Typically "origin" means a
356 domain or host name like "mozilla.org". Technically it can also include a
357 URL scheme or protocol like "https" and a port number like ":8000". Firefox
358 can autofill domain names by themselves, domain names with schemes, domain
359 names with ports, and domain names with schemes and ports. All of these
360 cases count as origin autofill. For more information, see this `adaptive
361 history autofill document`_.
362 - ``autofill_other``
363 Counts how many times some other type of autofill result that does not have
364 a specific keyed scalar was picked at a given index. This is a fallback that
365 is used when the code is not properly setting a specific autofill type, and
366 it should not normally be used. If it appears in the data, it means we need
367 to investigate and fix the code that is not properly setting a specific
368 autofill type.
369 - ``autofill_url``
370 An autofilled URL or partial URL from the user's history. Firefox autofills
371 URLs "up to the next slash", so to trigger URL autofill, the user must first
372 type a domain name (or trigger origin autofill) and then begin typing the
373 rest of the URL (technically speaking, its path). As they continue typing,
374 the URL will only be partially autofilled up to the next slash, or if there
375 is no next slash, to the end of the URL. This allows the user to easily
376 visit different subpaths of a domain. For more information, see this
377 `adaptive history autofill document`_.
378 - ``bookmark``
379 A bookmarked URL.
380 - ``bookmark_adaptive``
381 A bookmarked URL retrieved from adaptive history.
382 - ``clipboard``
383 A URL retrieved from the system clipboard.
384 - ``dynamic``
385 A specially crafted result, often used in experiments when basic types are
386 not flexible enough for a rich layout.
387 - ``dynamic_wikipedia``
388 A dynamic Wikipedia Firefox Suggest result.
389 - ``extension``
390 Added by an add-on through the omnibox WebExtension API.
391 - ``formhistory``
392 A search suggestion from previous search history.
393 - ``history``
394 A URL from history.
395 - ``history_adaptive``
396 A URL from history retrieved from adaptive history.
397 - ``keyword``
398 A bookmark keyword.
399 - ``navigational``
400 A navigational suggestion Firefox Suggest result.
401 - ``quickaction``
402 A QuickAction.
403 - ``quicksuggest``
404 A Firefox Suggest (a.k.a. quick suggest) suggestion.
405 - ``remotetab``
406 A tab synced from another device.
407 - ``restrict_keyword_actions``
408 A restrict keyword result to enter search mode for actions.
409 - ``restrict_keyword_bookmarks``
410 A restrict keyword result to enter search mode for bookmarks.
411 - ``restrict_keyword_history``
412 A restrict keyword result to enter search mode for history.
413 - ``restrict_keyword_tabs``
414 A restrict keyword result to enter search mode for tabs.
415 - ``searchengine``
416 A search result, but not a suggestion. May be the default search action
417 or a search alias.
418 - ``searchsuggestion``
419 A remote search suggestion.
420 - ``switchtab``
421 An open tab.
422 - ``tabtosearch``
423 A tab to search result.
424 - ``tip``
425 A tip result.
426 - ``topsite``
427 An entry from top sites.
428 - ``trending``
429 A trending suggestion.
430 - ``unknown``
431 An unknown result type, a bug should be filed to figure out what it is.
432 - ``visiturl``
433 The user typed string can be directly visited.
434 - ``weather``
435 A Firefox Suggest weather suggestion.
437 .. _adaptive history autofill document: https://docs.google.com/document/d/e/2PACX-1vRBLr_2dxus-aYhZRUkW9Q3B1K0uC-a0qQyE3kQDTU3pcNpDHb36-Pfo9fbETk89e7Jz4nkrqwRhi4j/pub
438 .. _origin: https://html.spec.whatwg.org/multipage/origin.html#origin
440 urlbar.picked.searchmode.*
441 ~~~~~~~~~~~~~~~~~~~~~~~~~~
443 This is a set of keyed scalars whose values are uints incremented each time a
444 result is picked from the Urlbar while the Urlbar is in search mode. The
445 suffix on the scalar name is the search mode entry point. The keys for the
446 scalars are the 0-based index of the result in the urlbar panel when it was
447 picked.
449 .. note::
450 These scalars share elements of both ``urlbar.picked.*`` and
451 ``urlbar.searchmode.*``. Scalar name suffixes are search mode entry points,
452 like ``urlbar.searchmode.*``. The keys for these scalars are result indices,
453 like ``urlbar.picked.*``.
455 .. note::
456 These data are a subset of the data recorded by ``urlbar.picked.*``. For
457 example, if the user enters search mode by clicking a one-off then selects
458 a Google search suggestion at index 2, we would record in **both**
459 ``urlbar.picked.searchsuggestion`` and ``urlbar.picked.searchmode.oneoff``.
461 urlbar.tabtosearch.*
462 ~~~~~~~~~~~~~~~~~~~~
464 This is a set of keyed scalars whose values are uints incremented when a
465 tab-to-search result is shown, once per engine per engagement. There are two
466 sub-probes: ``urlbar.tabtosearch.impressions`` and
467 ``urlbar.tabtosearch.impressions_onboarding``. The former records impressions
468 of regular tab-to-search results and the latter records impressions of
469 onboarding tab-to-search results. The key values are identical to those of the
470 ``urlbar.searchmode.*`` probes: they are the names of the engines shown in the
471 tab-to-search results. Engines that are not built in are grouped under the
472 key ``other``.
474 .. note::
475 Due to the potentially sensitive nature of these data, they are currently
476 collected only on pre-release version of Firefox. See bug 1686330.
478 urlbar.zeroprefix.abandonment
479 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
481 A uint recording the number of abandonments of the zero-prefix view.
482 "Zero-prefix" means the search string was empty, so the zero-prefix view is
483 the view that's shown when the user clicks in the urlbar before typing a
484 search string. Often it's called the "top sites" view since normally it shows
485 the user's top sites. "Abandonment" means the user opened the zero-prefix view
486 but it was closed without the user picking a result inside it. This scalar was
487 introduced in Firefox 110.0 in bug 1806765.
489 urlbar.zeroprefix.engagement
490 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
492 A uint recording the number of engagements in the zero-prefix view.
493 "Zero-prefix" means the search string was empty, so the zero-prefix view is
494 the view that's shown when the user clicks in the urlbar before typing a
495 search string. Often it's called the "top sites" view since normally it shows
496 the user's top sites. "Engagement" means the user picked a result inside the
497 view. This scalar was introduced in Firefox 110.0 in bug 1806765.
499 urlbar.zeroprefix.exposure
500 ~~~~~~~~~~~~~~~~~~~~~~~~~~
502 A uint recording the number of times the user was exposed to the zero-prefix
503 view; that is, the number of times it was shown. "Zero-prefix" means the
504 search string was empty, so the zero-prefix view is the view that's shown when
505 the user clicks in the urlbar before typing a search string. Often it's called
506 the "top sites" view since normally it shows the user's top sites. This scalar
507 was introduced in Firefox 110.0 in bug 1806765.
509 urlbar.quickaction.picked
510 ~~~~~~~~~~~~~~~~~~~~~~~~~
512 A uint recording the number of times the user selected a quickaction, the
513 key is in the form $key-$n where $n is the number of characters the user typed
514 in order for the suggestion to show. See bug 1783155.
516 urlbar.unifiedsearchbutton.opened
517 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
519 A uint recording the number of times the user opens search mode popup via
520 Unified Search Button.
521 See bug 1936673.
523 urlbar.unifiedsearchbutton.picked
524 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
526 A uint recording the number of times the user selected a search mode via
527 Unified Search Button. See bug 1936673.
529 places.*
530 ~~~~~~~~
532 This is Places related telemetry.
534 Valid result types are:
536 - ``sponsored_visit_no_triggering_url``
537 Number of sponsored visits that could not find their triggering URL in
538 history. We expect this to be a small number just due to the navigation layer
539 manipulating URLs. A large or growing value may be a concern.
540 - ``pages_need_frecency_recalculation``
541 Number of pages in need of a frecency recalculation. This number should
542 remain small compared to the total number of pages in the database (see the
543 `PLACES_PAGES_COUNT` histogram). It can be used to valuate the frequency
544 and size of recalculations, for performance reasons.
546 Search Engagement Telemetry
547 ---------------------------
549 The search engagement telemetry provided since Firefox 110 is is recorded using
550 Glean events. Because of the data size, these events are collected only for a
551 subset of the population, using the Glean Sampling feature. Please see the
552 following documents for the details.
554 - `Engagement`_ :
555 It is defined as a completed action in urlbar, where a user picked one of
556 the results.
557 - `Abandonment`_ :
558 It is defined as an action where the user open the results but does not
559 complete an engagement action, usually unfocusing the urlbar. This also
560 happens when the user switches to another window, if the results popup was
561 opening.
563 .. _Engagement: https://dictionary.telemetry.mozilla.org/apps/firefox_desktop/metrics/urlbar_engagement
564 .. _Abandonment: https://dictionary.telemetry.mozilla.org/apps/firefox_desktop/metrics/urlbar_abandonment
566 Changelog
567 Firefox 128
568 The "actions" key was added to the engagement event. [Bug `1893067`_]
570 Firefox 125
571 The "impression" engagement event has been removed. [Bug `1878983`_]
573 .. _1893067: https://bugzilla.mozilla.org/show_bug.cgi?id=1893067
574 .. _1878983: https://bugzilla.mozilla.org/show_bug.cgi?id=1878983
577 Custom pings for Contextual Services
578 ------------------------------------
580 Contextual Services currently has two features involving the address bar, top
581 sites and Firefox Suggest. Top sites telemetry is sent in the `"top-sites" ping`_,
582 which is described in the linked Glean Dictionary page. For Firefox
583 Suggest, see the :doc:`firefox-suggest-telemetry` document.
585 .. _"top-sites" ping: https://mozilla.github.io/glean/book/user/pings/custom.html
587 Changelog
588 Firefox 122.0
589 PingCentre-sent custom pings removed. [Bug `1868580`_]
591 Firefox 116.0
592 The "top-sites" ping is implemented. [Bug `1836283`_]
594 .. _1868580: https://bugzilla.mozilla.org/show_bug.cgi?id=1868580
595 .. _1836283: https://bugzilla.mozilla.org/show_bug.cgi?id=1836283
598 Other telemetry relevant to the Address Bar
599 -------------------------------------------
601 Search Telemetry
602 ~~~~~~~~~~~~~~~~
604 Some of `the search telemetry`_ is also relevant to the address bar.
606 contextual.services.topsites.*
607 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
609 These keyed scalars instrument the impressions and clicks for sponsored top
610 sites in the urlbar.
611 The key is a combination of the source and the placement of the top sites link
612 (1-based) such as 'urlbar_1'. For each key, it records the counter of the
613 impression or click.
614 Note that these scalars are shared with the top sites on the newtab page.
616 Telemetry Environment
617 ~~~~~~~~~~~~~~~~~~~~~
619 The following preferences relevant to the address bar are recorded in
620 :doc:`telemetry environment data </toolkit/components/telemetry/data/environment>`:
622 - ``browser.search.suggest.enabled``: The global toggle for search
623 suggestions everywhere in Firefox (search bar, urlbar, etc.). Defaults to
624 true.
625 - ``browser.urlbar.autoFill``: The global preference for whether autofill in
626 the urlbar is enabled. When false, all types of autofill are disabled.
627 - ``browser.urlbar.autoFill.adaptiveHistory.enabled``: True if adaptive
628 history autofill in the urlbar is enabled.
629 - ``browser.urlbar.suggest.searches``: True if search suggestions are
630 enabled in the urlbar. Defaults to false.
632 Firefox Suggest
633 ~~~~~~~~~~~~~~~
635 Telemetry specific to Firefox Suggest is described in the
636 :doc:`firefox-suggest-telemetry` document.
638 .. _the search telemetry: /browser/search/telemetry.html
639 .. _1919180: https://bugzilla.mozilla.org/show_bug.cgi?id=1919180