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
|
// 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.
#include "chromeos/ash/components/feature_usage/feature_usage_metrics.h"
#include <optional>
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/location.h"
#include "base/logging.h"
#include "base/metrics/histogram.h"
#include "base/metrics/histogram_functions.h"
#include "base/power_monitor/power_monitor.h"
#include "base/time/clock.h"
#include "base/time/default_clock.h"
#include "base/time/default_tick_clock.h"
#include "base/time/tick_clock.h"
#include "base/time/time.h"
#include "base/timer/timer.h"
namespace ash::feature_usage {
namespace {
constexpr char kFeatureUsageMetricPrefix[] = "ChromeOS.FeatureUsage.";
constexpr char kFeatureUsetimeMetricPostfix[] = ".Usetime";
std::string FeatureToHistogram(const std::string& feature_name) {
return kFeatureUsageMetricPrefix + feature_name;
}
} // namespace
std::optional<bool> FeatureUsageMetrics::Delegate::IsAccessible() const {
return std::nullopt;
}
// First time periodic metrics are reported after 'kInitialInterval` time.
constexpr base::TimeDelta FeatureUsageMetrics::kInitialInterval =
base::Minutes(1);
// Consecutive reports run every `kRepeatedInterval`
constexpr base::TimeDelta FeatureUsageMetrics::kRepeatedInterval =
base::Minutes(30);
FeatureUsageMetrics::FeatureUsageMetrics(const std::string& feature_name,
Delegate* const delegate)
: FeatureUsageMetrics(feature_name,
delegate,
base::DefaultClock::GetInstance(),
base::DefaultTickClock::GetInstance()) {}
FeatureUsageMetrics::FeatureUsageMetrics(const std::string& feature_name,
Delegate* const delegate,
const base::Clock* clock,
const base::TickClock* tick_clock)
: histogram_name_(FeatureToHistogram(feature_name)),
delegate_(delegate),
clock_(clock),
timer_(tick_clock) {
DCHECK(delegate_);
// Schedule the first run some time in the future to not overload startup
// flow.
SetupTimer(kInitialInterval);
base::PowerMonitor::GetInstance()->AddPowerSuspendObserver(this);
}
void FeatureUsageMetrics::SetupTimer(base::TimeDelta delta) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
timer_.Start(FROM_HERE, delta,
base::BindOnce(&FeatureUsageMetrics::MaybeReportPeriodicMetrics,
base::Unretained(this)));
}
FeatureUsageMetrics::~FeatureUsageMetrics() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
base::PowerMonitor::GetInstance()->RemovePowerSuspendObserver(this);
MaybeReportUseTime();
}
void FeatureUsageMetrics::RecordUsage(bool success) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(delegate_->IsEligible());
DCHECK(delegate_->IsEnabled());
DCHECK(start_usage_.is_null());
#if DCHECK_IS_ON()
last_record_usage_outcome_ = success;
#endif
MaybeReportPeriodicMetrics();
Event e = success ? Event::kUsedWithSuccess : Event::kUsedWithFailure;
base::UmaHistogramEnumeration(histogram_name_, e);
}
void FeatureUsageMetrics::RecordUsetime(base::TimeDelta usetime) const {
base::UmaHistogramLongTimes100(histogram_name_ + kFeatureUsetimeMetricPostfix,
usetime);
}
void FeatureUsageMetrics::StartSuccessfulUsage() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(start_usage_.is_null());
#if DCHECK_IS_ON()
DCHECK(last_record_usage_outcome_.value_or(false))
<< "Start usage must be preceded by RecordUsage(true)";
last_record_usage_outcome_.reset();
#endif
start_usage_ = Now();
}
void FeatureUsageMetrics::StopSuccessfulUsage() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
DCHECK(!start_usage_.is_null());
#if DCHECK_IS_ON()
DCHECK(!last_record_usage_outcome_.has_value())
<< "There must be no RecordUsage calls between Start and "
"StopSuccessfulUsage";
#endif
MaybeReportUseTime();
start_usage_ = base::Time();
}
void FeatureUsageMetrics::OnSuspend() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
timer_.Stop();
ReportPeriodicMetrics();
}
void FeatureUsageMetrics::OnResume() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!start_usage_.is_null()) {
// Do not report usage during suspension.
start_usage_ = Now();
}
SetupTimer(kInitialInterval);
}
void FeatureUsageMetrics::MaybeReportPeriodicMetrics() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!last_time_enabled_reported_.is_null()) {
const base::TimeDelta delta_since_enabled_reported =
Now() - last_time_enabled_reported_;
// Do not report periodic metrics more often than once per
// `kRepeatedInterval`.
if (kRepeatedInterval > delta_since_enabled_reported) {
// This could only happen when `RecordUsage` is called. In that case
// `IsEnabled` must be true. And because `last_time_enabled_reported_` is
// not null - `IsEnabled` was already reported recently.
SetupTimer(kRepeatedInterval - delta_since_enabled_reported);
return;
}
}
ReportPeriodicMetrics();
}
void FeatureUsageMetrics::ReportPeriodicMetrics() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
bool is_eligible = delegate_->IsEligible();
bool is_enabled = delegate_->IsEnabled();
DCHECK(!is_enabled || is_eligible);
if (is_eligible)
base::UmaHistogramEnumeration(histogram_name_, Event::kEligible);
std::optional<bool> is_accessible = delegate_->IsAccessible();
if (is_accessible.has_value()) {
// If accessible must be eligible.
DCHECK(!is_accessible.value() || is_eligible);
// If enabled must be accessible
DCHECK(!is_enabled || is_accessible.value());
if (is_accessible.value())
base::UmaHistogramEnumeration(histogram_name_, Event::kAccessible);
}
if (is_enabled) {
last_time_enabled_reported_ = Now();
base::UmaHistogramEnumeration(histogram_name_, Event::kEnabled);
}
// If the feature in the active use - it must be enabled.
DCHECK(start_usage_.is_null() || is_enabled);
MaybeReportUseTime();
SetupTimer(kRepeatedInterval);
}
void FeatureUsageMetrics::MaybeReportUseTime() {
if (start_usage_.is_null())
return;
base::TimeDelta use_time = Now() - start_usage_;
RecordUsetime(use_time);
start_usage_ = Now();
}
base::Time FeatureUsageMetrics::Now() const {
return clock_->Now();
}
} // namespace ash::feature_usage
|
