File: access_code_cast_metrics.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (196 lines) | stat: -rw-r--r-- 7,592 bytes parent folder | download | duplicates (5)
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
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_ACCESS_CODE_CAST_COMMON_ACCESS_CODE_CAST_METRICS_H_
#define COMPONENTS_ACCESS_CODE_CAST_COMMON_ACCESS_CODE_CAST_METRICS_H_

#include "base/component_export.h"
#include "base/time/time.h"

// NOTE: Do not renumber enums as that would confuse interpretation of
// previously logged data. When making changes, also update the enum list
// in tools/metrics/histograms/enums.xml to keep it in sync.

// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class AccessCodeCastAddSinkResult {
  kUnknownError = 0,
  kOk = 1,
  kAuthError = 2,
  kHttpResponseCodeError = 3,
  kResponseMalformed = 4,
  kEmptyResponse = 5,
  kInvalidAccessCode = 6,
  kAccessCodeNotFound = 7,
  kTooManyRequests = 8,
  kServiceNotPresent = 9,
  kServerError = 10,
  kSinkCreationError = 11,
  kChannelOpenError = 12,
  kProfileSyncError = 13,
  kInternalMediaRouterError = 14,

  // NOTE: Do not reorder existing entries, and add entries only immediately
  // above this line.
  kMaxValue = kInternalMediaRouterError
};

// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class AccessCodeCastCastMode {
  kPresentation = 0,
  kTabMirror = 1,
  kDesktopMirror = 2,
  kRemotePlayback = 3,

  // NOTE: Do not reorder existing entries, and add entries only immediately
  // above this line.
  kMaxValue = kRemotePlayback,
};

// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class AccessCodeCastDialogCloseReason {
  kFocus = 0,
  kCancel = 1,
  kCastSuccess = 2,

  // NOTE: Do not reorder existing entries, and add entries only immediately
  // above this line.
  kMaxValue = kCastSuccess
};

// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class AccessCodeCastDialogOpenLocation {
  kBrowserCastMenu = 0,
  kSystemTrayCastFeaturePod = 1,
  kSystemTrayCastMenu = 2,

  // NOTE: Do not reorder existing entries, and add entries only immediately
  // above this line.
  kMaxValue = kSystemTrayCastMenu
};

// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class AccessCodeCastDiscoveryTypeAndSource {
  kUnknown = 0,
  kSavedDevicePresentation = 1,
  kSavedDeviceTabMirror = 2,
  kSavedDeviceDesktopMirror = 3,
  kSavedDeviceRemotePlayback = 4,
  kNewDevicePresentation = 5,
  kNewDeviceTabMirror = 6,
  kNewDeviceDesktopMirror = 7,
  kNewDeviceRemotePlayback = 8,

  // NOTE: Do not reorder existing entries, and add entries only immediately
  // above this line.
  kMaxValue = kNewDeviceRemotePlayback
};

// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
enum class AccessCodeCastUiTabSwitcherUsage {
  kTabSwitcherUiShownAndNotUsed = 0,
  kTabSwitcherUiShownAndUsedToSwitchTabs = 1,

  // NOTE: Do not reorder existing entries, and add entries only immediately
  // above this line.
  kMaxValue = kTabSwitcherUiShownAndUsedToSwitchTabs,
};

class COMPONENT_EXPORT(COMPONENTS_ACCESS_CODE_CAST_COMMON)
    AccessCodeCastMetrics {
 public:
  AccessCodeCastMetrics();
  ~AccessCodeCastMetrics();

  // UMA histogram names.
  static const char kHistogramAccessCodeNotFoundCount[];
  static const char kHistogramAddSinkResultNew[];
  static const char kHistogramAddSinkResultRemembered[];
  static const char kHistogramCastModeOnSuccess[];
  static const char kHistogramDeviceDurationOnRoute[];
  static const char kHistogramDialogCloseReason[];
  static const char kHistogramDialogLoadTime[];
  static const char kHistogramDialogOpenLocation[];
  static const char kHistogramFreezeCount[];
  static const char kHistogramFreezeDuration[];
  static const char kHistogramNewDeviceRouteCreationDuration[];
  static const char kHistogramRememberedDevicesCount[];
  static const char kHistogramRouteDiscoveryTypeAndSource[];
  static const char kHistogramRouteDuration[];
  static const char kHistogramSavedDeviceRouteCreationDuration[];
  static const char kHistogramUiTabSwitcherUsageType[];
  static const char kHistogramUiTabSwitchingCount[];

  // Records metrics relating to starting a cast session (route). Mode is
  // media_router::MediaCastMode.
  static void OnCastSessionResult(int route_request_result_code,
                                  AccessCodeCastCastMode mode);

  // Records the count of ACCESS_CODE_NOT_FOUND errors per instance of dialog.
  static void RecordAccessCodeNotFoundCount(int count);

  // Records the value of the device duration pref on successful creation of
  // an access code route. Also records the discovery type and cast source.
  static void RecordAccessCodeRouteStarted(base::TimeDelta duration,
                                           bool is_saved,
                                           AccessCodeCastCastMode mode);

  // Records the result of adding an access code sink.
  static void RecordAddSinkResult(bool is_remembered,
                                  AccessCodeCastAddSinkResult result);

  // Records the time it takes for the AccessCodeCast dialog to load.
  static void RecordDialogLoadTime(base::TimeDelta load_time);

  // Records the reason that the AccessCodeCast dialog closed.
  static void RecordDialogCloseReason(AccessCodeCastDialogCloseReason reason);

  // Records where the user clicked to open the AccessCodeCast dialog.
  static void RecordDialogOpenLocation(
      AccessCodeCastDialogOpenLocation location);

  // Records the number of times a mirroring session is paused during its
  // duration.
  static void RecordMirroringPauseCount(int count);

  // Records the duration of time that a mirroring session is paused.
  static void RecordMirroringPauseDuration(base::TimeDelta duration);

  // Records the count of cast devices which are currently being remembered
  // being the AccessCodeCastSinkService.
  static void RecordRememberedDevicesCount(int count);

  // Records the length of time that a route to an access code device lasts.
  // The minimum length of time reported is one second, so any lower durations
  // will be rounded up. Also, the largest time reported is 8 hours, and any
  // longer times will be bucketed down.
  static void RecordRouteDuration(base::TimeDelta duration);

  // Records the count of tabs a user switches to during a tab mirroring
  // session.
  static void RecordTabSwitchesCountInTabSession(int count);

  // Records the usage type of tab switcher UI, i.e. shown only and not used or
  // shown and actually used to switch tabs.
  static void RecordTabSwitcherUsageCase(
      AccessCodeCastUiTabSwitcherUsage usage);

  // Records the time that it takes to connect to a saved device. It is a
  // combination of the time to request a mirroring route + waiting for a
  // success. It is only recorded if the request was successful.
  static void RecordSavedDeviceConnectDuration(base::TimeDelta duration);

  // Records the time it takes to connect to a new device. It is the combination
  // of connecting to our server, validating the access code, constructing a
  // cast device, opening a channel to that device, and then waiting for
  // success.
  static void RecordNewDeviceConnectDuration(base::TimeDelta duration);
};

#endif  // COMPONENTS_ACCESS_CODE_CAST_COMMON_ACCESS_CODE_CAST_METRICS_H_