blob: 2cc0de5fc4588e95f44f6f17b58b55f3da5aaef8 [file] [log] [blame]
Alex Deymoaea4c1c2015-08-19 20:24:43 -07001//
2// Copyright (C) 2014 The Android Open Source Project
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15//
David Zeuthen33bae492014-02-25 16:16:18 -080016
Amin Hassaniec7bc112020-10-29 16:47:58 -070017#include "update_engine/cros/metrics_reporter_omaha.h"
David Zeuthen33bae492014-02-25 16:16:18 -080018
Tianjie Xu98333a82017-09-22 21:29:29 -070019#include <memory>
David Zeuthen33bae492014-02-25 16:16:18 -080020
21#include <base/logging.h>
Marton Hunyadya0302682018-05-16 18:52:13 +020022#include <base/strings/string_number_conversions.h>
Alex Deymoa2591792015-11-17 00:39:40 -030023#include <metrics/metrics_library.h>
David Zeuthen33bae492014-02-25 16:16:18 -080024
Alex Deymo39910dc2015-11-09 17:04:30 -080025#include "update_engine/common/clock_interface.h"
26#include "update_engine/common/constants.h"
27#include "update_engine/common/prefs_interface.h"
Amin Hassaniec7bc112020-10-29 16:47:58 -070028#include "update_engine/common/system_state.h"
Alex Deymo39910dc2015-11-09 17:04:30 -080029#include "update_engine/common/utils.h"
Amin Hassaniec7bc112020-10-29 16:47:58 -070030#include "update_engine/cros/omaha_request_params.h"
Alex Deymoa2591792015-11-17 00:39:40 -030031#include "update_engine/metrics_utils.h"
David Zeuthen33bae492014-02-25 16:16:18 -080032
Amin Hassaniec7bc112020-10-29 16:47:58 -070033using base::Time;
34using base::TimeDelta;
David Zeuthen33bae492014-02-25 16:16:18 -080035using std::string;
36
37namespace chromeos_update_engine {
Tianjie Xu98333a82017-09-22 21:29:29 -070038namespace metrics {
39
David Zeuthen33bae492014-02-25 16:16:18 -080040// UpdateEngine.Daily.* metrics.
Tianjie Xu98333a82017-09-22 21:29:29 -070041const char kMetricDailyOSAgeDays[] = "UpdateEngine.Daily.OSAgeDays";
David Zeuthen33bae492014-02-25 16:16:18 -080042
43// UpdateEngine.Check.* metrics.
Tianjie Xu98333a82017-09-22 21:29:29 -070044const char kMetricCheckDownloadErrorCode[] =
David Zeuthen33bae492014-02-25 16:16:18 -080045 "UpdateEngine.Check.DownloadErrorCode";
Tianjie Xu98333a82017-09-22 21:29:29 -070046const char kMetricCheckReaction[] = "UpdateEngine.Check.Reaction";
47const char kMetricCheckResult[] = "UpdateEngine.Check.Result";
Marton Hunyadya0302682018-05-16 18:52:13 +020048const char kMetricCheckTargetVersion[] = "UpdateEngine.Check.TargetVersion";
49const char kMetricCheckRollbackTargetVersion[] =
50 "UpdateEngine.Check.RollbackTargetVersion";
Tianjie Xu98333a82017-09-22 21:29:29 -070051const char kMetricCheckTimeSinceLastCheckMinutes[] =
David Zeuthen33bae492014-02-25 16:16:18 -080052 "UpdateEngine.Check.TimeSinceLastCheckMinutes";
Tianjie Xu98333a82017-09-22 21:29:29 -070053const char kMetricCheckTimeSinceLastCheckUptimeMinutes[] =
David Zeuthen33bae492014-02-25 16:16:18 -080054 "UpdateEngine.Check.TimeSinceLastCheckUptimeMinutes";
55
56// UpdateEngine.Attempt.* metrics.
Tianjie Xu98333a82017-09-22 21:29:29 -070057const char kMetricAttemptNumber[] = "UpdateEngine.Attempt.Number";
58const char kMetricAttemptPayloadType[] = "UpdateEngine.Attempt.PayloadType";
59const char kMetricAttemptPayloadSizeMiB[] =
David Zeuthen33bae492014-02-25 16:16:18 -080060 "UpdateEngine.Attempt.PayloadSizeMiB";
Tianjie Xu98333a82017-09-22 21:29:29 -070061const char kMetricAttemptConnectionType[] =
David Zeuthenb281f072014-04-02 10:20:19 -070062 "UpdateEngine.Attempt.ConnectionType";
Tianjie Xu98333a82017-09-22 21:29:29 -070063const char kMetricAttemptDurationMinutes[] =
David Zeuthen33bae492014-02-25 16:16:18 -080064 "UpdateEngine.Attempt.DurationMinutes";
Tianjie Xu98333a82017-09-22 21:29:29 -070065const char kMetricAttemptDurationUptimeMinutes[] =
David Zeuthen33bae492014-02-25 16:16:18 -080066 "UpdateEngine.Attempt.DurationUptimeMinutes";
Tianjie Xu98333a82017-09-22 21:29:29 -070067const char kMetricAttemptTimeSinceLastAttemptMinutes[] =
David Zeuthen33bae492014-02-25 16:16:18 -080068 "UpdateEngine.Attempt.TimeSinceLastAttemptMinutes";
Tianjie Xu98333a82017-09-22 21:29:29 -070069const char kMetricAttemptTimeSinceLastAttemptUptimeMinutes[] =
David Zeuthen33bae492014-02-25 16:16:18 -080070 "UpdateEngine.Attempt.TimeSinceLastAttemptUptimeMinutes";
Tianjie Xu98333a82017-09-22 21:29:29 -070071const char kMetricAttemptPayloadBytesDownloadedMiB[] =
David Zeuthen33bae492014-02-25 16:16:18 -080072 "UpdateEngine.Attempt.PayloadBytesDownloadedMiB";
Tianjie Xu98333a82017-09-22 21:29:29 -070073const char kMetricAttemptPayloadDownloadSpeedKBps[] =
David Zeuthen33bae492014-02-25 16:16:18 -080074 "UpdateEngine.Attempt.PayloadDownloadSpeedKBps";
Tianjie Xu98333a82017-09-22 21:29:29 -070075const char kMetricAttemptDownloadSource[] =
David Zeuthen33bae492014-02-25 16:16:18 -080076 "UpdateEngine.Attempt.DownloadSource";
Tianjie Xu98333a82017-09-22 21:29:29 -070077const char kMetricAttemptResult[] = "UpdateEngine.Attempt.Result";
78const char kMetricAttemptInternalErrorCode[] =
David Zeuthen33bae492014-02-25 16:16:18 -080079 "UpdateEngine.Attempt.InternalErrorCode";
Tianjie Xu98333a82017-09-22 21:29:29 -070080const char kMetricAttemptDownloadErrorCode[] =
David Zeuthen33bae492014-02-25 16:16:18 -080081 "UpdateEngine.Attempt.DownloadErrorCode";
82
83// UpdateEngine.SuccessfulUpdate.* metrics.
Tianjie Xu98333a82017-09-22 21:29:29 -070084const char kMetricSuccessfulUpdateAttemptCount[] =
David Zeuthen33bae492014-02-25 16:16:18 -080085 "UpdateEngine.SuccessfulUpdate.AttemptCount";
Tianjie Xu98333a82017-09-22 21:29:29 -070086const char kMetricSuccessfulUpdateBytesDownloadedMiB[] =
David Zeuthen33bae492014-02-25 16:16:18 -080087 "UpdateEngine.SuccessfulUpdate.BytesDownloadedMiB";
Tianjie Xu98333a82017-09-22 21:29:29 -070088const char kMetricSuccessfulUpdateDownloadOverheadPercentage[] =
David Zeuthen33bae492014-02-25 16:16:18 -080089 "UpdateEngine.SuccessfulUpdate.DownloadOverheadPercentage";
Tianjie Xu98333a82017-09-22 21:29:29 -070090const char kMetricSuccessfulUpdateDownloadSourcesUsed[] =
David Zeuthen33bae492014-02-25 16:16:18 -080091 "UpdateEngine.SuccessfulUpdate.DownloadSourcesUsed";
May Lippert60aa3ca2018-08-15 16:55:29 -070092const char kMetricSuccessfulUpdateDurationFromSeenDays[] =
93 "UpdateEngine.SuccessfulUpdate.DurationFromSeenDays.NoTimeRestriction";
94const char kMetricSuccessfulUpdateDurationFromSeenTimeRestrictedDays[] =
95 "UpdateEngine.SuccessfulUpdate.DurationFromSeenDays.TimeRestricted";
Tianjie Xu98333a82017-09-22 21:29:29 -070096const char kMetricSuccessfulUpdatePayloadType[] =
David Zeuthen33bae492014-02-25 16:16:18 -080097 "UpdateEngine.SuccessfulUpdate.PayloadType";
Tianjie Xu98333a82017-09-22 21:29:29 -070098const char kMetricSuccessfulUpdatePayloadSizeMiB[] =
David Zeuthen33bae492014-02-25 16:16:18 -080099 "UpdateEngine.SuccessfulUpdate.PayloadSizeMiB";
Tianjie Xu98333a82017-09-22 21:29:29 -0700100const char kMetricSuccessfulUpdateRebootCount[] =
David Zeuthen33bae492014-02-25 16:16:18 -0800101 "UpdateEngine.SuccessfulUpdate.RebootCount";
Tianjie Xu98333a82017-09-22 21:29:29 -0700102const char kMetricSuccessfulUpdateTotalDurationMinutes[] =
David Zeuthen33bae492014-02-25 16:16:18 -0800103 "UpdateEngine.SuccessfulUpdate.TotalDurationMinutes";
Sen Jiang8712e962018-05-08 12:12:28 -0700104const char kMetricSuccessfulUpdateTotalDurationUptimeMinutes[] =
105 "UpdateEngine.SuccessfulUpdate.TotalDurationUptimeMinutes";
Tianjie Xu98333a82017-09-22 21:29:29 -0700106const char kMetricSuccessfulUpdateUpdatesAbandonedCount[] =
David Zeuthen33bae492014-02-25 16:16:18 -0800107 "UpdateEngine.SuccessfulUpdate.UpdatesAbandonedCount";
Tianjie Xu98333a82017-09-22 21:29:29 -0700108const char kMetricSuccessfulUpdateUrlSwitchCount[] =
David Zeuthen33bae492014-02-25 16:16:18 -0800109 "UpdateEngine.SuccessfulUpdate.UrlSwitchCount";
110
David Zeuthen96197df2014-04-16 12:22:39 -0700111// UpdateEngine.Rollback.* metric.
Tianjie Xu98333a82017-09-22 21:29:29 -0700112const char kMetricRollbackResult[] = "UpdateEngine.Rollback.Result";
David Zeuthen96197df2014-04-16 12:22:39 -0700113
Marton Hunyadya0302682018-05-16 18:52:13 +0200114// UpdateEngine.EnterpriseRollback.* metrics.
115const char kMetricEnterpriseRollbackFailure[] =
116 "UpdateEngine.EnterpriseRollback.Failure";
117const char kMetricEnterpriseRollbackSuccess[] =
118 "UpdateEngine.EnterpriseRollback.Success";
119
Alex Deymoc1c17b42015-11-23 03:53:15 -0300120// UpdateEngine.CertificateCheck.* metrics.
Tianjie Xu98333a82017-09-22 21:29:29 -0700121const char kMetricCertificateCheckUpdateCheck[] =
Alex Deymoc1c17b42015-11-23 03:53:15 -0300122 "UpdateEngine.CertificateCheck.UpdateCheck";
Tianjie Xu98333a82017-09-22 21:29:29 -0700123const char kMetricCertificateCheckDownload[] =
Alex Deymoc1c17b42015-11-23 03:53:15 -0300124 "UpdateEngine.CertificateCheck.Download";
125
Marton Hunyadyffbfdfb2018-05-30 13:03:29 +0200126// UpdateEngine.KernelKey.* metrics.
127const char kMetricKernelMinVersion[] = "UpdateEngine.KernelKey.MinVersion";
128const char kMetricKernelMaxRollforwardVersion[] =
129 "UpdateEngine.KernelKey.MaxRollforwardVersion";
130const char kMetricKernelMaxRollforwardSetSuccess[] =
131 "UpdateEngine.KernelKey.MaxRollforwardSetSuccess";
132
David Zeuthen33bae492014-02-25 16:16:18 -0800133// UpdateEngine.* metrics.
Tianjie Xu98333a82017-09-22 21:29:29 -0700134const char kMetricFailedUpdateCount[] = "UpdateEngine.FailedUpdateCount";
135const char kMetricInstallDateProvisioningSource[] =
David Zeuthen33bae492014-02-25 16:16:18 -0800136 "UpdateEngine.InstallDateProvisioningSource";
Tianjie Xu98333a82017-09-22 21:29:29 -0700137const char kMetricTimeToRebootMinutes[] = "UpdateEngine.TimeToRebootMinutes";
138
Tianjie Xud4c5deb2017-10-24 11:17:03 -0700139std::unique_ptr<MetricsReporterInterface> CreateMetricsReporter() {
140 return std::make_unique<MetricsReporterOmaha>();
141}
142
Tianjie Xu98333a82017-09-22 21:29:29 -0700143} // namespace metrics
144
145MetricsReporterOmaha::MetricsReporterOmaha()
146 : metrics_lib_(new MetricsLibrary()) {}
David Zeuthen33bae492014-02-25 16:16:18 -0800147
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700148void MetricsReporterOmaha::ReportDailyMetrics(base::TimeDelta os_age) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700149 string metric = metrics::kMetricDailyOSAgeDays;
Tianjie Xu98333a82017-09-22 21:29:29 -0700150 metrics_lib_->SendToUMA(metric,
151 static_cast<int>(os_age.InDays()),
152 0, // min: 0 days
153 6 * 30, // max: 6 months (approx)
154 50); // num_buckets
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700155}
156
157void MetricsReporterOmaha::ReportUpdateCheckMetrics(
158 SystemState* system_state,
159 metrics::CheckResult result,
160 metrics::CheckReaction reaction,
161 metrics::DownloadErrorCode download_error_code) {
David Zeuthen33bae492014-02-25 16:16:18 -0800162 string metric;
163 int value;
164 int max_value;
165
166 if (result != metrics::CheckResult::kUnset) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700167 metric = metrics::kMetricCheckResult;
David Zeuthen33bae492014-02-25 16:16:18 -0800168 value = static_cast<int>(result);
169 max_value = static_cast<int>(metrics::CheckResult::kNumConstants) - 1;
Tianjie Xu98333a82017-09-22 21:29:29 -0700170 metrics_lib_->SendEnumToUMA(metric, value, max_value);
David Zeuthen33bae492014-02-25 16:16:18 -0800171 }
172 if (reaction != metrics::CheckReaction::kUnset) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700173 metric = metrics::kMetricCheckReaction;
David Zeuthen33bae492014-02-25 16:16:18 -0800174 value = static_cast<int>(reaction);
175 max_value = static_cast<int>(metrics::CheckReaction::kNumConstants) - 1;
Tianjie Xu98333a82017-09-22 21:29:29 -0700176 metrics_lib_->SendEnumToUMA(metric, value, max_value);
David Zeuthen33bae492014-02-25 16:16:18 -0800177 }
178 if (download_error_code != metrics::DownloadErrorCode::kUnset) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700179 metric = metrics::kMetricCheckDownloadErrorCode;
David Zeuthen33bae492014-02-25 16:16:18 -0800180 value = static_cast<int>(download_error_code);
Tianjie Xu98333a82017-09-22 21:29:29 -0700181 metrics_lib_->SendSparseToUMA(metric, value);
David Zeuthen33bae492014-02-25 16:16:18 -0800182 }
183
184 base::TimeDelta time_since_last;
Amin Hassaniec7bc112020-10-29 16:47:58 -0700185 if (WallclockDurationHelper(system_state,
186 kPrefsMetricsCheckLastReportingTime,
187 &time_since_last)) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700188 metric = metrics::kMetricCheckTimeSinceLastCheckMinutes;
Tianjie Xu98333a82017-09-22 21:29:29 -0700189 metrics_lib_->SendToUMA(metric,
190 time_since_last.InMinutes(),
191 0, // min: 0 min
192 30 * 24 * 60, // max: 30 days
193 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800194 }
195
196 base::TimeDelta uptime_since_last;
197 static int64_t uptime_since_last_storage = 0;
Amin Hassaniec7bc112020-10-29 16:47:58 -0700198 if (MonotonicDurationHelper(
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700199 system_state, &uptime_since_last_storage, &uptime_since_last)) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700200 metric = metrics::kMetricCheckTimeSinceLastCheckUptimeMinutes;
Tianjie Xu98333a82017-09-22 21:29:29 -0700201 metrics_lib_->SendToUMA(metric,
202 uptime_since_last.InMinutes(),
203 0, // min: 0 min
204 30 * 24 * 60, // max: 30 days
205 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800206 }
Marton Hunyadya0302682018-05-16 18:52:13 +0200207
208 // First section of target version specified for the update.
209 if (system_state && system_state->request_params()) {
210 string target_version =
211 system_state->request_params()->target_version_prefix();
212 value = utils::VersionPrefix(target_version);
213 if (value != 0) {
214 metric = metrics::kMetricCheckTargetVersion;
Marton Hunyadya0302682018-05-16 18:52:13 +0200215 metrics_lib_->SendSparseToUMA(metric, value);
216 if (system_state->request_params()->rollback_allowed()) {
217 metric = metrics::kMetricCheckRollbackTargetVersion;
Marton Hunyadya0302682018-05-16 18:52:13 +0200218 metrics_lib_->SendSparseToUMA(metric, value);
219 }
220 }
221 }
David Zeuthen33bae492014-02-25 16:16:18 -0800222}
223
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700224void MetricsReporterOmaha::ReportAbnormallyTerminatedUpdateAttemptMetrics() {
Tianjie Xu98333a82017-09-22 21:29:29 -0700225 string metric = metrics::kMetricAttemptResult;
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700226 metrics::AttemptResult attempt_result =
227 metrics::AttemptResult::kAbnormalTermination;
David Zeuthen4e1d1492014-04-25 13:12:27 -0700228
Tianjie Xu98333a82017-09-22 21:29:29 -0700229 metrics_lib_->SendEnumToUMA(
David Zeuthen4e1d1492014-04-25 13:12:27 -0700230 metric,
231 static_cast<int>(attempt_result),
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700232 static_cast<int>(metrics::AttemptResult::kNumConstants));
David Zeuthen4e1d1492014-04-25 13:12:27 -0700233}
234
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700235void MetricsReporterOmaha::ReportUpdateAttemptMetrics(
236 SystemState* system_state,
David Zeuthen33bae492014-02-25 16:16:18 -0800237 int attempt_number,
238 PayloadType payload_type,
239 base::TimeDelta duration,
240 base::TimeDelta duration_uptime,
241 int64_t payload_size,
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700242 metrics::AttemptResult attempt_result,
Tianjie Xu1f93d092017-10-09 12:13:29 -0700243 ErrorCode internal_error_code) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700244 string metric = metrics::kMetricAttemptNumber;
Tianjie Xu98333a82017-09-22 21:29:29 -0700245 metrics_lib_->SendToUMA(metric,
246 attempt_number,
247 0, // min: 0 attempts
248 49, // max: 49 attempts
249 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800250
Tianjie Xu98333a82017-09-22 21:29:29 -0700251 metric = metrics::kMetricAttemptPayloadType;
Tianjie Xu98333a82017-09-22 21:29:29 -0700252 metrics_lib_->SendEnumToUMA(metric, payload_type, kNumPayloadTypes);
David Zeuthen33bae492014-02-25 16:16:18 -0800253
Tianjie Xu98333a82017-09-22 21:29:29 -0700254 metric = metrics::kMetricAttemptDurationMinutes;
Tianjie Xu98333a82017-09-22 21:29:29 -0700255 metrics_lib_->SendToUMA(metric,
256 duration.InMinutes(),
257 0, // min: 0 min
258 10 * 24 * 60, // max: 10 days
259 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800260
Tianjie Xu98333a82017-09-22 21:29:29 -0700261 metric = metrics::kMetricAttemptDurationUptimeMinutes;
Tianjie Xu98333a82017-09-22 21:29:29 -0700262 metrics_lib_->SendToUMA(metric,
263 duration_uptime.InMinutes(),
264 0, // min: 0 min
265 10 * 24 * 60, // max: 10 days
266 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800267
Tianjie Xu98333a82017-09-22 21:29:29 -0700268 metric = metrics::kMetricAttemptPayloadSizeMiB;
David Zeuthen33bae492014-02-25 16:16:18 -0800269 int64_t payload_size_mib = payload_size / kNumBytesInOneMiB;
Tianjie Xu98333a82017-09-22 21:29:29 -0700270 metrics_lib_->SendToUMA(metric,
271 payload_size_mib,
272 0, // min: 0 MiB
273 1024, // max: 1024 MiB = 1 GiB
274 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800275
Tianjie Xu98333a82017-09-22 21:29:29 -0700276 metric = metrics::kMetricAttemptResult;
Tianjie Xu98333a82017-09-22 21:29:29 -0700277 metrics_lib_->SendEnumToUMA(
David Zeuthen33bae492014-02-25 16:16:18 -0800278 metric,
279 static_cast<int>(attempt_result),
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700280 static_cast<int>(metrics::AttemptResult::kNumConstants));
David Zeuthen33bae492014-02-25 16:16:18 -0800281
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700282 if (internal_error_code != ErrorCode::kSuccess) {
Amin Hassani80f4d4c2018-05-16 13:34:00 -0700283 ReportInternalErrorCode(internal_error_code);
David Zeuthen33bae492014-02-25 16:16:18 -0800284 }
285
David Zeuthen33bae492014-02-25 16:16:18 -0800286 base::TimeDelta time_since_last;
Amin Hassaniec7bc112020-10-29 16:47:58 -0700287 if (WallclockDurationHelper(system_state,
288 kPrefsMetricsAttemptLastReportingTime,
289 &time_since_last)) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700290 metric = metrics::kMetricAttemptTimeSinceLastAttemptMinutes;
Tianjie Xu98333a82017-09-22 21:29:29 -0700291 metrics_lib_->SendToUMA(metric,
292 time_since_last.InMinutes(),
293 0, // min: 0 min
294 30 * 24 * 60, // max: 30 days
295 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800296 }
297
298 static int64_t uptime_since_last_storage = 0;
299 base::TimeDelta uptime_since_last;
Amin Hassaniec7bc112020-10-29 16:47:58 -0700300 if (MonotonicDurationHelper(
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700301 system_state, &uptime_since_last_storage, &uptime_since_last)) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700302 metric = metrics::kMetricAttemptTimeSinceLastAttemptUptimeMinutes;
Tianjie Xu98333a82017-09-22 21:29:29 -0700303 metrics_lib_->SendToUMA(metric,
304 uptime_since_last.InMinutes(),
305 0, // min: 0 min
306 30 * 24 * 60, // max: 30 days
307 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800308 }
Tianjie Xu1f93d092017-10-09 12:13:29 -0700309}
310
311void MetricsReporterOmaha::ReportUpdateAttemptDownloadMetrics(
312 int64_t payload_bytes_downloaded,
313 int64_t payload_download_speed_bps,
314 DownloadSource download_source,
315 metrics::DownloadErrorCode payload_download_error_code,
316 metrics::ConnectionType connection_type) {
317 string metric = metrics::kMetricAttemptPayloadBytesDownloadedMiB;
318 int64_t payload_bytes_downloaded_mib =
319 payload_bytes_downloaded / kNumBytesInOneMiB;
Tianjie Xu1f93d092017-10-09 12:13:29 -0700320 metrics_lib_->SendToUMA(metric,
321 payload_bytes_downloaded_mib,
322 0, // min: 0 MiB
323 1024, // max: 1024 MiB = 1 GiB
324 50); // num_buckets
325
326 metric = metrics::kMetricAttemptPayloadDownloadSpeedKBps;
327 int64_t payload_download_speed_kbps = payload_download_speed_bps / 1000;
Tianjie Xu1f93d092017-10-09 12:13:29 -0700328 metrics_lib_->SendToUMA(metric,
329 payload_download_speed_kbps,
330 0, // min: 0 kB/s
331 10 * 1000, // max: 10000 kB/s = 10 MB/s
332 50); // num_buckets
333
334 metric = metrics::kMetricAttemptDownloadSource;
Tianjie Xu1f93d092017-10-09 12:13:29 -0700335 metrics_lib_->SendEnumToUMA(metric, download_source, kNumDownloadSources);
336
337 if (payload_download_error_code != metrics::DownloadErrorCode::kUnset) {
338 metric = metrics::kMetricAttemptDownloadErrorCode;
Tianjie Xu1f93d092017-10-09 12:13:29 -0700339 metrics_lib_->SendSparseToUMA(
340 metric, static_cast<int>(payload_download_error_code));
341 }
David Zeuthenb281f072014-04-02 10:20:19 -0700342
Tianjie Xu98333a82017-09-22 21:29:29 -0700343 metric = metrics::kMetricAttemptConnectionType;
Tianjie Xu98333a82017-09-22 21:29:29 -0700344 metrics_lib_->SendEnumToUMA(
David Zeuthenb281f072014-04-02 10:20:19 -0700345 metric,
346 static_cast<int>(connection_type),
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700347 static_cast<int>(metrics::ConnectionType::kNumConstants));
David Zeuthen33bae492014-02-25 16:16:18 -0800348}
349
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700350void MetricsReporterOmaha::ReportSuccessfulUpdateMetrics(
351 int attempt_count,
352 int updates_abandoned_count,
353 PayloadType payload_type,
354 int64_t payload_size,
355 int64_t num_bytes_downloaded[kNumDownloadSources],
356 int download_overhead_percentage,
357 base::TimeDelta total_duration,
Sen Jiang8712e962018-05-08 12:12:28 -0700358 base::TimeDelta total_duration_uptime,
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700359 int reboot_count,
360 int url_switch_count) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700361 string metric = metrics::kMetricSuccessfulUpdatePayloadSizeMiB;
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700362 int64_t mbs = payload_size / kNumBytesInOneMiB;
Tianjie Xu98333a82017-09-22 21:29:29 -0700363 metrics_lib_->SendToUMA(metric,
364 mbs,
365 0, // min: 0 MiB
366 1024, // max: 1024 MiB = 1 GiB
367 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800368
369 int64_t total_bytes = 0;
370 int download_sources_used = 0;
371 for (int i = 0; i < kNumDownloadSources + 1; i++) {
372 DownloadSource source = static_cast<DownloadSource>(i);
373
374 // Only consider this download source (and send byte counts) as
375 // having been used if we downloaded a non-trivial amount of bytes
Alex Vakulenko072359c2014-07-18 11:41:07 -0700376 // (e.g. at least 1 MiB) that contributed to the
David Zeuthen33bae492014-02-25 16:16:18 -0800377 // update. Otherwise we're going to end up with a lot of zero-byte
378 // events in the histogram.
379
Tianjie Xu98333a82017-09-22 21:29:29 -0700380 metric = metrics::kMetricSuccessfulUpdateBytesDownloadedMiB;
David Zeuthen33bae492014-02-25 16:16:18 -0800381 if (i < kNumDownloadSources) {
382 metric += utils::ToString(source);
383 mbs = num_bytes_downloaded[i] / kNumBytesInOneMiB;
384 total_bytes += num_bytes_downloaded[i];
385 if (mbs > 0)
386 download_sources_used |= (1 << i);
387 } else {
388 mbs = total_bytes / kNumBytesInOneMiB;
389 }
390
391 if (mbs > 0) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700392 metrics_lib_->SendToUMA(metric,
393 mbs,
394 0, // min: 0 MiB
395 1024, // max: 1024 MiB = 1 GiB
396 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800397 }
398 }
399
Tianjie Xu98333a82017-09-22 21:29:29 -0700400 metric = metrics::kMetricSuccessfulUpdateDownloadSourcesUsed;
Tianjie Xu98333a82017-09-22 21:29:29 -0700401 metrics_lib_->SendToUMA(metric,
402 download_sources_used,
403 0, // min
404 (1 << kNumDownloadSources) - 1, // max
405 1 << kNumDownloadSources); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800406
Tianjie Xu98333a82017-09-22 21:29:29 -0700407 metric = metrics::kMetricSuccessfulUpdateDownloadOverheadPercentage;
Tianjie Xu98333a82017-09-22 21:29:29 -0700408 metrics_lib_->SendToUMA(metric,
409 download_overhead_percentage,
410 0, // min: 0% overhead
411 1000, // max: 1000% overhead
412 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800413
Tianjie Xu98333a82017-09-22 21:29:29 -0700414 metric = metrics::kMetricSuccessfulUpdateUrlSwitchCount;
Tianjie Xu98333a82017-09-22 21:29:29 -0700415 metrics_lib_->SendToUMA(metric,
416 url_switch_count,
417 0, // min: 0 URL switches
418 49, // max: 49 URL switches
419 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800420
Tianjie Xu98333a82017-09-22 21:29:29 -0700421 metric = metrics::kMetricSuccessfulUpdateTotalDurationMinutes;
Tianjie Xu98333a82017-09-22 21:29:29 -0700422 metrics_lib_->SendToUMA(metric,
423 static_cast<int>(total_duration.InMinutes()),
424 0, // min: 0 min
425 365 * 24 * 60, // max: 365 days ~= 1 year
426 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800427
Sen Jiang8712e962018-05-08 12:12:28 -0700428 metric = metrics::kMetricSuccessfulUpdateTotalDurationUptimeMinutes;
Sen Jiang8712e962018-05-08 12:12:28 -0700429 metrics_lib_->SendToUMA(metric,
430 static_cast<int>(total_duration_uptime.InMinutes()),
431 0, // min: 0 min
432 30 * 24 * 60, // max: 30 days
433 50); // num_buckets
434
Tianjie Xu98333a82017-09-22 21:29:29 -0700435 metric = metrics::kMetricSuccessfulUpdateRebootCount;
Tianjie Xu98333a82017-09-22 21:29:29 -0700436 metrics_lib_->SendToUMA(metric,
437 reboot_count,
438 0, // min: 0 reboots
439 49, // max: 49 reboots
440 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800441
Tianjie Xu98333a82017-09-22 21:29:29 -0700442 metric = metrics::kMetricSuccessfulUpdatePayloadType;
443 metrics_lib_->SendEnumToUMA(metric, payload_type, kNumPayloadTypes);
David Zeuthen33bae492014-02-25 16:16:18 -0800444
Tianjie Xu98333a82017-09-22 21:29:29 -0700445 metric = metrics::kMetricSuccessfulUpdateAttemptCount;
446 metrics_lib_->SendToUMA(metric,
447 attempt_count,
448 1, // min: 1 attempt
449 50, // max: 50 attempts
450 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800451
Tianjie Xu98333a82017-09-22 21:29:29 -0700452 metric = metrics::kMetricSuccessfulUpdateUpdatesAbandonedCount;
Tianjie Xu98333a82017-09-22 21:29:29 -0700453 metrics_lib_->SendToUMA(metric,
454 updates_abandoned_count,
455 0, // min: 0 counts
456 49, // max: 49 counts
457 50); // num_buckets
David Zeuthen33bae492014-02-25 16:16:18 -0800458}
459
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700460void MetricsReporterOmaha::ReportRollbackMetrics(
461 metrics::RollbackResult result) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700462 string metric = metrics::kMetricRollbackResult;
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700463 int value = static_cast<int>(result);
Tianjie Xu98333a82017-09-22 21:29:29 -0700464 metrics_lib_->SendEnumToUMA(
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700465 metric, value, static_cast<int>(metrics::RollbackResult::kNumConstants));
David Zeuthen96197df2014-04-16 12:22:39 -0700466}
467
Marton Hunyadya0302682018-05-16 18:52:13 +0200468void MetricsReporterOmaha::ReportEnterpriseRollbackMetrics(
469 bool success, const string& rollback_version) {
470 int value = utils::VersionPrefix(rollback_version);
471 string metric = metrics::kMetricEnterpriseRollbackSuccess;
472 if (!success)
473 metric = metrics::kMetricEnterpriseRollbackFailure;
Marton Hunyadya0302682018-05-16 18:52:13 +0200474 metrics_lib_->SendSparseToUMA(metric, value);
475}
476
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700477void MetricsReporterOmaha::ReportCertificateCheckMetrics(
478 ServerToCheck server_to_check, CertificateCheckResult result) {
Alex Deymoc1c17b42015-11-23 03:53:15 -0300479 string metric;
480 switch (server_to_check) {
481 case ServerToCheck::kUpdate:
Tianjie Xu98333a82017-09-22 21:29:29 -0700482 metric = metrics::kMetricCertificateCheckUpdateCheck;
Alex Deymoc1c17b42015-11-23 03:53:15 -0300483 break;
484 case ServerToCheck::kDownload:
Tianjie Xu98333a82017-09-22 21:29:29 -0700485 metric = metrics::kMetricCertificateCheckDownload;
Alex Deymoc1c17b42015-11-23 03:53:15 -0300486 break;
Alex Deymo33e91e72015-12-01 18:26:08 -0300487 case ServerToCheck::kNone:
488 return;
Alex Deymoc1c17b42015-11-23 03:53:15 -0300489 }
Tianjie Xu98333a82017-09-22 21:29:29 -0700490 metrics_lib_->SendEnumToUMA(
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700491 metric,
492 static_cast<int>(result),
Alex Deymoc1c17b42015-11-23 03:53:15 -0300493 static_cast<int>(CertificateCheckResult::kNumConstants));
494}
495
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700496void MetricsReporterOmaha::ReportFailedUpdateCount(int target_attempt) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700497 string metric = metrics::kMetricFailedUpdateCount;
498 metrics_lib_->SendToUMA(metric,
499 target_attempt,
500 1, // min value
501 50, // max value
502 kNumDefaultUmaBuckets);
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700503}
504
505void MetricsReporterOmaha::ReportTimeToReboot(int time_to_reboot_minutes) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700506 string metric = metrics::kMetricTimeToRebootMinutes;
507 metrics_lib_->SendToUMA(metric,
508 time_to_reboot_minutes,
509 0, // min: 0 minute
510 30 * 24 * 60, // max: 1 month (approx)
511 kNumDefaultUmaBuckets);
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700512}
513
514void MetricsReporterOmaha::ReportInstallDateProvisioningSource(int source,
515 int max) {
Tianjie Xu98333a82017-09-22 21:29:29 -0700516 metrics_lib_->SendEnumToUMA(metrics::kMetricInstallDateProvisioningSource,
517 source, // Sample.
518 max);
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700519}
David Zeuthen33bae492014-02-25 16:16:18 -0800520
Amin Hassani80f4d4c2018-05-16 13:34:00 -0700521void MetricsReporterOmaha::ReportInternalErrorCode(ErrorCode error_code) {
522 auto metric = metrics::kMetricAttemptInternalErrorCode;
Amin Hassani80f4d4c2018-05-16 13:34:00 -0700523 metrics_lib_->SendEnumToUMA(metric,
524 static_cast<int>(error_code),
525 static_cast<int>(ErrorCode::kUmaReportedMax));
526}
527
Marton Hunyadyffbfdfb2018-05-30 13:03:29 +0200528void MetricsReporterOmaha::ReportKeyVersionMetrics(
529 int kernel_min_version,
530 int kernel_max_rollforward_version,
531 bool kernel_max_rollforward_success) {
532 int value = kernel_min_version;
533 string metric = metrics::kMetricKernelMinVersion;
Marton Hunyadyffbfdfb2018-05-30 13:03:29 +0200534 metrics_lib_->SendSparseToUMA(metric, value);
535
536 value = kernel_max_rollforward_version;
537 metric = metrics::kMetricKernelMaxRollforwardVersion;
Marton Hunyadyffbfdfb2018-05-30 13:03:29 +0200538 metrics_lib_->SendSparseToUMA(metric, value);
539
540 bool bool_value = kernel_max_rollforward_success;
541 metric = metrics::kMetricKernelMaxRollforwardSetSuccess;
Marton Hunyadyffbfdfb2018-05-30 13:03:29 +0200542 metrics_lib_->SendBoolToUMA(metric, bool_value);
543}
544
May Lippert60aa3ca2018-08-15 16:55:29 -0700545void MetricsReporterOmaha::ReportEnterpriseUpdateSeenToDownloadDays(
546 bool has_time_restriction_policy, int time_to_update_days) {
547 string metric =
548 has_time_restriction_policy
549 ? metrics::kMetricSuccessfulUpdateDurationFromSeenTimeRestrictedDays
550 : metrics::kMetricSuccessfulUpdateDurationFromSeenDays;
May Lippert60aa3ca2018-08-15 16:55:29 -0700551
552 metrics_lib_->SendToUMA(metric,
553 time_to_update_days,
554 1, // min: 1 days
555 6 * 30, // max: 6 months (approx)
556 50); // num_buckets
557}
558
Amin Hassaniec7bc112020-10-29 16:47:58 -0700559bool MetricsReporterOmaha::WallclockDurationHelper(
560 SystemState* system_state,
561 const std::string& state_variable_key,
562 TimeDelta* out_duration) {
563 bool ret = false;
564 Time now = system_state->clock()->GetWallclockTime();
565 int64_t stored_value;
566 if (system_state->prefs()->GetInt64(state_variable_key, &stored_value)) {
567 Time stored_time = Time::FromInternalValue(stored_value);
568 if (stored_time > now) {
569 LOG(ERROR) << "Stored time-stamp used for " << state_variable_key
570 << " is in the future.";
571 } else {
572 *out_duration = now - stored_time;
573 ret = true;
574 }
575 }
576
577 if (!system_state->prefs()->SetInt64(state_variable_key,
578 now.ToInternalValue())) {
579 LOG(ERROR) << "Error storing time-stamp in " << state_variable_key;
580 }
581
582 return ret;
583}
584
585bool MetricsReporterOmaha::MonotonicDurationHelper(SystemState* system_state,
586 int64_t* storage,
587 TimeDelta* out_duration) {
588 bool ret = false;
589 Time now = system_state->clock()->GetMonotonicTime();
590 if (*storage != 0) {
591 Time stored_time = Time::FromInternalValue(*storage);
592 *out_duration = now - stored_time;
593 ret = true;
594 }
595 *storage = now.ToInternalValue();
596
597 return ret;
598}
599
David Zeuthen33bae492014-02-25 16:16:18 -0800600} // namespace chromeos_update_engine