blob: 5e88923c32070068dd394e4f04599c04e3c3c39c [file] [log] [blame]
Tianjie Xu282aa1f2017-09-05 13:42:45 -07001//
2// Copyright (C) 2017 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//
16
17#ifndef UPDATE_ENGINE_METRICS_REPORTER_OMAHA_H_
18#define UPDATE_ENGINE_METRICS_REPORTER_OMAHA_H_
19
Tianjie Xu98333a82017-09-22 21:29:29 -070020#include <memory>
21
Tianjie Xu282aa1f2017-09-05 13:42:45 -070022#include <base/time/time.h>
23#include <metrics/metrics_library.h>
24
25#include "update_engine/certificate_checker.h"
26#include "update_engine/common/constants.h"
27#include "update_engine/common/error_code.h"
28#include "update_engine/metrics_constants.h"
29#include "update_engine/metrics_reporter_interface.h"
30#include "update_engine/system_state.h"
31
32namespace chromeos_update_engine {
33
34class SystemState;
35
Tianjie Xu98333a82017-09-22 21:29:29 -070036namespace metrics {
37
38// UpdateEngine.Daily.* metrics.
39extern const char kMetricDailyOSAgeDays[];
40
41// UpdateEngine.Check.* metrics.
42extern const char kMetricCheckDownloadErrorCode[];
43extern const char kMetricCheckReaction[];
44extern const char kMetricCheckResult[];
45extern const char kMetricCheckTimeSinceLastCheckMinutes[];
46extern const char kMetricCheckTimeSinceLastCheckUptimeMinutes[];
47
48// UpdateEngine.Attempt.* metrics.
49extern const char kMetricAttemptNumber[];
50extern const char kMetricAttemptPayloadType[];
51extern const char kMetricAttemptPayloadSizeMiB[];
52extern const char kMetricAttemptConnectionType[];
53extern const char kMetricAttemptDurationMinutes[];
54extern const char kMetricAttemptDurationUptimeMinutes[];
55extern const char kMetricAttemptTimeSinceLastAttemptMinutes[];
56extern const char kMetricAttemptTimeSinceLastAttemptUptimeMinutes[];
57extern const char kMetricAttemptPayloadBytesDownloadedMiB[];
58extern const char kMetricAttemptPayloadDownloadSpeedKBps[];
59extern const char kMetricAttemptDownloadSource[];
60extern const char kMetricAttemptResult[];
61extern const char kMetricAttemptInternalErrorCode[];
62extern const char kMetricAttemptDownloadErrorCode[];
63
64// UpdateEngine.SuccessfulUpdate.* metrics.
65extern const char kMetricSuccessfulUpdateAttemptCount[];
66extern const char kMetricSuccessfulUpdateBytesDownloadedMiB[];
67extern const char kMetricSuccessfulUpdateDownloadOverheadPercentage[];
68extern const char kMetricSuccessfulUpdateDownloadSourcesUsed[];
69extern const char kMetricSuccessfulUpdatePayloadType[];
70extern const char kMetricSuccessfulUpdatePayloadSizeMiB[];
71extern const char kMetricSuccessfulUpdateRebootCount[];
72extern const char kMetricSuccessfulUpdateTotalDurationMinutes[];
Sen Jiang8712e962018-05-08 12:12:28 -070073extern const char kMetricSuccessfulUpdateTotalDurationUptimeMinutes[];
Tianjie Xu98333a82017-09-22 21:29:29 -070074extern const char kMetricSuccessfulUpdateUpdatesAbandonedCount[];
75extern const char kMetricSuccessfulUpdateUrlSwitchCount[];
76
77// UpdateEngine.Rollback.* metric.
78extern const char kMetricRollbackResult[];
79
80// UpdateEngine.CertificateCheck.* metrics.
81extern const char kMetricCertificateCheckUpdateCheck[];
82extern const char kMetricCertificateCheckDownload[];
83
84// UpdateEngine.* metrics.
85extern const char kMetricFailedUpdateCount[];
86extern const char kMetricInstallDateProvisioningSource[];
87extern const char kMetricTimeToRebootMinutes[];
88
89} // namespace metrics
90
Tianjie Xu282aa1f2017-09-05 13:42:45 -070091class MetricsReporterOmaha : public MetricsReporterInterface {
92 public:
Tianjie Xu98333a82017-09-22 21:29:29 -070093 MetricsReporterOmaha();
Tianjie Xu282aa1f2017-09-05 13:42:45 -070094
95 ~MetricsReporterOmaha() override = default;
96
97 void Initialize() override;
98
99 void ReportRollbackMetrics(metrics::RollbackResult result) override;
100
101 void ReportDailyMetrics(base::TimeDelta os_age) override;
102
103 void ReportUpdateCheckMetrics(
104 SystemState* system_state,
105 metrics::CheckResult result,
106 metrics::CheckReaction reaction,
107 metrics::DownloadErrorCode download_error_code) override;
108
Tianjie Xu1f93d092017-10-09 12:13:29 -0700109 void ReportUpdateAttemptMetrics(SystemState* system_state,
110 int attempt_number,
111 PayloadType payload_type,
112 base::TimeDelta duration,
113 base::TimeDelta duration_uptime,
114 int64_t payload_size,
115 metrics::AttemptResult attempt_result,
116 ErrorCode internal_error_code) override;
117
118 void ReportUpdateAttemptDownloadMetrics(
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700119 int64_t payload_bytes_downloaded,
120 int64_t payload_download_speed_bps,
121 DownloadSource download_source,
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700122 metrics::DownloadErrorCode payload_download_error_code,
123 metrics::ConnectionType connection_type) override;
124
125 void ReportAbnormallyTerminatedUpdateAttemptMetrics() override;
126
127 void ReportSuccessfulUpdateMetrics(
128 int attempt_count,
129 int updates_abandoned_count,
130 PayloadType payload_type,
131 int64_t payload_size,
132 int64_t num_bytes_downloaded[kNumDownloadSources],
133 int download_overhead_percentage,
134 base::TimeDelta total_duration,
Sen Jiang8712e962018-05-08 12:12:28 -0700135 base::TimeDelta total_duration_uptime,
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700136 int reboot_count,
137 int url_switch_count) override;
138
139 void ReportCertificateCheckMetrics(ServerToCheck server_to_check,
140 CertificateCheckResult result) override;
141
142 void ReportFailedUpdateCount(int target_attempt) override;
143
144 void ReportTimeToReboot(int time_to_reboot_minutes) override;
145
146 void ReportInstallDateProvisioningSource(int source, int max) override;
147
148 private:
Tianjie Xu98333a82017-09-22 21:29:29 -0700149 friend class MetricsReporterOmahaTest;
150
151 std::unique_ptr<MetricsLibraryInterface> metrics_lib_;
Tianjie Xu282aa1f2017-09-05 13:42:45 -0700152
153 DISALLOW_COPY_AND_ASSIGN(MetricsReporterOmaha);
154}; // class metrics
155
156} // namespace chromeos_update_engine
157
158#endif // UPDATE_ENGINE_METRICS_REPORTER_OMAHA_H_