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 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chromeos/ash/components/quick_start/quick_start_metrics.h"
#include <memory>
#include <string>
#include "base/metrics/histogram_functions.h"
#include "base/timer/elapsed_timer.h"
#include "chromeos/ash/components/quick_start/logging.h"
#include "components/metrics/structured/structured_events.h"
#include "components/metrics/structured/structured_metrics_client.h"
#include "google_apis/gaia/google_service_auth_error.h"
namespace ash::quick_start {
namespace {
namespace cros_events = metrics::structured::events::v2::cr_os_events;
constexpr const char kChallengeBytesFetchDurationHistogramName[] =
"QuickStart.ChallengeBytes.FetchDuration";
constexpr const char kChallengeBytesFailureReasonHistogramName[] =
"QuickStart.ChallengeBytes.FailureReason";
constexpr const char kChallengeBytesFetchResultHistogramName[] =
"QuickStart.ChallengeBytes.FetchResult";
constexpr const char kAttestationCertificateFailureReasonHistogramName[] =
"QuickStart.AttestationCertificate.FailureReason";
constexpr const char kAttestationCertificateFetchResultHistogramName[] =
"QuickStart.AttestationCertificate.FetchResult";
constexpr const char kAttestationCertificateFetchDurationHistogramName[] =
"QuickStart.AttestationCertificate.FetchDuration";
constexpr const char kWifiTransferResultHistogramName[] =
"QuickStart.WifiTransferResult";
constexpr const char kWifiTransferResultFailureReasonHistogramName[] =
"QuickStart.WifiTransferResult.FailureReason";
constexpr const char kFastPairAdvertisementEndedSucceededHistogramName[] =
"QuickStart.FastPairAdvertisementEnded.Succeeded";
constexpr const char kFastPairAdvertisementEndedDurationHistogramName[] =
"QuickStart.FastPairAdvertisementEnded.Duration";
constexpr const char kFastPairAdvertisementEndedErrorCodeHistogramName[] =
"QuickStart.FastPairAdvertisementEnded.ErrorCode";
constexpr const char kFastPairAdvertisementStartedSucceededHistogramName[] =
"QuickStart.FastPairAdvertisementStarted.Succeeded";
constexpr const char kFastPairAdvertisementStartedErrorCodeHistogramName[] =
"QuickStart.FastPairAdvertisementStarted.ErrorCode";
constexpr const char
kNearbyConnectionsAdvertisementEndedSucceededHistogramName[] =
"QuickStart.NearbyConnectionsAdvertisementEnded.Succeeded";
constexpr const char
kNearbyConnectionsAdvertisementEndedDurationHistogramName[] =
"QuickStart.NearbyConnectionsAdvertisementEnded.Duration";
constexpr const char
kNearbyConnectionsAdvertisementEndedErrorCodeHistogramName[] =
"QuickStart.NearbyConnectionsAdvertisementEnded.ErrorCode";
constexpr const char
kNearbyConnectionsAdvertisementStartedSucceededHistogramName[] =
"QuickStart.NearbyConnectionsAdvertisementStarted.Succeeded";
constexpr const char
kNearbyConnectionsAdvertisementStartedErrorCodeHistogramName[] =
"QuickStart.NearbyConnectionsAdvertisementStarted.ErrorCode";
constexpr const char kAuthenticationMethodHistogramName[] =
"QuickStart.AuthenticationMethod";
constexpr const char kMessageReceivedWifiCredentials[] =
"QuickStart.MessageReceived.WifiCredentials";
constexpr const char kMessageReceivedBootstrapConfigurations[] =
"QuickStart.MessageReceived.BootstrapConfigurations";
constexpr const char kMessageReceivedHandshake[] =
"QuickStart.MessageReceived.Handshake";
constexpr const char kMessageReceivedNotifySourceOfUpdate[] =
"QuickStart.MessageReceived.NotifySourceOfUpdate";
constexpr const char kMessageReceivedGetInfo[] =
"QuickStart.MessageReceived.GetInfo";
constexpr const char kMessageReceivedAssertion[] =
"QuickStart.MessageReceived.Assertion";
constexpr const char kMessageReceivedBootstrapStateCancel[] =
"QuickStart.MessageReceived.BootstrapStateCancel";
constexpr const char kMessageReceivedBootstrapStateComplete[] =
"QuickStart.MessageReceived.BootstrapStateComplete";
constexpr const char kMessageReceivedDesiredMessageTypeName[] =
"QuickStart.MessageReceived.DesiredMessageType";
constexpr const char kMessageSentMessageTypeName[] =
"QuickStart.MessageSent.MessageType";
constexpr const char kHandshakeResultSucceededName[] =
"QuickStart.HandshakeResult.Succeeded";
constexpr const char kHandshakeResultDurationName[] =
"QuickStart.HandshakeResult.Duration";
constexpr const char kHandshakeResultErrorCodeName[] =
"QuickStart.HandshakeResult.ErrorCode";
constexpr const char kHandshakeStartedName[] = "QuickStart.HandshakeStarted";
constexpr const char kGaiaTransferResultName[] =
"QuickStart.GaiaTransferResult";
constexpr const char kGaiaTransferResultFailureReasonName[] =
"QuickStart.GaiaTransferResult.FailureReason";
constexpr const char kGaiaAuthenticationResultHistogramName[] =
"QuickStart.GaiaAuthentication.Result";
constexpr const char kGaiaAuthenticationDurationHistogramName[] =
"QuickStart.GaiaAuthentication.Duration";
constexpr const char kScreenOpened[] = "QuickStart.ScreenOpened";
constexpr const char kScreenClosedAddChild[] =
"QuickStart.ScreenClosed.AddChild";
constexpr const char
kScreenClosedCheckingForUpdateAndDeterminingDeviceConfiguration[] =
"QuickStart.ScreenClosed."
"CheckingForUpdateAndDeterminingDeviceConfiguration";
constexpr const char kScreenClosedChooseChromebookSetup[] =
"QuickStart.ScreenClosed.ChooseChromebookSetup";
constexpr const char kScreenClosedConsumerUpdate[] =
"QuickStart.ScreenClosed.ConsumerUpdate";
constexpr const char kScreenClosedGaiaInfoScreen[] =
"QuickStart.ScreenClosed.GaiaInfoScreen";
constexpr const char kScreenClosedGaiaScreen[] =
"QuickStart.ScreenClosed.GaiaScreen";
constexpr const char kScreenClosedNetworkScreen[] =
"QuickStart.ScreenClosed.NetworkScreen";
constexpr const char kScreenClosedNone[] = "QuickStart.ScreenClosed.None";
constexpr const char kScreenClosedOther[] = "QuickStart.ScreenClosed.Other";
constexpr const char kScreenClosedQSComplete[] =
"QuickStart.ScreenClosed.QSComplete";
constexpr const char kScreenClosedQSConnectingToWifi[] =
"QuickStart.ScreenClosed.QSConnectingToWifi";
constexpr const char kScreenClosedQSConnectingToPhone[] =
"QuickStart.ScreenClosed.QSConnectingToPhone";
constexpr const char kScreenClosedQSSelectGoogleAccount[] =
"QuickStart.ScreenClosed.QSSelectGoogleAccount";
constexpr const char kScreenClosedQSSetUpWithAndroidPhone[] =
"QuickStart.ScreenClosed.QSSetUpWithAndroidPhone";
constexpr const char kScreenClosedQSWifiCredentialsReceived[] =
"QuickStart.ScreenClosed.QSWifiCredentialsReceived";
constexpr const char kScreenClosedReviewPrivacyAndTerms[] =
"QuickStart.ScreenClosed.ReviewPrivacyAndTerms";
constexpr const char kScreenClosedSetupDevicePIN[] =
"QuickStart.ScreenClosed.SetupDevicePIN";
constexpr const char kScreenClosedUnifiedSetup[] =
"QuickStart.ScreenClosed.UnifiedSetup";
constexpr const char kScreenClosedWelcomeScreen[] =
"QuickStart.ScreenClosed.WelcomeScreen";
constexpr const char kScreenClosedQSGettingGoogleAccountInfo[] =
"QuickStart.ScreenClosed.QSGettingGoogleAccountInfo";
constexpr const char kScreenClosedQSCreatingAccount[] =
"QuickStart.ScreenClosed.QSCreatingAccount";
constexpr const char kScreenClosedQSFallbackURL[] =
"QuickStart.ScreenClosed.QSFallbackURL";
constexpr const char kSetupCompleteHistogramName[] = "QuickStart.SetupComplete";
constexpr const char kAbortFlowReasonHistogramName[] =
"QuickStart.FlowAborted.Reason";
constexpr const char kEntryPointHistogramName[] = "QuickStart.EntryPoint";
constexpr const char kEntryPointVisibleHistogramName[] =
"QuickStart.EntryPointVisible";
constexpr const char kConsumerUpdateStartedHistogramName[] =
"QuickStart.ConsumerUpdateStarted";
constexpr const char kConsumerUpdateCancelledHistogramName[] =
"QuickStart.ConsumerUpdateCancelled";
constexpr const char kForcedUpdateStartedHistogramName[] =
"QuickStart.ForcedUpdateStarted";
std::string MapMessageTypeToMetric(
QuickStartMetrics::MessageType message_type) {
switch (message_type) {
case QuickStartMetrics::MessageType::kWifiCredentials:
return kMessageReceivedWifiCredentials;
case QuickStartMetrics::MessageType::kBootstrapConfigurations:
return kMessageReceivedBootstrapConfigurations;
case QuickStartMetrics::MessageType::kHandshake:
return kMessageReceivedHandshake;
case QuickStartMetrics::MessageType::kNotifySourceOfUpdate:
return kMessageReceivedNotifySourceOfUpdate;
case QuickStartMetrics::MessageType::kGetInfo:
return kMessageReceivedGetInfo;
case QuickStartMetrics::MessageType::kAssertion:
return kMessageReceivedAssertion;
case QuickStartMetrics::MessageType::kBootstrapStateCancel:
return kMessageReceivedBootstrapStateCancel;
case QuickStartMetrics::MessageType::kBootstrapStateComplete:
return kMessageReceivedBootstrapStateComplete;
}
}
std::string MapScreenNameToMetric(QuickStartMetrics::ScreenName screen_name) {
switch (screen_name) {
case QuickStartMetrics::ScreenName::kNone:
return kScreenClosedNone;
case QuickStartMetrics::ScreenName::kWelcomeScreen:
return kScreenClosedWelcomeScreen;
case QuickStartMetrics::ScreenName::kNetworkScreen:
return kScreenClosedNetworkScreen;
case QuickStartMetrics::ScreenName::kGaiaScreen:
return kScreenClosedGaiaScreen;
case QuickStartMetrics::ScreenName::kQSSetUpWithAndroidPhone:
return kScreenClosedQSSetUpWithAndroidPhone;
case QuickStartMetrics::ScreenName::kQSConnectingToWifi:
return kScreenClosedQSConnectingToWifi;
case QuickStartMetrics::ScreenName::
kCheckingForUpdateAndDeterminingDeviceConfiguration:
return kScreenClosedCheckingForUpdateAndDeterminingDeviceConfiguration;
case QuickStartMetrics::ScreenName::kChooseChromebookSetup:
return kScreenClosedChooseChromebookSetup;
case QuickStartMetrics::ScreenName::kConsumerUpdate:
return kScreenClosedConsumerUpdate;
case QuickStartMetrics::ScreenName::kQSConnectingToPhone:
return kScreenClosedQSConnectingToPhone;
case QuickStartMetrics::ScreenName::kQSGettingGoogleAccountInfo:
return kScreenClosedQSGettingGoogleAccountInfo;
case QuickStartMetrics::ScreenName::kQSComplete:
return kScreenClosedQSComplete;
case QuickStartMetrics::ScreenName::kSetupDevicePIN:
return kScreenClosedSetupDevicePIN;
case QuickStartMetrics::ScreenName::kAddChild:
return kScreenClosedAddChild;
case QuickStartMetrics::ScreenName::kReviewPrivacyAndTerms:
return kScreenClosedReviewPrivacyAndTerms;
case QuickStartMetrics::ScreenName::kUnifiedSetup:
return kScreenClosedUnifiedSetup;
case QuickStartMetrics::ScreenName::kGaiaInfoScreen:
return kScreenClosedGaiaInfoScreen;
case QuickStartMetrics::ScreenName::kQSWifiCredentialsReceived:
return kScreenClosedQSWifiCredentialsReceived;
case QuickStartMetrics::ScreenName::kQSSelectGoogleAccount:
return kScreenClosedQSSelectGoogleAccount;
case QuickStartMetrics::ScreenName::kQSCreatingAccount:
return kScreenClosedQSCreatingAccount;
case QuickStartMetrics::ScreenName::kQSFallbackURL:
return kScreenClosedQSFallbackURL;
case QuickStartMetrics::ScreenName::kOther:
[[fallthrough]];
default:
return kScreenClosedOther;
}
}
} // namespace
// static
QuickStartMetrics::MessageType QuickStartMetrics::MapResponseToMessageType(
QuickStartResponseType response_type) {
switch (response_type) {
case QuickStartResponseType::kWifiCredentials:
return MessageType::kWifiCredentials;
case QuickStartResponseType::kBootstrapConfigurations:
return MessageType::kBootstrapConfigurations;
case QuickStartResponseType::kHandshake:
return MessageType::kHandshake;
case QuickStartResponseType::kNotifySourceOfUpdate:
return MessageType::kNotifySourceOfUpdate;
case QuickStartResponseType::kGetInfo:
return MessageType::kGetInfo;
case QuickStartResponseType::kAssertion:
return MessageType::kAssertion;
case QuickStartResponseType::kBootstrapStateCancel:
return MessageType::kBootstrapStateCancel;
case QuickStartResponseType::kBootstrapStateComplete:
return MessageType::kBootstrapStateComplete;
}
}
// static
QuickStartMetrics::ScreenClosedReason
QuickStartMetrics::MapAbortFlowReasonToScreenClosedReason(
AbortFlowReason reason) {
switch (reason) {
case AbortFlowReason::USER_CLICKED_BACK:
return ScreenClosedReason::kUserClickedBack;
case AbortFlowReason::USER_CLICKED_CANCEL:
return ScreenClosedReason::kUserCancelled;
case AbortFlowReason::SIGNIN_SCHOOL:
[[fallthrough]];
case AbortFlowReason::ADD_CHILD:
[[fallthrough]];
case AbortFlowReason::ENTERPRISE_ENROLLMENT:
return ScreenClosedReason::kAdvancedInFlow;
case AbortFlowReason::ERROR:
return ScreenClosedReason::kError;
}
}
// static
void QuickStartMetrics::RecordWifiTransferResult(
bool succeeded,
std::optional<WifiTransferResultFailureReason> failure_reason) {
if (succeeded) {
CHECK(!failure_reason.has_value());
} else {
CHECK(failure_reason.has_value());
base::UmaHistogramEnumeration(kWifiTransferResultFailureReasonHistogramName,
failure_reason.value());
}
base::UmaHistogramBoolean(kWifiTransferResultHistogramName, succeeded);
metrics::structured::StructuredMetricsClient::Record(
cros_events::QuickStart_GetWifiCredentials().SetSuccess(succeeded));
}
// static
void QuickStartMetrics::RecordAbortFlowReason(AbortFlowReason reason) {
base::UmaHistogramEnumeration(kAbortFlowReasonHistogramName, reason);
metrics::structured::StructuredMetricsClient::Record(
std::move(cros_events::QuickStart_FlowAborted().SetReason(
static_cast<cros_events::QuickStartAbortFlowReason>(reason))));
}
// static
void QuickStartMetrics::RecordGaiaTransferStarted() {
metrics::structured::StructuredMetricsClient::Record(
cros_events::QuickStart_AccountTransferStarted());
}
// static
void QuickStartMetrics::RecordGaiaTransferResult(
bool succeeded,
std::optional<GaiaTransferResultFailureReason> failure_reason) {
if (succeeded) {
CHECK(!failure_reason.has_value());
} else {
CHECK(failure_reason.has_value());
base::UmaHistogramEnumeration(kGaiaTransferResultFailureReasonName,
failure_reason.value());
}
base::UmaHistogramBoolean(kGaiaTransferResultName, succeeded);
metrics::structured::StructuredMetricsClient::Record(
cros_events::QuickStart_AccountTransferComplete().SetSuccess(succeeded));
}
// static
void QuickStartMetrics::RecordEntryPoint(EntryPoint entry_point) {
base::UmaHistogramEnumeration(kEntryPointHistogramName, entry_point);
metrics::structured::StructuredMetricsClient::Record(
std::move(cros_events::QuickStart_Initiated().SetEntryPoint(
static_cast<cros_events::QuickStartEntryPoint>(entry_point))));
}
// static
void QuickStartMetrics::RecordEntryPointVisible(EntryPoint entry_point) {
base::UmaHistogramEnumeration(kEntryPointVisibleHistogramName, entry_point);
}
// static
void QuickStartMetrics::RecordAuthenticationMethod(
AuthenticationMethod auth_method) {
base::UmaHistogramEnumeration(kAuthenticationMethodHistogramName,
auth_method);
}
// static
void QuickStartMetrics::RecordUpdateStarted(bool is_forced) {
if (is_forced) {
base::UmaHistogramBoolean(kForcedUpdateStartedHistogramName, true);
metrics::structured::StructuredMetricsClient::Record(
cros_events::QuickStart_InstallForcedUpdate());
} else {
base::UmaHistogramBoolean(kConsumerUpdateStartedHistogramName, true);
metrics::structured::StructuredMetricsClient::Record(
cros_events::QuickStart_InstallConsumerUpdate());
}
}
// static
void QuickStartMetrics::RecordConsumerUpdateCancelled() {
base::UmaHistogramBoolean(kConsumerUpdateCancelledHistogramName, true);
metrics::structured::StructuredMetricsClient::Record(
cros_events::QuickStart_ConsumerUpdateCancelled());
}
// static
void QuickStartMetrics::RecordEstablishConnection(bool success,
bool is_automatic_resume) {
if (is_automatic_resume) {
metrics::structured::StructuredMetricsClient::Record(std::move(
cros_events::QuickStart_AutomaticResumeAfterUpdate().SetSuccess(
success)));
} else {
metrics::structured::StructuredMetricsClient::Record(std::move(
cros_events::QuickStart_EstablishConnection().SetSuccess(success)));
}
}
// static
void QuickStartMetrics::RecordSetupComplete() {
base::UmaHistogramBoolean(kSetupCompleteHistogramName, true);
}
QuickStartMetrics::QuickStartMetrics() = default;
QuickStartMetrics::~QuickStartMetrics() = default;
void QuickStartMetrics::RecordScreenOpened(ScreenName screen) {
base::UmaHistogramEnumeration(kScreenOpened, screen);
metrics::structured::StructuredMetricsClient::Record(
std::move(cros_events::QuickStart_ScreenOpened().SetScreenName(
static_cast<cros_events::QuickStartScreenName>(screen))));
screen_opened_view_duration_timer_ = std::make_unique<base::ElapsedTimer>();
last_screen_opened_ = screen;
}
void QuickStartMetrics::RecordScreenClosed(ScreenName screen,
ScreenClosedReason reason) {
if (screen_opened_view_duration_timer_ == nullptr) {
QS_LOG(ERROR) << "RecordScreenClosed called but now "
"screen_opened_view_duration_timer_ set. screen: "
<< screen;
return;
}
if (screen != last_screen_opened_) {
QS_LOG(ERROR) << "RecordScreenClosed called but screen does not match "
"last_screen_opened_. last_screen_opened_: "
<< last_screen_opened_ << " closed screen: " << screen;
return;
}
metrics::structured::StructuredMetricsClient::Record(
std::move(cros_events::QuickStart_ScreenClosed().SetScreenName(
static_cast<cros_events::QuickStartScreenName>(screen))));
base::UmaHistogramEnumeration(MapScreenNameToMetric(screen) + ".Reason",
reason);
base::UmaHistogramTimes(MapScreenNameToMetric(screen) + ".ViewDuration",
screen_opened_view_duration_timer_->Elapsed());
screen_opened_view_duration_timer_.reset();
}
void QuickStartMetrics::RecordChallengeBytesRequested() {
CHECK(!challenge_bytes_fetch_timer_)
<< "Only 1 challenge bytes request can be active at a time";
challenge_bytes_fetch_timer_ = std::make_unique<base::ElapsedTimer>();
}
void QuickStartMetrics::RecordChallengeBytesRequestEnded(
const GoogleServiceAuthError& status) {
CHECK(challenge_bytes_fetch_timer_)
<< "Challenge bytes request timer was not active. Unexpected "
"response.";
const bool is_success = status.state() == GoogleServiceAuthError::State::NONE;
base::UmaHistogramBoolean(kChallengeBytesFetchResultHistogramName,
/*sample=*/is_success);
base::UmaHistogramEnumeration(kChallengeBytesFailureReasonHistogramName,
/*sample=*/status.state(),
GoogleServiceAuthError::NUM_STATES);
base::UmaHistogramTimes(kChallengeBytesFetchDurationHistogramName,
challenge_bytes_fetch_timer_->Elapsed());
challenge_bytes_fetch_timer_.reset();
}
void QuickStartMetrics::RecordAttestationCertificateRequested() {
CHECK(!attestation_certificate_timer_)
<< "Only 1 attestation certificate request can be active at a time";
attestation_certificate_timer_ = std::make_unique<base::ElapsedTimer>();
}
void QuickStartMetrics::RecordAttestationCertificateRequestEnded(
std::optional<AttestationCertificateRequestErrorCode> error_code) {
CHECK(attestation_certificate_timer_)
<< "Attestation certificate request timer was not active. Unexpected "
"response.";
if (error_code) {
base::UmaHistogramEnumeration(
kAttestationCertificateFailureReasonHistogramName, error_code.value());
base::UmaHistogramBoolean(kAttestationCertificateFetchResultHistogramName,
false);
} else {
base::UmaHistogramBoolean(kAttestationCertificateFetchResultHistogramName,
true);
}
base::UmaHistogramTimes(kAttestationCertificateFetchDurationHistogramName,
attestation_certificate_timer_->Elapsed());
attestation_certificate_timer_.reset();
}
void QuickStartMetrics::RecordGaiaAuthenticationStarted() {
CHECK(!gaia_authentication_timer_)
<< "Only 1 Gaia authentication request can be active at a time";
gaia_authentication_timer_ = std::make_unique<base::ElapsedTimer>();
}
void QuickStartMetrics::RecordGaiaAuthenticationRequestEnded(
const GaiaAuthenticationResult& result) {
CHECK(gaia_authentication_timer_) << "Gaia authentication request timer was "
"not active. Unexpected response.";
base::UmaHistogramEnumeration(kGaiaAuthenticationResultHistogramName, result);
base::UmaHistogramTimes(kGaiaAuthenticationDurationHistogramName,
gaia_authentication_timer_->Elapsed());
gaia_authentication_timer_.reset();
}
void QuickStartMetrics::RecordFastPairAdvertisementStarted(
bool succeeded,
std::optional<FastPairAdvertisingErrorCode> error_code) {
// Timer may already exist if user has cancelled/re-entered Quick Start
// multiple times before establishing a connection.
if (fast_pair_advertising_timer_) {
fast_pair_advertising_timer_.reset();
}
if (succeeded) {
CHECK(!error_code.has_value());
fast_pair_advertising_timer_ = std::make_unique<base::ElapsedTimer>();
} else {
CHECK(error_code.has_value());
base::UmaHistogramEnumeration(
kFastPairAdvertisementStartedErrorCodeHistogramName,
error_code.value());
}
base::UmaHistogramBoolean(kFastPairAdvertisementStartedSucceededHistogramName,
succeeded);
}
void QuickStartMetrics::RecordFastPairAdvertisementEnded(
bool succeeded,
std::optional<FastPairAdvertisingErrorCode> error_code) {
CHECK(fast_pair_advertising_timer_);
base::TimeDelta duration = fast_pair_advertising_timer_->Elapsed();
if (succeeded) {
CHECK(!error_code.has_value());
base::UmaHistogramMediumTimes(
kFastPairAdvertisementEndedDurationHistogramName, duration);
} else {
CHECK(error_code.has_value());
base::UmaHistogramEnumeration(
kFastPairAdvertisementEndedErrorCodeHistogramName, error_code.value());
}
base::UmaHistogramBoolean(kFastPairAdvertisementEndedSucceededHistogramName,
succeeded);
fast_pair_advertising_timer_.reset();
}
void QuickStartMetrics::RecordNearbyConnectionsAdvertisementStarted(
bool succeeded,
std::optional<NearbyConnectionsAdvertisingErrorCode> error_code) {
// Timer may already exist if user has cancelled/re-entered Quick Start
// multiple times before establishing a connection.
if (nearby_connections_advertising_timer_) {
nearby_connections_advertising_timer_.reset();
}
if (succeeded) {
CHECK(!error_code.has_value());
nearby_connections_advertising_timer_ =
std::make_unique<base::ElapsedTimer>();
} else {
CHECK(error_code.has_value());
base::UmaHistogramEnumeration(
kNearbyConnectionsAdvertisementStartedErrorCodeHistogramName,
error_code.value());
}
base::UmaHistogramBoolean(
kNearbyConnectionsAdvertisementStartedSucceededHistogramName, succeeded);
}
void QuickStartMetrics::RecordNearbyConnectionsAdvertisementEnded(
bool succeeded,
std::optional<NearbyConnectionsAdvertisingErrorCode> error_code) {
CHECK(nearby_connections_advertising_timer_);
base::TimeDelta duration = nearby_connections_advertising_timer_->Elapsed();
if (succeeded) {
CHECK(!error_code.has_value());
base::UmaHistogramMediumTimes(
kNearbyConnectionsAdvertisementEndedDurationHistogramName, duration);
} else {
CHECK(error_code.has_value());
base::UmaHistogramEnumeration(
kNearbyConnectionsAdvertisementEndedErrorCodeHistogramName,
error_code.value());
}
base::UmaHistogramBoolean(
kNearbyConnectionsAdvertisementEndedSucceededHistogramName, succeeded);
nearby_connections_advertising_timer_.reset();
}
void QuickStartMetrics::RecordHandshakeStarted() {
base::UmaHistogramBoolean(kHandshakeStartedName, true);
if (handshake_elapsed_timer_) {
handshake_elapsed_timer_.reset();
}
handshake_elapsed_timer_ = std::make_unique<base::ElapsedTimer>();
}
void QuickStartMetrics::RecordHandshakeResult(
bool succeeded,
std::optional<HandshakeErrorCode> error_code) {
CHECK(handshake_elapsed_timer_);
if (!succeeded) {
CHECK(error_code.has_value());
base::UmaHistogramEnumeration(kHandshakeResultErrorCodeName,
error_code.value());
}
base::UmaHistogramBoolean(kHandshakeResultSucceededName, succeeded);
base::UmaHistogramTimes(kHandshakeResultDurationName,
handshake_elapsed_timer_->Elapsed());
handshake_elapsed_timer_.reset();
}
void QuickStartMetrics::RecordMessageSent(MessageType message_type) {
message_elapsed_timer_ = std::make_unique<base::ElapsedTimer>();
base::UmaHistogramEnumeration(kMessageSentMessageTypeName, message_type);
}
void QuickStartMetrics::RecordMessageReceived(
MessageType desired_message_type,
bool succeeded,
std::optional<MessageReceivedErrorCode> error_code) {
std::string metric_name = MapMessageTypeToMetric(desired_message_type);
if (succeeded) {
CHECK(!error_code.has_value());
} else {
CHECK(error_code.has_value());
base::UmaHistogramEnumeration(metric_name + ".ErrorCode",
error_code.value());
}
base::UmaHistogramBoolean(metric_name + ".Succeeded", succeeded);
if (message_elapsed_timer_) {
base::UmaHistogramTimes(metric_name + ".ListenDuration",
message_elapsed_timer_->Elapsed());
}
base::UmaHistogramEnumeration(kMessageReceivedDesiredMessageTypeName,
desired_message_type);
message_elapsed_timer_.reset();
}
std::ostream& operator<<(
std::ostream& stream,
const QuickStartMetrics::ScreenName& metrics_screen_name) {
switch (metrics_screen_name) {
case QuickStartMetrics::ScreenName::kOther:
stream << "[other]";
break;
case QuickStartMetrics::ScreenName::kNone:
stream << "[none]";
break;
case QuickStartMetrics::ScreenName::kWelcomeScreen:
stream << "[welcome screen]";
break;
case QuickStartMetrics::ScreenName::kNetworkScreen:
stream << "[network screen]";
break;
case QuickStartMetrics::ScreenName::kGaiaScreen:
stream << "[gaia screen]";
break;
case QuickStartMetrics::ScreenName::kQSSetUpWithAndroidPhone:
stream << "[QS setup with Android phone]";
break;
case QuickStartMetrics::ScreenName::kQSConnectingToWifi:
stream << "[QS connecting to wifi]";
break;
case QuickStartMetrics::ScreenName::
kCheckingForUpdateAndDeterminingDeviceConfiguration:
stream << "[checking for update and determining device configuration]";
break;
case QuickStartMetrics::ScreenName::kChooseChromebookSetup:
stream << "[choose Chromebook setup]";
break;
case QuickStartMetrics::ScreenName::kConsumerUpdate:
stream << "[consumer update]";
break;
case QuickStartMetrics::ScreenName::kQSConnectingToPhone:
stream << "[QS Connecting to Phone]";
break;
case QuickStartMetrics::ScreenName::kQSGettingGoogleAccountInfo:
stream << "[QS getting Google account info]";
break;
case QuickStartMetrics::ScreenName::kQSComplete:
stream << "[QS complete]";
break;
case QuickStartMetrics::ScreenName::kSetupDevicePIN:
stream << "[setup device PIN]";
break;
case QuickStartMetrics::ScreenName::kAddChild:
stream << "[add child]";
break;
case QuickStartMetrics::ScreenName::kReviewPrivacyAndTerms:
stream << "[review privacy and terms]";
break;
case QuickStartMetrics::ScreenName::kUnifiedSetup:
stream << "[unified setup]";
break;
case QuickStartMetrics::ScreenName::kGaiaInfoScreen:
stream << "[gaia info screen]";
break;
case QuickStartMetrics::ScreenName::kQSWifiCredentialsReceived:
stream << "[QS wifi credentials received]";
break;
case QuickStartMetrics::ScreenName::kQSSelectGoogleAccount:
stream << "[QS select Google account]";
break;
case QuickStartMetrics::ScreenName::kQSCreatingAccount:
stream << "[QS creating account]";
break;
case QuickStartMetrics::ScreenName::kQSFallbackURL:
stream << "[QS fallback URL]";
break;
}
return stream;
}
} // namespace ash::quick_start
|