Source code
Revision control
Copy as Markdown
Other Tools
# 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
# Adding a new metric? We have docs for that!
# Note that metrics that are only reported in background tasks should be put in
# `background_task_metrics.yaml` instead of this file. This file is for metrics
# that are reported in both background tasks and in desktop processes.
---
$schema: moz://mozilla.org/schemas/glean/metrics/2-0-0
$tags:
- "Toolkit :: Application Update"
update:
bits_error:
type: event
description: >
Recorded when an update download via BITS fails, with the error type
and, where BITS or Windows reported one, the HRESULT. Lets us see
whether BITS is commonly failing on some systems and which errors
the update code runs into when talking to it. Replaces
update.bitshresult, which could not carry the error code.
extra_keys:
patch_type:
description: >
Whether the failed download was a "complete" or "partial" update.
type: string
error_type:
description: >
The nsIBits ERROR_TYPE_* value of the failure.
type: quantity
error_action:
description: >
The nsIBits ERROR_ACTION_* value: what the update code was doing.
type: quantity
error_stage:
description: >
The nsIBits ERROR_STAGE_* value: where the failure happened.
type: quantity
code_type:
description: >
What kind of code the failure carries: "none", "nsresult",
"hresult", "string" or "exception" (see nsIBits ERROR_CODE_TYPE_*).
type: string
code:
description: >
The nsresult or HRESULT as an unsigned hexadecimal string, e.g.
0x800705b4. Absent for the other code types, whose payload is a
free-form message.
type: string
bugs:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1741675
data_reviews:
- https://bugzilla.mozilla.org/show_bug.cgi?id=1741675
data_sensitivity:
- technical
notification_emails:
- application-update-telemetry-alerts@mozilla.com
- jstutte@mozilla.com
expires: never
send_in_pings:
- background-update
- events
move_result:
type: labeled_counter
description: >
Firefox keeps downloading updates in a different place from updates
that are ready to install. Once the download completes, the
resulting file has to be moved from the downloading update directory
to the ready update directory. This probe counts the results that we
get when attempting to perform this file move. Valid values for the
keys for this probe are stored in the MOVE_RESULT_* values in
UpdateTelemetry.sys.mjs.
This metric was generated to correspond to the Legacy Telemetry
scalar update.move_result.
bugs:
- https://bugzil.la/353804
data_reviews:
- https://bugzil.la/353804
notification_emails:
- application-update-telemetry-alerts@mozilla.com
- bytesized@mozilla.com
expires: never
send_in_pings:
- background-update
- metrics
no_window_auto_restarts:
type: counter
description: >
On macOS, all browser windows can be closed without exiting Firefox.
If there is an update pending in that case, and we can install it
silently, we restart automatically in order to do so. This probe
counts the number of times the browser restarts to silently install
a pending update.
This metric was generated to correspond to the Legacy Telemetry
scalar update.no_window_auto_restarts.
bugs:
- https://bugzil.la/1720742
data_reviews:
- https://bugzil.la/1720742
notification_emails:
- application-update-telemetry-alerts@mozilla.com
- bytesized@mozilla.com
expires: never
send_in_pings:
- background-update
- metrics
suppress_prompts:
type: boolean
description: >
When an update is available and app.update.auto is disabled, a popup
is opened prompting the user to download and install the update. The
pref app.update.suppressPrompts causes Firefox Nightly to wait up to
7 days before showing the prompt, instead showing a badge and banner
in the meantime. It also prevents Nightly from showing update
restart prompts, instead showing a badge and banner immediately.
This value is set for the users who set this pref to true.
This metric was generated to correspond to the Legacy Telemetry
scalar update.suppress_prompts.
bugs:
- https://bugzil.la/1749155
data_reviews:
- https://bugzil.la/1749155
notification_emails:
- application-update-telemetry-alerts@mozilla.com
- bytesized@mozilla.com
expires: never
send_in_pings:
- background-update
- metrics
version_pin:
type: string
description: >
The AppUpdatePin Enterprise Policy controls the maximum version that
the browser can update to. If the policy is set, this probe will
report the policy's value. The possible policy values are "X." and
"X.Y.", where X is the pinned major version and Y is the pinned
minor version.
This metric was generated to correspond to the Legacy Telemetry
scalar update.version_pin.
bugs:
- https://bugzil.la/1762957
data_reviews:
- https://bugzil.la/1762957
notification_emails:
- application-update-telemetry-alerts@mozilla.com
- bytesized@mozilla.com
- telemetry-client-dev@thunderbird.net
expires: never
send_in_pings:
- background-update
- metrics