background_sync_metrics.cc 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. // Copyright 2019 The Chromium Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style license that can be
  3. // found in the LICENSE file.
  4. #include "components/background_sync/background_sync_metrics.h"
  5. #include "base/bind.h"
  6. #include "components/background_sync/background_sync_delegate.h"
  7. #include "services/metrics/public/cpp/metrics_utils.h"
  8. #include "services/metrics/public/cpp/ukm_builders.h"
  9. #include "services/metrics/public/cpp/ukm_recorder.h"
  10. #include "url/origin.h"
  11. BackgroundSyncMetrics::BackgroundSyncMetrics(
  12. background_sync::BackgroundSyncDelegate* delegate)
  13. : delegate_(delegate) {
  14. DCHECK(delegate_);
  15. }
  16. BackgroundSyncMetrics::~BackgroundSyncMetrics() = default;
  17. void BackgroundSyncMetrics::MaybeRecordOneShotSyncRegistrationEvent(
  18. const url::Origin& origin,
  19. bool can_fire,
  20. bool is_reregistered) {
  21. DCHECK(delegate_);
  22. delegate_->GetUkmSourceId(
  23. origin,
  24. base::BindOnce(
  25. &BackgroundSyncMetrics::DidGetBackgroundSourceId,
  26. weak_ptr_factory_.GetWeakPtr(),
  27. base::BindOnce(
  28. &BackgroundSyncMetrics::RecordOneShotSyncRegistrationEvent,
  29. weak_ptr_factory_.GetWeakPtr(), can_fire, is_reregistered)));
  30. }
  31. void BackgroundSyncMetrics::MaybeRecordPeriodicSyncRegistrationEvent(
  32. const url::Origin& origin,
  33. int min_interval,
  34. bool is_reregistered) {
  35. DCHECK(delegate_);
  36. delegate_->GetUkmSourceId(
  37. origin,
  38. base::BindOnce(
  39. &BackgroundSyncMetrics::DidGetBackgroundSourceId,
  40. weak_ptr_factory_.GetWeakPtr(),
  41. base::BindOnce(
  42. &BackgroundSyncMetrics::RecordPeriodicSyncRegistrationEvent,
  43. weak_ptr_factory_.GetWeakPtr(), min_interval, is_reregistered)));
  44. }
  45. void BackgroundSyncMetrics::MaybeRecordOneShotSyncCompletionEvent(
  46. const url::Origin& origin,
  47. blink::ServiceWorkerStatusCode status_code,
  48. int num_attempts,
  49. int max_attempts) {
  50. DCHECK(delegate_);
  51. delegate_->GetUkmSourceId(
  52. origin, base::BindOnce(
  53. &BackgroundSyncMetrics::DidGetBackgroundSourceId,
  54. weak_ptr_factory_.GetWeakPtr(),
  55. base::BindOnce(
  56. &BackgroundSyncMetrics::RecordOneShotSyncCompletionEvent,
  57. weak_ptr_factory_.GetWeakPtr(), status_code, num_attempts,
  58. max_attempts)));
  59. }
  60. void BackgroundSyncMetrics::MaybeRecordPeriodicSyncEventCompletion(
  61. const url::Origin& origin,
  62. blink::ServiceWorkerStatusCode status_code,
  63. int num_attempts,
  64. int max_attempts) {
  65. DCHECK(delegate_);
  66. delegate_->GetUkmSourceId(
  67. origin, base::BindOnce(
  68. &BackgroundSyncMetrics::DidGetBackgroundSourceId,
  69. weak_ptr_factory_.GetWeakPtr(),
  70. base::BindOnce(
  71. &BackgroundSyncMetrics::RecordPeriodicSyncEventCompletion,
  72. weak_ptr_factory_.GetWeakPtr(), status_code, num_attempts,
  73. max_attempts)));
  74. }
  75. void BackgroundSyncMetrics::DidGetBackgroundSourceId(
  76. RecordCallback record_callback,
  77. absl::optional<ukm::SourceId> source_id) {
  78. // This background event did not meet the requirements for the UKM service.
  79. if (!source_id)
  80. return;
  81. std::move(record_callback).Run(*source_id);
  82. if (ukm_event_recorded_for_testing_)
  83. std::move(ukm_event_recorded_for_testing_).Run();
  84. }
  85. void BackgroundSyncMetrics::RecordOneShotSyncRegistrationEvent(
  86. bool can_fire,
  87. bool is_reregistered,
  88. ukm::SourceId source_id) {
  89. ukm::UkmRecorder* recorder = ukm::UkmRecorder::Get();
  90. DCHECK(recorder);
  91. ukm::builders::BackgroundSyncRegistered(source_id)
  92. .SetCanFire(can_fire)
  93. .SetIsReregistered(is_reregistered)
  94. .Record(recorder);
  95. }
  96. void BackgroundSyncMetrics::RecordPeriodicSyncRegistrationEvent(
  97. int min_interval,
  98. bool is_reregistered,
  99. ukm::SourceId source_id) {
  100. ukm::UkmRecorder* recorder = ukm::UkmRecorder::Get();
  101. DCHECK(recorder);
  102. ukm::builders::PeriodicBackgroundSyncRegistered(source_id)
  103. .SetMinIntervalMs(ukm::GetExponentialBucketMin(
  104. min_interval, kUkmEventDataBucketSpacing))
  105. .SetIsReregistered(is_reregistered)
  106. .Record(recorder);
  107. }
  108. void BackgroundSyncMetrics::RecordOneShotSyncCompletionEvent(
  109. blink::ServiceWorkerStatusCode status_code,
  110. int num_attempts,
  111. int max_attempts,
  112. ukm::SourceId source_id) {
  113. ukm::UkmRecorder* recorder = ukm::UkmRecorder::Get();
  114. DCHECK(recorder);
  115. ukm::builders::BackgroundSyncCompleted(source_id)
  116. .SetStatus(static_cast<int>(status_code))
  117. .SetNumAttempts(num_attempts)
  118. .SetMaxAttempts(max_attempts)
  119. .Record(recorder);
  120. }
  121. void BackgroundSyncMetrics::RecordPeriodicSyncEventCompletion(
  122. blink::ServiceWorkerStatusCode status_code,
  123. int num_attempts,
  124. int max_attempts,
  125. ukm::SourceId source_id) {
  126. ukm::UkmRecorder* recorder = ukm::UkmRecorder::Get();
  127. DCHECK(recorder);
  128. ukm::builders::PeriodicBackgroundSyncEventCompleted(source_id)
  129. .SetStatus(static_cast<int>(status_code))
  130. .SetNumAttempts(num_attempts)
  131. .SetMaxAttempts(max_attempts)
  132. .Record(recorder);
  133. }