metrics.h revision cf175a098081f3f0e9ca52d997a7ce1585c14c2d
133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Copyright 2014 The Chromium OS Authors. All rights reserved. 233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Use of this source code is governed by a BSD-style license that can be 333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// found in the LICENSE file. 433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 5cf175a098081f3f0e9ca52d997a7ce1585c14c2dGilad Arnold#ifndef UPDATE_ENGINE_METRICS_H_ 6cf175a098081f3f0e9ca52d997a7ce1585c14c2dGilad Arnold#define UPDATE_ENGINE_METRICS_H_ 733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen#include <base/time/time.h> 933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 1033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen#include "update_engine/constants.h" 1133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen#include "update_engine/error_code.h" 1233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 1333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthennamespace chromeos_update_engine { 1433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 1533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenclass SystemState; 1633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 1733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthennamespace metrics { 1833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 1933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// UpdateEngine.Daily.* metrics. 2033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricDailyOSAgeDays[]; 2133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 2233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// UpdateEngine.Check.* metrics. 2333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricCheckDownloadErrorCode[]; 2433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricCheckReaction[]; 2533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricCheckResult[]; 2633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricCheckTimeSinceLastCheckMinutes[]; 2733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricCheckTimeSinceLastCheckUptimeMinutes[]; 2833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 2933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// UpdateEngine.Attempt.* metrics. 3033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptNumber[]; 3133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptPayloadType[]; 3233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptPayloadSizeMiB[]; 33b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthenextern const char kMetricAttemptConnectionType[]; 3433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptDurationMinutes[]; 3533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptDurationUptimeMinutes[]; 3633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptTimeSinceLastAttemptSeconds[]; 3733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptTimeSinceLastAttemptUptimeSeconds[]; 3833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptPayloadBytesDownloaded[]; 3933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptPayloadDownloadSpeedKBps[]; 4033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptDownloadSource[]; 4133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptResult[]; 4233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptInternalErrorCode[]; 4333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptDownloadErrorCode[]; 4433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 4533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// UpdateEngine.SuccessfulUpdate.* metrics. 4633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateAttemptCount[]; 4733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateBytesDownloadedMiB[]; 4833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateDownloadOverheadPercentage[]; 4933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateDownloadSourcesUsed[]; 5033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdatePayloadType[]; 5133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdatePayloadSizeMiB[]; 5233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateTotalDurationMinutes[]; 5333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateRebootCount[]; 5433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateUpdatesAbandonedCount[]; 5533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateUrlSwitchCount[]; 5633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 5796197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// UpdateEngine.Rollback.* metric. 5896197df73f6c804d96eb3a1390eb817f354089d2David Zeuthenextern const char kMetricRollbackResult[]; 5996197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen 6033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// UpdateEngine.* metrics. 6133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricFailedUpdateCount[]; 6233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricInstallDateProvisioningSource[]; 6333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricTimeToRebootMinutes[]; 6433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 6533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The possible outcomes when checking for updates. 6633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 6733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// This is used in the UpdateEngine.Check.Result histogram. 6833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenenum class CheckResult { 6933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUpdateAvailable, // Response indicates an update is available. 7033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kNoUpdateAvailable, // Response indicates no updates are available. 7133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kDownloadError, // Error downloading response from Omaha. 7233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kParsingError, // Error parsing response. 7333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kRebootPending, // No update check was performed a reboot is pending. 7433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 7533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kNumConstants, 7633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUnset = -1 7733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen}; 7833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 7933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Possible ways a device can react to a new update being available. 8033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 8133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// This is used in the UpdateEngine.Check.Reaction histogram. 8233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenenum class CheckReaction { 8333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUpdating, // Device proceeds to download and apply update. 8433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kIgnored , // Device-policy dictates ignoring the update. 8533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kDeferring, // Device-policy dictates waiting. 8633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kBackingOff, // Previous errors dictates waiting. 8733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 8833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kNumConstants, 8933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUnset = -1 9033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen}; 9133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 9233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The possible ways that downloading from a HTTP or HTTPS server can fail. 9333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 9433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// This is used in the UpdateEngine.Check.DownloadErrorCode and 9533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// UpdateEngine.Attempt.DownloadErrorCode histograms. 9633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenenum class DownloadErrorCode { 9733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // Errors that can happen in the field. See http://crbug.com/355745 9833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // for how we plan to add more detail in the future. 9933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kDownloadError = 0, // Error downloading data from server. 10033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 10133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // IMPORTANT: When adding a new error code, add at the bottom of the 10233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // above block and before the kInputMalformed field. This 10333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // is to ensure that error codes are not reordered. 10433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 10533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // This error code is used to convey that malformed input was given 10633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // to the utils::GetDownloadErrorCode() function. This should never 10733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // happen but if it does it's because of an internal update_engine 10833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // error and we're interested in knowing this. 10933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kInputMalformed = 100, 11033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 11133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // Bucket for capturing HTTP status codes not in the 200-599 11233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // range. This should never happen in practice but if it does we 11333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // want to know. 11433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kHttpStatusOther = 101, 11533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 11633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // Above 200 and below 600, the value is the HTTP status code. 11733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kHttpStatus200 = 200, 11833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 11933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kNumConstants = 600, 12033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 12133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUnset = -1 12233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen}; 12333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 12433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Possible ways an update attempt can end. 12533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 12633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// This is used in the UpdateEngine.Attempt.Result histogram. 12733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenenum class AttemptResult { 12833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUpdateSucceeded, // The update succeeded. 12933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kInternalError, // An internal error occurred. 13033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kPayloadDownloadError, // Failure while downloading payload. 13133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kMetadataMalformed, // Metadata was malformed. 13233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kOperationMalformed, // An operation was malformed. 13333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kOperationExecutionError, // An operation failed to execute. 13433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kMetadataVerificationFailed, // Metadata verification failed. 13533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kPayloadVerificationFailed, // Payload verification failed. 13633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kVerificationFailed, // Root or Kernel partition verification failed. 13733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kPostInstallFailed, // The postinstall step failed. 13833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kAbnormalTermination, // The attempt ended abnormally. 13933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 14033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kNumConstants, 14133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 14233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUnset = -1 14333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen}; 14433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 145b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen// Possible ways the device is connected to the Internet. 146b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen// 147b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen// This is used in the UpdateEngine.Attempt.ConnectionType histogram. 148b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthenenum class ConnectionType { 149b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kUnknown, // Unknown. 150b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kEthernet, // Ethernet. 151b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kWifi, // Wireless. 152b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kWimax, // WiMax. 153b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kBluetooth, // Bluetooth. 154b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kCellular, // Cellular. 155b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kTetheredEthernet, // Tethered (Ethernet). 156b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kTetheredWifi, // Tethered (Wifi). 157b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen 158b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kNumConstants, 159b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kUnset = -1 160b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen}; 161b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen 16296197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// Possible ways a rollback can end. 16396197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// 16496197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// This is used in the UpdateEngine.Rollback histogram. 16596197df73f6c804d96eb3a1390eb817f354089d2David Zeuthenenum class RollbackResult { 16696197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen kFailed, 16796197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen kSuccess, 16896197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen 16996197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen kNumConstants 17096197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen}; 17196197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen 17296197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// Helper function to report metrics related to rollback. The 17396197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// following metrics are reported: 17496197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// 17596197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// |kMetricRollbackResult| 17696197df73f6c804d96eb3a1390eb817f354089d2David Zeuthenvoid ReportRollbackMetrics(SystemState *system_state, 17796197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen RollbackResult result); 17896197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen 17933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Helper function to report metrics reported once a day. The 18033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// following metrics are reported: 18133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 18233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricDailyOSAgeDays| 18333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenvoid ReportDailyMetrics(SystemState *system_state, 18433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen base::TimeDelta os_age); 18533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 18633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Helper function to report metrics after completing an update check 18733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// with the ChromeOS update server ("Omaha"). The following metrics 18833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// are reported: 18933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 19033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricCheckResult| 19133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricCheckReaction| 19233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricCheckDownloadErrorCode| 19333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricCheckTimeSinceLastCheckMinutes| 19433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricCheckTimeSinceLastCheckUptimeMinutes| 19533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 19633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The |kMetricCheckResult| metric will only be reported if |result| 19733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// is not |kUnset|. 19833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 19933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The |kMetricCheckReaction| metric will only be reported if 20033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |reaction| is not |kUnset|. 20133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 20233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The |kMetricCheckDownloadErrorCode| will only be reported if 20333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |download_error_code| is not |kUnset|. 20433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 20533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The values for the |kMetricCheckTimeSinceLastCheckMinutes| and 20633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricCheckTimeSinceLastCheckUptimeMinutes| metrics are 20733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// automatically reported and calculated by maintaining persistent 20833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// and process-local state variables. 20933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenvoid ReportUpdateCheckMetrics(SystemState *system_state, 21033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen CheckResult result, 21133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen CheckReaction reaction, 21233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen DownloadErrorCode download_error_code); 21333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 21433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 21533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Helper function to report metrics after the completion of each 21633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// update attempt. The following metrics are reported: 21733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 21833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptNumber| 21933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptPayloadType| 22033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptPayloadSizeMiB| 22133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptDurationSeconds| 22233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptDurationUptimeSeconds| 22333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptTimeSinceLastAttemptMinutes| 22433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptTimeSinceLastAttemptUptimeMinutes| 22533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptPayloadBytesDownloadedMiB| 22633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptPayloadDownloadSpeedKBps| 22733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptDownloadSource| 22833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptResult| 22933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptInternalErrorCode| 23033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptDownloadErrorCode| 23133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 23233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The |kMetricAttemptInternalErrorCode| metric will only be reported 23333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// if |internal_error_code| is not |kErrorSuccess|. 23433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 23533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The |kMetricAttemptDownloadErrorCode| metric will only be 23633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// reported if |payload_download_error_code| is not |kUnset|. 23733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 23833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The values for the |kMetricAttemptTimeSinceLastAttemptMinutes| and 23933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptTimeSinceLastAttemptUptimeMinutes| metrics are 24033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// automatically calculated and reported by maintaining persistent and 24133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// process-local state variables. 24233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenvoid ReportUpdateAttemptMetrics( 24333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen SystemState *system_state, 24433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int attempt_number, 24533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen PayloadType payload_type, 24633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen base::TimeDelta duration, 24733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen base::TimeDelta duration_uptime, 24833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int64_t payload_size, 24933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int64_t payload_bytes_downloaded, 25033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int64_t payload_download_speed_bps, 25133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen DownloadSource download_source, 25233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen AttemptResult attempt_result, 25333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen ErrorCode internal_error_code, 254b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen DownloadErrorCode payload_download_error_code, 255b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen ConnectionType connection_type); 25633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 2574e1d1495c034c8a81c989622481b6cdf94a50c3cDavid Zeuthen// Reports the |kAbnormalTermination| for the |kMetricAttemptResult| 2584e1d1495c034c8a81c989622481b6cdf94a50c3cDavid Zeuthen// metric. No other metrics in the UpdateEngine.Attempt.* namespace 2594e1d1495c034c8a81c989622481b6cdf94a50c3cDavid Zeuthen// will be reported. 2604e1d1495c034c8a81c989622481b6cdf94a50c3cDavid Zeuthenvoid ReportAbnormallyTerminatedUpdateAttemptMetrics(SystemState *system_state); 2614e1d1495c034c8a81c989622481b6cdf94a50c3cDavid Zeuthen 26233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Helper function to report the after the completion of a successful 26333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// update attempt. The following metrics are reported: 26433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 26533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateAttemptCount| 26633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateUpdatesAbandonedCount| 26733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdatePayloadType| 26833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdatePayloadSizeMiB| 26933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateBytesDownloadedMiBHttpsServer| 27033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateBytesDownloadedMiBHttpServer| 27133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateBytesDownloadedMiBHttpPeer| 27233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateBytesDownloadedMiB| 27333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateDownloadSourcesUsed| 27433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateDownloadOverheadPercentage| 27533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateTotalDurationMinutes| 27633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateRebootCount| 27733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateUrlSwitchCount| 27833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 27933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The values for the |kMetricSuccessfulUpdateDownloadSourcesUsed| are 28033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateBytesDownloadedMiB| metrics automatically 28133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// calculated from examining the |num_bytes_downloaded| array. 28233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenvoid ReportSuccessfulUpdateMetrics( 28333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen SystemState *system_state, 28433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int attempt_count, 28533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int updates_abandoned_count, 28633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen PayloadType payload_type, 28733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int64_t payload_size, 28833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int64_t num_bytes_downloaded[kNumDownloadSources], 28933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int download_overhead_percentage, 29033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen base::TimeDelta total_duration, 29133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int reboot_count, 29233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int url_switch_count); 29333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 29433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen} // namespace metrics 29533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 29633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen} // namespace chromeos_update_engine 29733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 298cf175a098081f3f0e9ca52d997a7ce1585c14c2dGilad Arnold#endif // UPDATE_ENGINE_METRICS_H_ 299