<!--
Copyright 2021 The Chromium Authors
Use of this source code is governed by a BSD-style license that can be
found in the LICENSE file.
-->
<!--
This file is used to generate a comprehensive list of WebAuthn histograms
along with a detailed description for each histogram.
For best practices on writing histogram descriptions, see
https://chromium.googlesource.com/chromium/src.git/+/HEAD/tools/metrics/histograms/README.md
Please follow the instructions in the OWNERS file in this directory to find a
reviewer. If no OWNERS file exists, please consider signing up at
go/reviewing-metrics (Googlers only), as all subdirectories are expected to
have an OWNERS file. As a last resort you can send the CL to
[email protected].
-->
<histogram-configuration>
<histograms>
<histogram name="WebAuthentication.Android.CredManAvailability" enum="Boolean"
expires_after="2025-01-05">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records whether Android Credential Management service is available. Recorded
only for Android 14+, after the first passkey request on the profile.
</summary>
</histogram>
<histogram name="WebAuthentication.Android.CredManConditionalRequest"
enum="CredManGetRequestEnum" expires_after="2025-02-10">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records events for Android Credential Management getCredential API for
conditional UI requests.
</summary>
</histogram>
<histogram name="WebAuthentication.Android.CredManCreateRequest"
enum="CredManCreateRequestEnum" expires_after="2025-02-10">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records events for Android Credential Management createCredential API for
modal requests.
</summary>
</histogram>
<histogram name="WebAuthentication.Android.CredManModalRequests"
enum="CredManGetRequestEnum" expires_after="2025-01-05">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records events for Android Credential Management getCredential API for modal
requests.
</summary>
</histogram>
<histogram name="WebAuthentication.Android.CredManPrepareRequest"
enum="CredManPrepareRequestEnum" expires_after="2025-01-26">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records events for Android Credential Management prepareGetCredential API.
</summary>
</histogram>
<histogram name="WebAuthentication.Android.CredManPrepareRequestDuration"
units="ms" expires_after="2025-01-26">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the duration of Android Credential Management prepareGetCredential
API.
</summary>
</histogram>
<histogram name="WebAuthentication.CableV2.AOADiscoveryEvent"
enum="WebAuthenticationAOADiscoveryEvent" expires_after="2025-03-01">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records events that happen during the discovery of USB-connected phones.
</summary>
</histogram>
<histogram name="WebAuthentication.CableV2.DiscoveryEvent"
enum="WebAuthenticationCableV2DiscoveryEvent" expires_after="2025-03-01">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records events that happen when listening for a caBLEv2 device.
</summary>
</histogram>
<histogram name="WebAuthentication.CableV2.MobileEvent"
enum="WebAuthenticationCableV2MobileEvent" expires_after="2024-03-01">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records events that occur during a caBLE v2 transaction from the mobile
side.
</summary>
</histogram>
<histogram name="WebAuthentication.CableV2.MobileResult"
enum="WebAuthenticationCableV2MobileResult" expires_after="2024-03-01">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>Records the outcome of caBLEv2 transactions.</summary>
</histogram>
<histogram name="WebAuthentication.CableV2.PrelinkDataAgeDays" units="days"
expires_after="2024-07-07">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
The age, in days, of the caBLE prelink information published by Android
devices at the time when they upload it to sync. This measurement saturates
at 31 days and the value 32 indicates that the calculated age was negative.
</summary>
</histogram>
<histogram name="WebAuthentication.CableV2.RendezvousTime" units="ms"
expires_after="2024-03-01">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
The time between the phone connecting to the tunnel server (and thus
starting its BLE broadcast) to the point where it receives the handshake
message from the desktop.
</summary>
</histogram>
<histogram name="WebAuthentication.CableV2.TunnelEvent"
enum="WebAuthenticationCableV2TunnelEvent" expires_after="2025-03-01">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records events that occur during the creation of a caBLEv2 tunnel.
</summary>
</histogram>
<histogram name="WebAuthentication.CableV2.TunnelServerError"
enum="CombinedHttpResponseAndNetErrorCode" expires_after="2025-03-01">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records network and HTTP errors when a tunnel server connection fails. (The
HTTP error takes precedence if it's available.)
</summary>
</histogram>
<histogram name="WebAuthentication.ChromeOS.GetAssertionStatus"
enum="WebAuthenticationChromeOSGetAssertionResult"
expires_after="2024-12-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>Records the outcome of GetAssertion on Chrome OS.</summary>
</histogram>
<histogram name="WebAuthentication.ChromeOS.MakeCredentialStatus"
enum="WebAuthenticationChromeOSMakeCredentialResult"
expires_after="2024-12-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>Records the outcome of MakeCredential on Chrome OS.</summary>
</histogram>
<histogram name="WebAuthentication.ChromeOS.StartupRecordCount" units="records"
expires_after="2024-12-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the number of records of the user's WebAuthn credentials created on
Chrome OS.
</summary>
</histogram>
<histogram name="WebAuthentication.ConditionalUiPasskeyCount" units="passkeys"
expires_after="2025-01-26">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the number of passkeys available for a Conditional UI get request.
</summary>
</histogram>
<histogram name="WebAuthentication.CredentialFetchDuration.{ApiUsed}"
units="ms" expires_after="2024-12-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
The duration of a request to obtain a list of credentials for a WebAuthn
conditional UI Get Assertion request, when using the {ApiUsed}. This is only
recorded when at least one credential is available in the results. This
complements the duration recorded by
WebAuthentication.Android.CredManPrepareRequestDuration, which only applies
to the CredMan API but emits on all requests including when there are no
results present.
</summary>
<token key="ApiUsed">
<variant name="ChromeOS" summary="ChromeOS platform API"/>
<variant name="CredMan" summary="Credential Manager API on Android"/>
<variant name="GmsCore" summary="GMS Core API on Android"/>
<variant name="ICloudKeychain" summary="ICloud Keychain API"/>
<variant name="TouchId" summary="Chrome-native Touch ID authenticator"/>
<variant name="WinHello" summary="Windows Hello API"/>
</token>
</histogram>
<histogram name="WebAuthentication.Enclave.ChangePinEvents"
enum="ChangePinEvent" expires_after="2024-12-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records events related to the GPM PIN Change flow. Recorded after when the
user clicks on "Change (Google) Password Manager PIN" in password
manager settings or when the user clicks "Forgot PIN" in the GPM
PIN dialog.
</summary>
</histogram>
<histogram name="WebAuthentication.EnclaveEvent"
enum="WebAuthenticationEnclaveEvent" expires_after="2024-12-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records events related to the enclave (i.e. Google Password Manager passkeys
on the desktop).
</summary>
</histogram>
<histogram name="WebAuthentication.GetAssertion.Result"
enum="WebAuthenticationCredentialRequestResult" expires_after="2025-02-10">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>Records the result of a get assertion request.</summary>
</histogram>
<histogram name="WebAuthentication.GetAssertionRequestTransport"
enum="WebAuthenticationFidoTransport" expires_after="2025-02-10">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the transport used for all WebAuthentication GetAssertion requests
sent to authenticators. This does not necessarily mean that there was a
success response from any given authenticator.
</summary>
</histogram>
<histogram name="WebAuthentication.GetAssertionResponseTransport"
enum="WebAuthenticationFidoTransport" expires_after="2025-02-10">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the transport used when an authenticator responds with success to a
WebAuthentication GetAssertion request.
</summary>
</histogram>
<histogram name="WebAuthentication.IsUVPlatformAuthenticatorAvailable2"
enum="Boolean" expires_after="2025-01-26">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the result of each Web Authentication
PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable() API
call.
</summary>
</histogram>
<histogram name="WebAuthentication.MacOS.PasskeyPermission"
enum="WebAuthenticationMacOSPasskeysPermission" expires_after="2025-02-23">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records whether Chromium is granted the macOS passkeys permission by users
when they're prompted for it.
</summary>
</histogram>
<histogram name="WebAuthentication.MacOS.PlatformAuthenticatorAction"
enum="WebAuthenticationMacOSPlatformAuthenticatorAction"
expires_after="2025-02-23">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records events from the macOS platform authenticator. Note that
"success" events are only recorded for transactions that
previously recorded a "start" event.
</summary>
</histogram>
<histogram name="WebAuthentication.MakeCredential.Result"
enum="WebAuthenticationCredentialRequestResult" expires_after="2024-12-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>Records the result of a make credential request.</summary>
</histogram>
<histogram name="WebAuthentication.MakeCredentialResponseTransport"
enum="WebAuthenticationFidoTransport" expires_after="2025-02-10">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the transport used when an authenticator responds with success to a
WebAuthentication MakeCredential request.
</summary>
</histogram>
<histogram name="WebAuthentication.Windows.FindHelloDialogIterationCount"
units="iterations" expires_after="2024-12-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the number of iterations that it took to find the Windows Hello
dialog for the purpose of bringing it to the foreground. This dialog is the
user verification for using or creating a KeyCredential signing key.
</summary>
</histogram>
<histogram name="WebAuthentication.Windows.ForegroundedWindowsHelloDialog"
enum="WindowsForegroundedHelloDialog" expires_after="2024-12-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the success or failure of attempts to bring the Windows Hello user
verification dialog to the foreground during a GPM passkey UV operation,
using or creating a KeyCredential signing key.
</summary>
</histogram>
<histogram name="WebAuthentication.Windows.KeyCredentialCreation"
enum="WindowsKeyCredentialCreateResult" expires_after="2024-12-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the result of the KeyCredentialManager.RequestCreateAsync method in
the Windows Runtime API. It is recorded when that method is called, which
currently only happens following a device registration with the GPM passkey
enclave service.
</summary>
</histogram>
<histogram name="WebAuthentication.Windows.KeyCredentialManagerSupported"
enum="WindowsKeyCredentialManagerSupportResults" expires_after="2024-12-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the result of the KeyCredentialManager.IsSupportedAsync method in
the Windows Runtime API. It is recorded on a low-priority thread at browser
startup.
</summary>
</histogram>
<histogram name="WebAuthentication.Windows.KeyCredentialSign"
enum="WindowsKeyCredentialSignResult" expires_after="2024-12-31">
<owner>[email protected]</owner>
<owner>[email protected]</owner>
<summary>
Records the result of the KeyCredential.RequestSignAsync method in the
Windows Runtime API. It is recorded when that method is called, which
currently only happens when signing a UV passkey request for the GPM passkey
enclave service.
</summary>
</histogram>
</histograms>
</histogram-configuration>
Codebase Browser
chromium