metrics.h revision aea4c1cea20dda7ae7e85fc8924a2d784f70d806
1aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// 2aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// Copyright (C) 2014 The Android Open Source Project 3aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// 4aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// Licensed under the Apache License, Version 2.0 (the "License"); 5aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// you may not use this file except in compliance with the License. 6aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// You may obtain a copy of the License at 7aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// 8aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// http://www.apache.org/licenses/LICENSE-2.0 9aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// 10aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// Unless required by applicable law or agreed to in writing, software 11aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// distributed under the License is distributed on an "AS IS" BASIS, 12aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// See the License for the specific language governing permissions and 14aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// limitations under the License. 15aea4c1cea20dda7ae7e85fc8924a2d784f70d806Alex Deymo// 1633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 17cf175a098081f3f0e9ca52d997a7ce1585c14c2dGilad Arnold#ifndef UPDATE_ENGINE_METRICS_H_ 18cf175a098081f3f0e9ca52d997a7ce1585c14c2dGilad Arnold#define UPDATE_ENGINE_METRICS_H_ 1933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 2033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen#include <base/time/time.h> 2133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 2233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen#include "update_engine/constants.h" 2333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen#include "update_engine/error_code.h" 2433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 2533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthennamespace chromeos_update_engine { 2633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 2733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenclass SystemState; 2833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 2933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthennamespace metrics { 3033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 3133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// UpdateEngine.Daily.* metrics. 3233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricDailyOSAgeDays[]; 3333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 3433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// UpdateEngine.Check.* metrics. 3533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricCheckDownloadErrorCode[]; 3633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricCheckReaction[]; 3733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricCheckResult[]; 3833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricCheckTimeSinceLastCheckMinutes[]; 3933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricCheckTimeSinceLastCheckUptimeMinutes[]; 4033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 4133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// UpdateEngine.Attempt.* metrics. 4233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptNumber[]; 4333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptPayloadType[]; 4433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptPayloadSizeMiB[]; 45b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthenextern const char kMetricAttemptConnectionType[]; 4633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptDurationMinutes[]; 4733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptDurationUptimeMinutes[]; 4833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptTimeSinceLastAttemptSeconds[]; 4933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptTimeSinceLastAttemptUptimeSeconds[]; 5033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptPayloadBytesDownloaded[]; 5133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptPayloadDownloadSpeedKBps[]; 5233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptDownloadSource[]; 5333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptResult[]; 5433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptInternalErrorCode[]; 5533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricAttemptDownloadErrorCode[]; 5633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 5733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// UpdateEngine.SuccessfulUpdate.* metrics. 5833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateAttemptCount[]; 5933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateBytesDownloadedMiB[]; 6033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateDownloadOverheadPercentage[]; 6133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateDownloadSourcesUsed[]; 6233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdatePayloadType[]; 6333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdatePayloadSizeMiB[]; 6433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateTotalDurationMinutes[]; 6533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateRebootCount[]; 6633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateUpdatesAbandonedCount[]; 6733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricSuccessfulUpdateUrlSwitchCount[]; 6833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 6996197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// UpdateEngine.Rollback.* metric. 7096197df73f6c804d96eb3a1390eb817f354089d2David Zeuthenextern const char kMetricRollbackResult[]; 7196197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen 7233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// UpdateEngine.* metrics. 7333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricFailedUpdateCount[]; 7433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricInstallDateProvisioningSource[]; 7533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenextern const char kMetricTimeToRebootMinutes[]; 7633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 7733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The possible outcomes when checking for updates. 7833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 7933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// This is used in the UpdateEngine.Check.Result histogram. 8033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenenum class CheckResult { 8133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUpdateAvailable, // Response indicates an update is available. 8233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kNoUpdateAvailable, // Response indicates no updates are available. 8333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kDownloadError, // Error downloading response from Omaha. 8433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kParsingError, // Error parsing response. 8533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kRebootPending, // No update check was performed a reboot is pending. 8633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 8733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kNumConstants, 8833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUnset = -1 8933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen}; 9033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 9133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Possible ways a device can react to a new update being available. 9233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 9333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// This is used in the UpdateEngine.Check.Reaction histogram. 9433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenenum class CheckReaction { 9533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUpdating, // Device proceeds to download and apply update. 9633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kIgnored , // Device-policy dictates ignoring the update. 9733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kDeferring, // Device-policy dictates waiting. 9833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kBackingOff, // Previous errors dictates waiting. 9933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 10033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kNumConstants, 10133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUnset = -1 10233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen}; 10333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 10433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The possible ways that downloading from a HTTP or HTTPS server can fail. 10533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 10633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// This is used in the UpdateEngine.Check.DownloadErrorCode and 10733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// UpdateEngine.Attempt.DownloadErrorCode histograms. 10833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenenum class DownloadErrorCode { 10933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // Errors that can happen in the field. See http://crbug.com/355745 11033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // for how we plan to add more detail in the future. 11133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kDownloadError = 0, // Error downloading data from server. 11233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 11333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // IMPORTANT: When adding a new error code, add at the bottom of the 11433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // above block and before the kInputMalformed field. This 11533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // is to ensure that error codes are not reordered. 11633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 11733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // This error code is used to convey that malformed input was given 11833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // to the utils::GetDownloadErrorCode() function. This should never 11933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // happen but if it does it's because of an internal update_engine 12033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // error and we're interested in knowing this. 12133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kInputMalformed = 100, 12233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 12333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // Bucket for capturing HTTP status codes not in the 200-599 12433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // range. This should never happen in practice but if it does we 12533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // want to know. 12633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kHttpStatusOther = 101, 12733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 12833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen // Above 200 and below 600, the value is the HTTP status code. 12933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kHttpStatus200 = 200, 13033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 13133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kNumConstants = 600, 13233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 13333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUnset = -1 13433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen}; 13533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 13633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Possible ways an update attempt can end. 13733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 13833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// This is used in the UpdateEngine.Attempt.Result histogram. 13933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenenum class AttemptResult { 14033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUpdateSucceeded, // The update succeeded. 14133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kInternalError, // An internal error occurred. 14233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kPayloadDownloadError, // Failure while downloading payload. 14333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kMetadataMalformed, // Metadata was malformed. 14433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kOperationMalformed, // An operation was malformed. 14533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kOperationExecutionError, // An operation failed to execute. 14633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kMetadataVerificationFailed, // Metadata verification failed. 14733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kPayloadVerificationFailed, // Payload verification failed. 14833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kVerificationFailed, // Root or Kernel partition verification failed. 14933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kPostInstallFailed, // The postinstall step failed. 15033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kAbnormalTermination, // The attempt ended abnormally. 15133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 15233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kNumConstants, 15333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 15433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen kUnset = -1 15533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen}; 15633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 157b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen// Possible ways the device is connected to the Internet. 158b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen// 159b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen// This is used in the UpdateEngine.Attempt.ConnectionType histogram. 160b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthenenum class ConnectionType { 161b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kUnknown, // Unknown. 162b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kEthernet, // Ethernet. 163b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kWifi, // Wireless. 164b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kWimax, // WiMax. 165b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kBluetooth, // Bluetooth. 166b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kCellular, // Cellular. 167b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kTetheredEthernet, // Tethered (Ethernet). 168b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kTetheredWifi, // Tethered (Wifi). 169b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen 170b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kNumConstants, 171b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen kUnset = -1 172b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen}; 173b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen 17496197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// Possible ways a rollback can end. 17596197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// 17696197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// This is used in the UpdateEngine.Rollback histogram. 17796197df73f6c804d96eb3a1390eb817f354089d2David Zeuthenenum class RollbackResult { 17896197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen kFailed, 17996197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen kSuccess, 18096197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen 18196197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen kNumConstants 18296197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen}; 18396197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen 18496197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// Helper function to report metrics related to rollback. The 18596197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// following metrics are reported: 18696197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// 18796197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen// |kMetricRollbackResult| 18896197df73f6c804d96eb3a1390eb817f354089d2David Zeuthenvoid ReportRollbackMetrics(SystemState *system_state, 18996197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen RollbackResult result); 19096197df73f6c804d96eb3a1390eb817f354089d2David Zeuthen 19133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Helper function to report metrics reported once a day. The 19233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// following metrics are reported: 19333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 19433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricDailyOSAgeDays| 19533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenvoid ReportDailyMetrics(SystemState *system_state, 19633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen base::TimeDelta os_age); 19733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 19833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Helper function to report metrics after completing an update check 19933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// with the ChromeOS update server ("Omaha"). The following metrics 20033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// are reported: 20133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 20233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricCheckResult| 20333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricCheckReaction| 20433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricCheckDownloadErrorCode| 20533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricCheckTimeSinceLastCheckMinutes| 20633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricCheckTimeSinceLastCheckUptimeMinutes| 20733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 20833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The |kMetricCheckResult| metric will only be reported if |result| 20933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// is not |kUnset|. 21033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 21133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The |kMetricCheckReaction| metric will only be reported if 21233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |reaction| is not |kUnset|. 21333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 21433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The |kMetricCheckDownloadErrorCode| will only be reported if 21533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |download_error_code| is not |kUnset|. 21633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 21733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The values for the |kMetricCheckTimeSinceLastCheckMinutes| and 21833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricCheckTimeSinceLastCheckUptimeMinutes| metrics are 21933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// automatically reported and calculated by maintaining persistent 22033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// and process-local state variables. 22133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenvoid ReportUpdateCheckMetrics(SystemState *system_state, 22233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen CheckResult result, 22333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen CheckReaction reaction, 22433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen DownloadErrorCode download_error_code); 22533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 22633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 22733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Helper function to report metrics after the completion of each 22833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// update attempt. The following metrics are reported: 22933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 23033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptNumber| 23133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptPayloadType| 23233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptPayloadSizeMiB| 23333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptDurationSeconds| 23433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptDurationUptimeSeconds| 23533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptTimeSinceLastAttemptMinutes| 23633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptTimeSinceLastAttemptUptimeMinutes| 23733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptPayloadBytesDownloadedMiB| 23833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptPayloadDownloadSpeedKBps| 23933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptDownloadSource| 24033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptResult| 24133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptInternalErrorCode| 24233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptDownloadErrorCode| 24333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 24433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The |kMetricAttemptInternalErrorCode| metric will only be reported 24533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// if |internal_error_code| is not |kErrorSuccess|. 24633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 24733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The |kMetricAttemptDownloadErrorCode| metric will only be 24833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// reported if |payload_download_error_code| is not |kUnset|. 24933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 25033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The values for the |kMetricAttemptTimeSinceLastAttemptMinutes| and 25133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricAttemptTimeSinceLastAttemptUptimeMinutes| metrics are 25233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// automatically calculated and reported by maintaining persistent and 25333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// process-local state variables. 25433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenvoid ReportUpdateAttemptMetrics( 25533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen SystemState *system_state, 25633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int attempt_number, 25733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen PayloadType payload_type, 25833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen base::TimeDelta duration, 25933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen base::TimeDelta duration_uptime, 26033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int64_t payload_size, 26133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int64_t payload_bytes_downloaded, 26233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int64_t payload_download_speed_bps, 26333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen DownloadSource download_source, 26433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen AttemptResult attempt_result, 26533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen ErrorCode internal_error_code, 266b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen DownloadErrorCode payload_download_error_code, 267b281f0768f4d95afcf7378229a1a9f9ec9bd69abDavid Zeuthen ConnectionType connection_type); 26833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 2694e1d1495c034c8a81c989622481b6cdf94a50c3cDavid Zeuthen// Reports the |kAbnormalTermination| for the |kMetricAttemptResult| 2704e1d1495c034c8a81c989622481b6cdf94a50c3cDavid Zeuthen// metric. No other metrics in the UpdateEngine.Attempt.* namespace 2714e1d1495c034c8a81c989622481b6cdf94a50c3cDavid Zeuthen// will be reported. 2724e1d1495c034c8a81c989622481b6cdf94a50c3cDavid Zeuthenvoid ReportAbnormallyTerminatedUpdateAttemptMetrics(SystemState *system_state); 2734e1d1495c034c8a81c989622481b6cdf94a50c3cDavid Zeuthen 27433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// Helper function to report the after the completion of a successful 27533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// update attempt. The following metrics are reported: 27633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 27733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateAttemptCount| 27833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateUpdatesAbandonedCount| 27933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdatePayloadType| 28033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdatePayloadSizeMiB| 28133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateBytesDownloadedMiBHttpsServer| 28233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateBytesDownloadedMiBHttpServer| 28333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateBytesDownloadedMiBHttpPeer| 28433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateBytesDownloadedMiB| 28533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateDownloadSourcesUsed| 28633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateDownloadOverheadPercentage| 28733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateTotalDurationMinutes| 28833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateRebootCount| 28933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateUrlSwitchCount| 29033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// 29133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// The values for the |kMetricSuccessfulUpdateDownloadSourcesUsed| are 29233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// |kMetricSuccessfulUpdateBytesDownloadedMiB| metrics automatically 29333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen// calculated from examining the |num_bytes_downloaded| array. 29433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthenvoid ReportSuccessfulUpdateMetrics( 29533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen SystemState *system_state, 29633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int attempt_count, 29733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int updates_abandoned_count, 29833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen PayloadType payload_type, 29933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int64_t payload_size, 30033bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int64_t num_bytes_downloaded[kNumDownloadSources], 30133bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int download_overhead_percentage, 30233bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen base::TimeDelta total_duration, 30333bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int reboot_count, 30433bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen int url_switch_count); 30533bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 30633bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen} // namespace metrics 30733bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 30833bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen} // namespace chromeos_update_engine 30933bae491eded4ef4f1eb4f4ef0f01ef0e5463f3aDavid Zeuthen 310cf175a098081f3f0e9ca52d997a7ce1585c14c2dGilad Arnold#endif // UPDATE_ENGINE_METRICS_H_ 311