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
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/ui/views/media_preview/media_preview_metrics.h"
#include <string>
#include "base/check_op.h"
#include "base/memory/weak_ptr.h"
#include "base/metrics/histogram.h"
#include "base/metrics/histogram_functions.h"
#include "base/strings/strcat.h"
#include "components/permissions/permission_request.h"
using base::StrCat;
namespace media_preview_metrics {
namespace {
constexpr char kUiPrefix[] = "MediaPreviews.UI.";
constexpr char kDeviceSelection[] = "DeviceSelection.";
constexpr char kPreview[] = "Preview.";
base::HistogramBase* GetMediaPreviewDurationHistogram(const std::string& name) {
// Duration buckets as powers of 2
const std::vector<int> custom_ranges{1, 2, 4, 8, 16, 32, 64, 128, 256, 512};
return base::CustomHistogram::FactoryGet(
name, custom_ranges, base::HistogramBase::kUmaTargetedHistogramFlag);
}
base::HistogramBase* GetTotalVisiblePreviewDurationHistogram(
const std::string& name) {
// Duration buckets in milliseconds.
const std::vector<int> custom_ranges{50, 125, 250, 500, 750, 1000,
1333, 1666, 2000, 2500, 3000, 4000};
return base::CustomHistogram::FactoryGet(
name, custom_ranges, base::HistogramBase::kUmaTargetedHistogramFlag);
}
base::HistogramBase* GetPreviewDelayTimeHistogram(const std::string& name) {
return GetTotalVisiblePreviewDurationHistogram(name);
}
const char* GetUiLocationString(UiLocation location) {
switch (location) {
case UiLocation::kPermissionPrompt:
return "Permissions";
case UiLocation::kPageInfo:
return "PageInfo";
}
}
const char* GetPreviewTypeString(const Context& context) {
switch (context.preview_type) {
case PreviewType::kCamera:
return "Camera";
case PreviewType::kMic:
return "Mic";
case PreviewType::kCameraAndMic:
return "CameraAndMic";
}
}
// Doesn't accept a Context with PreviewType::kCameraAndMic.
std::string GetUiLocationAndPreviewTypeString(const Context& context) {
CHECK_NE(context.preview_type, PreviewType::kCameraAndMic);
return StrCat({GetUiLocationString(context.ui_location), ".",
GetPreviewTypeString(context)});
}
std::string GetUiLocationAndPreviewTypeStringAllowingBoth(
const Context& context) {
if (context.preview_type == PreviewType::kCameraAndMic) {
CHECK_EQ(context.ui_location, UiLocation::kPermissionPrompt);
}
return StrCat({GetUiLocationString(context.ui_location), ".",
GetPreviewTypeString(context)});
}
void UmaHistogramLinearCounts(const std::string& name,
int sample,
int minimum,
int maximum,
size_t bucket_count) {
base::HistogramBase* histogram = base::LinearHistogram::FactoryGet(
name, minimum, maximum, bucket_count,
base::HistogramBase::kUmaTargetedHistogramFlag);
histogram->Add(sample);
}
} // anonymous namespace
Context::Context(UiLocation ui_location,
PreviewType preview_type,
std::optional<PromptType> prompt_type,
base::WeakPtr<permissions::PermissionRequest> request)
: ui_location(ui_location),
preview_type(preview_type),
prompt_type(prompt_type),
request(request) {}
Context::~Context() = default;
Context::Context(const Context& other) = default;
Context::Context(Context&& other) = default;
void RecordPageInfoNumInUseDevices(const Context& context, int devices) {
CHECK_EQ(context.ui_location, UiLocation::kPageInfo);
std::string metric_name =
StrCat({kUiPrefix, GetUiLocationAndPreviewTypeString(context),
".NumInUseDevices"});
base::UmaHistogramExactLinear(metric_name, devices, /*exclusive_max=*/5);
}
void RecordMediaPreviewDuration(const Context& context,
const base::TimeDelta& delta) {
std::string location_plus_type =
GetUiLocationAndPreviewTypeStringAllowingBoth(context);
std::string metric_name =
StrCat({kUiPrefix, location_plus_type, ".Duration"});
GetMediaPreviewDurationHistogram(metric_name)->Add(delta.InSeconds());
}
void RecordDeviceSelectionTotalDevices(const Context& context, int devices) {
std::string metric_name =
StrCat({kUiPrefix, kDeviceSelection,
GetUiLocationAndPreviewTypeString(context), ".NumDevices"});
base::UmaHistogramExactLinear(metric_name, devices, /*exclusive_max=*/5);
}
void RecordDeviceSelectionAction(
const Context& context,
MediaPreviewDeviceSelectionUserAction user_action) {
std::string metric_name =
StrCat({kUiPrefix, kDeviceSelection,
GetUiLocationAndPreviewTypeString(context), ".Action"});
base::UmaHistogramEnumeration(metric_name, user_action);
}
void RecordPreviewCameraPixelHeight(const Context& context, int pixel_height) {
CHECK_EQ(context.preview_type, PreviewType::kCamera);
std::string metric_name =
StrCat({kUiPrefix, GetUiLocationString(context.ui_location),
".Camera.PixelHeight"});
// This really has 8 buckets for 1-1080, but we have to add 2 for underflow
// and overflow.
UmaHistogramLinearCounts(metric_name, pixel_height, /*minimum=*/1,
/*maximum=*/1080, /*bucket_count=*/10);
}
void RecordPreviewVideoExpectedFPS(const Context& context, int expected_fps) {
CHECK_EQ(context.preview_type, PreviewType::kCamera);
std::string metric_name =
StrCat({kUiPrefix, kPreview, GetUiLocationString(context.ui_location),
".Video.ExpectedFPS"});
base::UmaHistogramExactLinear(metric_name, expected_fps,
/*exclusive_max=*/61);
}
void RecordPreviewVideoActualFPS(const Context& context, int actual_fps) {
CHECK_EQ(context.preview_type, PreviewType::kCamera);
std::string metric_name =
StrCat({kUiPrefix, kPreview, GetUiLocationString(context.ui_location),
".Video.ActualFPS"});
base::UmaHistogramExactLinear(metric_name, actual_fps,
/*exclusive_max=*/61);
}
void RecordPreviewVideoFramesRenderedPercent(const Context& context,
float percent) {
CHECK_EQ(context.preview_type, PreviewType::kCamera);
std::string metric_name =
StrCat({kUiPrefix, kPreview, GetUiLocationString(context.ui_location),
".Video.RenderedPercent"});
// Convert percentage to 0-100 integer.
int integer_percent = std::clamp(percent, /*lo=*/0.0f, /*hi=*/1.0f) * 100;
base::UmaHistogramPercentage(metric_name, integer_percent);
}
void RecordTotalVisiblePreviewDuration(const Context& context,
const base::TimeDelta& delta) {
CHECK_EQ(context.preview_type, PreviewType::kCamera);
std::string metric_name =
StrCat({kUiPrefix, kPreview, GetUiLocationString(context.ui_location),
".Video.TotalVisibleDuration"});
GetTotalVisiblePreviewDurationHistogram(metric_name)
->Add(delta.InMilliseconds());
}
void RecordTimeToActionWithoutPreview(const Context& context,
const base::TimeDelta& delta) {
CHECK_EQ(context.preview_type, PreviewType::kCamera);
std::string metric_name =
StrCat({kUiPrefix, kPreview, GetUiLocationString(context.ui_location),
".Video.TimeToActionWithoutPreview"});
GetPreviewDelayTimeHistogram(metric_name)->Add(delta.InMilliseconds());
}
void RecordPreviewDelayTime(const Context& context,
const base::TimeDelta& delta) {
CHECK_EQ(context.preview_type, PreviewType::kCamera);
std::string metric_name =
StrCat({kUiPrefix, kPreview, GetUiLocationString(context.ui_location),
".Video.Delay"});
GetPreviewDelayTimeHistogram(metric_name)->Add(delta.InMilliseconds());
}
void RecordOriginTrialAllowed(UiLocation location, bool allowed) {
base::UmaHistogramBoolean(
StrCat({kUiPrefix, GetUiLocationString(location), ".OriginTrialAllowed"}),
allowed);
}
void RecordVideoCaptureError(const Context& context,
media::VideoCaptureError received_error) {
CHECK_EQ(context.preview_type, PreviewType::kCamera);
std::string metric_name =
StrCat({kUiPrefix, kPreview, GetUiLocationString(context.ui_location),
".VideoCaptureError"});
base::UmaHistogramEnumeration(metric_name, received_error);
}
} // namespace media_preview_metrics
|
