1*6777b538SAndroid Build Coastguard Worker // Copyright 2014 The Chromium Authors
2*6777b538SAndroid Build Coastguard Worker // Use of this source code is governed by a BSD-style license that can be
3*6777b538SAndroid Build Coastguard Worker // found in the LICENSE file.
4*6777b538SAndroid Build Coastguard Worker
5*6777b538SAndroid Build Coastguard Worker #include "components/metrics/metrics_log.h"
6*6777b538SAndroid Build Coastguard Worker
7*6777b538SAndroid Build Coastguard Worker #include <stddef.h>
8*6777b538SAndroid Build Coastguard Worker
9*6777b538SAndroid Build Coastguard Worker #include <algorithm>
10*6777b538SAndroid Build Coastguard Worker #include <cstring>
11*6777b538SAndroid Build Coastguard Worker #include <string>
12*6777b538SAndroid Build Coastguard Worker #include <vector>
13*6777b538SAndroid Build Coastguard Worker
14*6777b538SAndroid Build Coastguard Worker #include "base/build_time.h"
15*6777b538SAndroid Build Coastguard Worker #include "base/command_line.h"
16*6777b538SAndroid Build Coastguard Worker #include "base/cpu.h"
17*6777b538SAndroid Build Coastguard Worker #include "base/logging.h"
18*6777b538SAndroid Build Coastguard Worker #include "base/memory/raw_ptr.h"
19*6777b538SAndroid Build Coastguard Worker #include "base/metrics/histogram_base.h"
20*6777b538SAndroid Build Coastguard Worker #include "base/metrics/histogram_macros.h"
21*6777b538SAndroid Build Coastguard Worker #include "base/metrics/histogram_samples.h"
22*6777b538SAndroid Build Coastguard Worker #include "base/metrics/histogram_snapshot_manager.h"
23*6777b538SAndroid Build Coastguard Worker #include "base/metrics/metrics_hashes.h"
24*6777b538SAndroid Build Coastguard Worker #include "base/strings/string_piece.h"
25*6777b538SAndroid Build Coastguard Worker #include "base/strings/string_util.h"
26*6777b538SAndroid Build Coastguard Worker #include "base/system/sys_info.h"
27*6777b538SAndroid Build Coastguard Worker #include "base/time/clock.h"
28*6777b538SAndroid Build Coastguard Worker #include "base/time/default_clock.h"
29*6777b538SAndroid Build Coastguard Worker #include "base/time/time.h"
30*6777b538SAndroid Build Coastguard Worker #include "build/build_config.h"
31*6777b538SAndroid Build Coastguard Worker #include "build/chromeos_buildflags.h"
32*6777b538SAndroid Build Coastguard Worker #include "components/flags_ui/flags_ui_switches.h"
33*6777b538SAndroid Build Coastguard Worker #include "components/metrics/delegating_provider.h"
34*6777b538SAndroid Build Coastguard Worker #include "components/metrics/environment_recorder.h"
35*6777b538SAndroid Build Coastguard Worker #include "components/metrics/histogram_encoder.h"
36*6777b538SAndroid Build Coastguard Worker #include "components/metrics/metrics_pref_names.h"
37*6777b538SAndroid Build Coastguard Worker #include "components/metrics/metrics_provider.h"
38*6777b538SAndroid Build Coastguard Worker #include "components/metrics/metrics_service_client.h"
39*6777b538SAndroid Build Coastguard Worker #include "components/network_time/network_time_tracker.h"
40*6777b538SAndroid Build Coastguard Worker #include "components/prefs/pref_registry_simple.h"
41*6777b538SAndroid Build Coastguard Worker #include "components/prefs/pref_service.h"
42*6777b538SAndroid Build Coastguard Worker #include "components/variations/hashing.h"
43*6777b538SAndroid Build Coastguard Worker #include "crypto/random.h"
44*6777b538SAndroid Build Coastguard Worker #include "third_party/icu/source/i18n/unicode/timezone.h"
45*6777b538SAndroid Build Coastguard Worker #include "third_party/metrics_proto/histogram_event.pb.h"
46*6777b538SAndroid Build Coastguard Worker #include "third_party/metrics_proto/system_profile.pb.h"
47*6777b538SAndroid Build Coastguard Worker #include "third_party/metrics_proto/user_action_event.pb.h"
48*6777b538SAndroid Build Coastguard Worker
49*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_ANDROID)
50*6777b538SAndroid Build Coastguard Worker #include "base/android/build_info.h"
51*6777b538SAndroid Build Coastguard Worker #endif
52*6777b538SAndroid Build Coastguard Worker
53*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
54*6777b538SAndroid Build Coastguard Worker #include <windows.h>
55*6777b538SAndroid Build Coastguard Worker
56*6777b538SAndroid Build Coastguard Worker #include "base/win/current_module.h"
57*6777b538SAndroid Build Coastguard Worker #endif
58*6777b538SAndroid Build Coastguard Worker
59*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_LINUX)
60*6777b538SAndroid Build Coastguard Worker #include "base/environment.h"
61*6777b538SAndroid Build Coastguard Worker #include "base/nix/xdg_util.h"
62*6777b538SAndroid Build Coastguard Worker #endif
63*6777b538SAndroid Build Coastguard Worker
64*6777b538SAndroid Build Coastguard Worker using base::SampleCountIterator;
65*6777b538SAndroid Build Coastguard Worker
66*6777b538SAndroid Build Coastguard Worker namespace metrics {
67*6777b538SAndroid Build Coastguard Worker
LogMetadata()68*6777b538SAndroid Build Coastguard Worker LogMetadata::LogMetadata()
69*6777b538SAndroid Build Coastguard Worker : samples_count(std::nullopt), user_id(std::nullopt) {}
LogMetadata(const std::optional<base::HistogramBase::Count> samples_count,const std::optional<uint64_t> user_id,const std::optional<metrics::UkmLogSourceType> log_source_type)70*6777b538SAndroid Build Coastguard Worker LogMetadata::LogMetadata(
71*6777b538SAndroid Build Coastguard Worker const std::optional<base::HistogramBase::Count> samples_count,
72*6777b538SAndroid Build Coastguard Worker const std::optional<uint64_t> user_id,
73*6777b538SAndroid Build Coastguard Worker const std::optional<metrics::UkmLogSourceType> log_source_type)
74*6777b538SAndroid Build Coastguard Worker : samples_count(samples_count),
75*6777b538SAndroid Build Coastguard Worker user_id(user_id),
76*6777b538SAndroid Build Coastguard Worker log_source_type(log_source_type) {}
77*6777b538SAndroid Build Coastguard Worker LogMetadata::LogMetadata(const LogMetadata& other) = default;
78*6777b538SAndroid Build Coastguard Worker LogMetadata::~LogMetadata() = default;
79*6777b538SAndroid Build Coastguard Worker
AddSampleCount(base::HistogramBase::Count sample_count)80*6777b538SAndroid Build Coastguard Worker void LogMetadata::AddSampleCount(base::HistogramBase::Count sample_count) {
81*6777b538SAndroid Build Coastguard Worker if (samples_count.has_value()) {
82*6777b538SAndroid Build Coastguard Worker samples_count = samples_count.value() + sample_count;
83*6777b538SAndroid Build Coastguard Worker } else {
84*6777b538SAndroid Build Coastguard Worker samples_count = sample_count;
85*6777b538SAndroid Build Coastguard Worker }
86*6777b538SAndroid Build Coastguard Worker }
87*6777b538SAndroid Build Coastguard Worker
88*6777b538SAndroid Build Coastguard Worker namespace {
89*6777b538SAndroid Build Coastguard Worker
90*6777b538SAndroid Build Coastguard Worker // Convenience function to return the given time at a resolution in seconds.
ToMonotonicSeconds(base::TimeTicks time_ticks)91*6777b538SAndroid Build Coastguard Worker static int64_t ToMonotonicSeconds(base::TimeTicks time_ticks) {
92*6777b538SAndroid Build Coastguard Worker return (time_ticks - base::TimeTicks()).InSeconds();
93*6777b538SAndroid Build Coastguard Worker }
94*6777b538SAndroid Build Coastguard Worker
95*6777b538SAndroid Build Coastguard Worker // Helper function to get, increment, update and return an integer value stored
96*6777b538SAndroid Build Coastguard Worker // in |local_state| using |key|. This helper is used to manage the log record id
97*6777b538SAndroid Build Coastguard Worker // and the finalized log record id.
IncrementAndUpdate(PrefService * local_state,const std::string & key)98*6777b538SAndroid Build Coastguard Worker int IncrementAndUpdate(PrefService* local_state, const std::string& key) {
99*6777b538SAndroid Build Coastguard Worker const int value = local_state->GetInteger(key) + 1;
100*6777b538SAndroid Build Coastguard Worker local_state->SetInteger(key, value);
101*6777b538SAndroid Build Coastguard Worker return value;
102*6777b538SAndroid Build Coastguard Worker }
103*6777b538SAndroid Build Coastguard Worker
104*6777b538SAndroid Build Coastguard Worker // Populates |time| with information about the current time and, if
105*6777b538SAndroid Build Coastguard Worker // |record_time_zone| is true, the time zone.
RecordCurrentTime(const base::Clock * clock,const network_time::NetworkTimeTracker * network_time_tracker,bool record_time_zone,metrics::ChromeUserMetricsExtension::RealLocalTime * time)106*6777b538SAndroid Build Coastguard Worker void RecordCurrentTime(
107*6777b538SAndroid Build Coastguard Worker const base::Clock* clock,
108*6777b538SAndroid Build Coastguard Worker const network_time::NetworkTimeTracker* network_time_tracker,
109*6777b538SAndroid Build Coastguard Worker bool record_time_zone,
110*6777b538SAndroid Build Coastguard Worker metrics::ChromeUserMetricsExtension::RealLocalTime* time) {
111*6777b538SAndroid Build Coastguard Worker // Record the current time and the clock used to determine the time.
112*6777b538SAndroid Build Coastguard Worker base::Time now;
113*6777b538SAndroid Build Coastguard Worker if (network_time_tracker != nullptr &&
114*6777b538SAndroid Build Coastguard Worker network_time_tracker->GetNetworkTime(&now, nullptr) ==
115*6777b538SAndroid Build Coastguard Worker network_time::NetworkTimeTracker::NETWORK_TIME_AVAILABLE) {
116*6777b538SAndroid Build Coastguard Worker // |network_time_tracker| can be null in certain settings such as WebView
117*6777b538SAndroid Build Coastguard Worker // (which doesn't run a NetworkTimeTracker) and tests.
118*6777b538SAndroid Build Coastguard Worker time->set_time_source(
119*6777b538SAndroid Build Coastguard Worker metrics::ChromeUserMetricsExtension::RealLocalTime::NETWORK_TIME_CLOCK);
120*6777b538SAndroid Build Coastguard Worker } else {
121*6777b538SAndroid Build Coastguard Worker now = clock->Now();
122*6777b538SAndroid Build Coastguard Worker time->set_time_source(
123*6777b538SAndroid Build Coastguard Worker metrics::ChromeUserMetricsExtension::RealLocalTime::CLIENT_CLOCK);
124*6777b538SAndroid Build Coastguard Worker }
125*6777b538SAndroid Build Coastguard Worker time->set_time_sec(now.ToTimeT());
126*6777b538SAndroid Build Coastguard Worker
127*6777b538SAndroid Build Coastguard Worker if (record_time_zone) {
128*6777b538SAndroid Build Coastguard Worker // Determine time zone offset from GMT and store it.
129*6777b538SAndroid Build Coastguard Worker int32_t raw_offset, dst_offset;
130*6777b538SAndroid Build Coastguard Worker UErrorCode status = U_ZERO_ERROR;
131*6777b538SAndroid Build Coastguard Worker // Ask for a new time zone object each time; don't cache it, as time zones
132*6777b538SAndroid Build Coastguard Worker // may change while Chrome is running.
133*6777b538SAndroid Build Coastguard Worker std::unique_ptr<icu::TimeZone> time_zone(icu::TimeZone::createDefault());
134*6777b538SAndroid Build Coastguard Worker time_zone->getOffset(now.InMillisecondsFSinceUnixEpoch(),
135*6777b538SAndroid Build Coastguard Worker false, // interpret |now| as from UTC/GMT
136*6777b538SAndroid Build Coastguard Worker raw_offset, dst_offset, status);
137*6777b538SAndroid Build Coastguard Worker base::TimeDelta time_zone_offset =
138*6777b538SAndroid Build Coastguard Worker base::Milliseconds(raw_offset + dst_offset);
139*6777b538SAndroid Build Coastguard Worker if (U_FAILURE(status)) {
140*6777b538SAndroid Build Coastguard Worker DVLOG(1) << "Failed to get time zone offset, error code: " << status;
141*6777b538SAndroid Build Coastguard Worker // The fallback case is to get the raw timezone offset ignoring the
142*6777b538SAndroid Build Coastguard Worker // daylight saving time.
143*6777b538SAndroid Build Coastguard Worker time_zone_offset = base::Milliseconds(time_zone->getRawOffset());
144*6777b538SAndroid Build Coastguard Worker }
145*6777b538SAndroid Build Coastguard Worker time->set_time_zone_offset_from_gmt_sec(time_zone_offset.InSeconds());
146*6777b538SAndroid Build Coastguard Worker }
147*6777b538SAndroid Build Coastguard Worker }
148*6777b538SAndroid Build Coastguard Worker
149*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_LINUX)
ToProtoSessionType(base::nix::SessionType session_type)150*6777b538SAndroid Build Coastguard Worker metrics::SystemProfileProto::OS::XdgSessionType ToProtoSessionType(
151*6777b538SAndroid Build Coastguard Worker base::nix::SessionType session_type) {
152*6777b538SAndroid Build Coastguard Worker switch (session_type) {
153*6777b538SAndroid Build Coastguard Worker case base::nix::SessionType::kUnset:
154*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::UNSET;
155*6777b538SAndroid Build Coastguard Worker case base::nix::SessionType::kOther:
156*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::OTHER_SESSION_TYPE;
157*6777b538SAndroid Build Coastguard Worker case base::nix::SessionType::kUnspecified:
158*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::UNSPECIFIED;
159*6777b538SAndroid Build Coastguard Worker case base::nix::SessionType::kTty:
160*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::TTY;
161*6777b538SAndroid Build Coastguard Worker case base::nix::SessionType::kX11:
162*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::X11;
163*6777b538SAndroid Build Coastguard Worker case base::nix::SessionType::kWayland:
164*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::WAYLAND;
165*6777b538SAndroid Build Coastguard Worker case base::nix::SessionType::kMir:
166*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::MIR;
167*6777b538SAndroid Build Coastguard Worker }
168*6777b538SAndroid Build Coastguard Worker
169*6777b538SAndroid Build Coastguard Worker NOTREACHED();
170*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::UNSET;
171*6777b538SAndroid Build Coastguard Worker }
172*6777b538SAndroid Build Coastguard Worker
ToProtoCurrentDesktop(base::nix::DesktopEnvironment desktop_environment)173*6777b538SAndroid Build Coastguard Worker metrics::SystemProfileProto::OS::XdgCurrentDesktop ToProtoCurrentDesktop(
174*6777b538SAndroid Build Coastguard Worker base::nix::DesktopEnvironment desktop_environment) {
175*6777b538SAndroid Build Coastguard Worker switch (desktop_environment) {
176*6777b538SAndroid Build Coastguard Worker case base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_OTHER:
177*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::OTHER;
178*6777b538SAndroid Build Coastguard Worker case base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_CINNAMON:
179*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::CINNAMON;
180*6777b538SAndroid Build Coastguard Worker case base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_DEEPIN:
181*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::DEEPIN;
182*6777b538SAndroid Build Coastguard Worker case base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_GNOME:
183*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::GNOME;
184*6777b538SAndroid Build Coastguard Worker case base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_KDE3:
185*6777b538SAndroid Build Coastguard Worker case base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_KDE4:
186*6777b538SAndroid Build Coastguard Worker case base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_KDE5:
187*6777b538SAndroid Build Coastguard Worker case base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_KDE6:
188*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::KDE;
189*6777b538SAndroid Build Coastguard Worker case base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_PANTHEON:
190*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::PANTHEON;
191*6777b538SAndroid Build Coastguard Worker case base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_UKUI:
192*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::UKUI;
193*6777b538SAndroid Build Coastguard Worker case base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_UNITY:
194*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::UNITY;
195*6777b538SAndroid Build Coastguard Worker case base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_XFCE:
196*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::XFCE;
197*6777b538SAndroid Build Coastguard Worker case base::nix::DesktopEnvironment::DESKTOP_ENVIRONMENT_LXQT:
198*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::LXQT;
199*6777b538SAndroid Build Coastguard Worker }
200*6777b538SAndroid Build Coastguard Worker
201*6777b538SAndroid Build Coastguard Worker NOTREACHED();
202*6777b538SAndroid Build Coastguard Worker return metrics::SystemProfileProto::OS::OTHER;
203*6777b538SAndroid Build Coastguard Worker }
204*6777b538SAndroid Build Coastguard Worker #endif // BUILDFLAG(IS_LINUX)
205*6777b538SAndroid Build Coastguard Worker
206*6777b538SAndroid Build Coastguard Worker // Gets the hash of this session. A random hash is generated the first time this
207*6777b538SAndroid Build Coastguard Worker // is called (which is cached and returned for the remainder of the session).
GetSessionHash()208*6777b538SAndroid Build Coastguard Worker uint64_t GetSessionHash() {
209*6777b538SAndroid Build Coastguard Worker static const std::vector<uint8_t> session_hash =
210*6777b538SAndroid Build Coastguard Worker crypto::RandBytesAsVector(/*length=*/8);
211*6777b538SAndroid Build Coastguard Worker return *reinterpret_cast<const uint64_t*>(session_hash.data());
212*6777b538SAndroid Build Coastguard Worker }
213*6777b538SAndroid Build Coastguard Worker
214*6777b538SAndroid Build Coastguard Worker } // namespace
215*6777b538SAndroid Build Coastguard Worker
216*6777b538SAndroid Build Coastguard Worker namespace internal {
217*6777b538SAndroid Build Coastguard Worker
ToInstallerPackage(base::StringPiece installer_package_name)218*6777b538SAndroid Build Coastguard Worker SystemProfileProto::InstallerPackage ToInstallerPackage(
219*6777b538SAndroid Build Coastguard Worker base::StringPiece installer_package_name) {
220*6777b538SAndroid Build Coastguard Worker if (installer_package_name.empty())
221*6777b538SAndroid Build Coastguard Worker return SystemProfileProto::INSTALLER_PACKAGE_NONE;
222*6777b538SAndroid Build Coastguard Worker if (installer_package_name == "com.android.vending")
223*6777b538SAndroid Build Coastguard Worker return SystemProfileProto::INSTALLER_PACKAGE_GOOGLE_PLAY_STORE;
224*6777b538SAndroid Build Coastguard Worker return SystemProfileProto::INSTALLER_PACKAGE_OTHER;
225*6777b538SAndroid Build Coastguard Worker }
226*6777b538SAndroid Build Coastguard Worker
227*6777b538SAndroid Build Coastguard Worker } // namespace internal
228*6777b538SAndroid Build Coastguard Worker
MetricsLog(const std::string & client_id,int session_id,LogType log_type,MetricsServiceClient * client)229*6777b538SAndroid Build Coastguard Worker MetricsLog::MetricsLog(const std::string& client_id,
230*6777b538SAndroid Build Coastguard Worker int session_id,
231*6777b538SAndroid Build Coastguard Worker LogType log_type,
232*6777b538SAndroid Build Coastguard Worker MetricsServiceClient* client)
233*6777b538SAndroid Build Coastguard Worker : MetricsLog(client_id,
234*6777b538SAndroid Build Coastguard Worker session_id,
235*6777b538SAndroid Build Coastguard Worker log_type,
236*6777b538SAndroid Build Coastguard Worker base::DefaultClock::GetInstance(),
237*6777b538SAndroid Build Coastguard Worker client->GetNetworkTimeTracker(),
238*6777b538SAndroid Build Coastguard Worker client) {}
239*6777b538SAndroid Build Coastguard Worker
MetricsLog(const std::string & client_id,int session_id,LogType log_type,base::Clock * clock,const network_time::NetworkTimeTracker * network_clock,MetricsServiceClient * client)240*6777b538SAndroid Build Coastguard Worker MetricsLog::MetricsLog(const std::string& client_id,
241*6777b538SAndroid Build Coastguard Worker int session_id,
242*6777b538SAndroid Build Coastguard Worker LogType log_type,
243*6777b538SAndroid Build Coastguard Worker base::Clock* clock,
244*6777b538SAndroid Build Coastguard Worker const network_time::NetworkTimeTracker* network_clock,
245*6777b538SAndroid Build Coastguard Worker MetricsServiceClient* client)
246*6777b538SAndroid Build Coastguard Worker : closed_(false),
247*6777b538SAndroid Build Coastguard Worker log_type_(log_type),
248*6777b538SAndroid Build Coastguard Worker client_(client),
249*6777b538SAndroid Build Coastguard Worker creation_time_(base::TimeTicks::Now()),
250*6777b538SAndroid Build Coastguard Worker has_environment_(false),
251*6777b538SAndroid Build Coastguard Worker clock_(clock),
252*6777b538SAndroid Build Coastguard Worker network_clock_(network_clock) {
253*6777b538SAndroid Build Coastguard Worker uma_proto_.set_client_id(Hash(client_id));
254*6777b538SAndroid Build Coastguard Worker uma_proto_.set_session_id(session_id);
255*6777b538SAndroid Build Coastguard Worker
256*6777b538SAndroid Build Coastguard Worker if (log_type == MetricsLog::ONGOING_LOG) {
257*6777b538SAndroid Build Coastguard Worker // Don't record the time when creating a log because creating a log happens
258*6777b538SAndroid Build Coastguard Worker // on startups and setting the timezone requires ICU initialization that is
259*6777b538SAndroid Build Coastguard Worker // too expensive to run during this critical time.
260*6777b538SAndroid Build Coastguard Worker RecordCurrentTime(clock_, network_clock_,
261*6777b538SAndroid Build Coastguard Worker /*record_time_zone=*/false,
262*6777b538SAndroid Build Coastguard Worker uma_proto_.mutable_time_log_created());
263*6777b538SAndroid Build Coastguard Worker }
264*6777b538SAndroid Build Coastguard Worker
265*6777b538SAndroid Build Coastguard Worker const int32_t product = client_->GetProduct();
266*6777b538SAndroid Build Coastguard Worker // Only set the product if it differs from the default value.
267*6777b538SAndroid Build Coastguard Worker if (product != uma_proto_.product())
268*6777b538SAndroid Build Coastguard Worker uma_proto_.set_product(product);
269*6777b538SAndroid Build Coastguard Worker
270*6777b538SAndroid Build Coastguard Worker SystemProfileProto* system_profile = uma_proto()->mutable_system_profile();
271*6777b538SAndroid Build Coastguard Worker // Record the unhashed the client_id to system profile. This is used to
272*6777b538SAndroid Build Coastguard Worker // simulate field trial assignments for the client.
273*6777b538SAndroid Build Coastguard Worker DCHECK_EQ(client_id.size(), 36ull);
274*6777b538SAndroid Build Coastguard Worker system_profile->set_client_uuid(client_id);
275*6777b538SAndroid Build Coastguard Worker RecordCoreSystemProfile(client_, system_profile);
276*6777b538SAndroid Build Coastguard Worker }
277*6777b538SAndroid Build Coastguard Worker
278*6777b538SAndroid Build Coastguard Worker MetricsLog::~MetricsLog() = default;
279*6777b538SAndroid Build Coastguard Worker
280*6777b538SAndroid Build Coastguard Worker // static
RegisterPrefs(PrefRegistrySimple * registry)281*6777b538SAndroid Build Coastguard Worker void MetricsLog::RegisterPrefs(PrefRegistrySimple* registry) {
282*6777b538SAndroid Build Coastguard Worker EnvironmentRecorder::RegisterPrefs(registry);
283*6777b538SAndroid Build Coastguard Worker registry->RegisterIntegerPref(prefs::kMetricsLogFinalizedRecordId, 0);
284*6777b538SAndroid Build Coastguard Worker registry->RegisterIntegerPref(prefs::kMetricsLogRecordId, 0);
285*6777b538SAndroid Build Coastguard Worker }
286*6777b538SAndroid Build Coastguard Worker
287*6777b538SAndroid Build Coastguard Worker // static
Hash(const std::string & value)288*6777b538SAndroid Build Coastguard Worker uint64_t MetricsLog::Hash(const std::string& value) {
289*6777b538SAndroid Build Coastguard Worker uint64_t hash = base::HashMetricName(value);
290*6777b538SAndroid Build Coastguard Worker
291*6777b538SAndroid Build Coastguard Worker // The following log is VERY helpful when folks add some named histogram into
292*6777b538SAndroid Build Coastguard Worker // the code, but forgot to update the descriptive list of histograms. When
293*6777b538SAndroid Build Coastguard Worker // that happens, all we get to see (server side) is a hash of the histogram
294*6777b538SAndroid Build Coastguard Worker // name. We can then use this logging to find out what histogram name was
295*6777b538SAndroid Build Coastguard Worker // being hashed to a given MD5 value by just running the version of Chromium
296*6777b538SAndroid Build Coastguard Worker // in question with --enable-logging.
297*6777b538SAndroid Build Coastguard Worker DVLOG(1) << "Metrics: Hash numeric [" << value << "]=[" << hash << "]";
298*6777b538SAndroid Build Coastguard Worker
299*6777b538SAndroid Build Coastguard Worker return hash;
300*6777b538SAndroid Build Coastguard Worker }
301*6777b538SAndroid Build Coastguard Worker
302*6777b538SAndroid Build Coastguard Worker // static
GetBuildTime()303*6777b538SAndroid Build Coastguard Worker int64_t MetricsLog::GetBuildTime() {
304*6777b538SAndroid Build Coastguard Worker static int64_t integral_build_time = 0;
305*6777b538SAndroid Build Coastguard Worker if (!integral_build_time)
306*6777b538SAndroid Build Coastguard Worker integral_build_time = static_cast<int64_t>(base::GetBuildTime().ToTimeT());
307*6777b538SAndroid Build Coastguard Worker return integral_build_time;
308*6777b538SAndroid Build Coastguard Worker }
309*6777b538SAndroid Build Coastguard Worker
310*6777b538SAndroid Build Coastguard Worker // static
GetCurrentTime()311*6777b538SAndroid Build Coastguard Worker int64_t MetricsLog::GetCurrentTime() {
312*6777b538SAndroid Build Coastguard Worker return ToMonotonicSeconds(base::TimeTicks::Now());
313*6777b538SAndroid Build Coastguard Worker }
314*6777b538SAndroid Build Coastguard Worker
AssignFinalizedRecordId(PrefService * local_state)315*6777b538SAndroid Build Coastguard Worker void MetricsLog::AssignFinalizedRecordId(PrefService* local_state) {
316*6777b538SAndroid Build Coastguard Worker DCHECK(!uma_proto_.has_finalized_record_id());
317*6777b538SAndroid Build Coastguard Worker uma_proto_.set_finalized_record_id(
318*6777b538SAndroid Build Coastguard Worker IncrementAndUpdate(local_state, prefs::kMetricsLogFinalizedRecordId));
319*6777b538SAndroid Build Coastguard Worker }
320*6777b538SAndroid Build Coastguard Worker
AssignRecordId(PrefService * local_state)321*6777b538SAndroid Build Coastguard Worker void MetricsLog::AssignRecordId(PrefService* local_state) {
322*6777b538SAndroid Build Coastguard Worker DCHECK(!uma_proto_.has_record_id());
323*6777b538SAndroid Build Coastguard Worker uma_proto_.set_record_id(
324*6777b538SAndroid Build Coastguard Worker IncrementAndUpdate(local_state, prefs::kMetricsLogRecordId));
325*6777b538SAndroid Build Coastguard Worker }
326*6777b538SAndroid Build Coastguard Worker
RecordUserAction(const std::string & key,base::TimeTicks action_time)327*6777b538SAndroid Build Coastguard Worker void MetricsLog::RecordUserAction(const std::string& key,
328*6777b538SAndroid Build Coastguard Worker base::TimeTicks action_time) {
329*6777b538SAndroid Build Coastguard Worker DCHECK(!closed_);
330*6777b538SAndroid Build Coastguard Worker
331*6777b538SAndroid Build Coastguard Worker UserActionEventProto* user_action = uma_proto_.add_user_action_event();
332*6777b538SAndroid Build Coastguard Worker user_action->set_name_hash(Hash(key));
333*6777b538SAndroid Build Coastguard Worker user_action->set_time_sec(ToMonotonicSeconds(action_time));
334*6777b538SAndroid Build Coastguard Worker UMA_HISTOGRAM_BOOLEAN("UMA.UserActionsCount", true);
335*6777b538SAndroid Build Coastguard Worker }
336*6777b538SAndroid Build Coastguard Worker
337*6777b538SAndroid Build Coastguard Worker // static
RecordCoreSystemProfile(MetricsServiceClient * client,SystemProfileProto * system_profile)338*6777b538SAndroid Build Coastguard Worker void MetricsLog::RecordCoreSystemProfile(MetricsServiceClient* client,
339*6777b538SAndroid Build Coastguard Worker SystemProfileProto* system_profile) {
340*6777b538SAndroid Build Coastguard Worker RecordCoreSystemProfile(
341*6777b538SAndroid Build Coastguard Worker client->GetVersionString(), client->GetChannel(),
342*6777b538SAndroid Build Coastguard Worker client->IsExtendedStableChannel(), client->GetApplicationLocale(),
343*6777b538SAndroid Build Coastguard Worker client->GetAppPackageNameIfLoggable(), system_profile);
344*6777b538SAndroid Build Coastguard Worker
345*6777b538SAndroid Build Coastguard Worker std::string brand_code;
346*6777b538SAndroid Build Coastguard Worker if (client->GetBrand(&brand_code))
347*6777b538SAndroid Build Coastguard Worker system_profile->set_brand_code(brand_code);
348*6777b538SAndroid Build Coastguard Worker
349*6777b538SAndroid Build Coastguard Worker // Records 32-bit hashes of the command line keys.
350*6777b538SAndroid Build Coastguard Worker base::CommandLine command_line_copy(*base::CommandLine::ForCurrentProcess());
351*6777b538SAndroid Build Coastguard Worker
352*6777b538SAndroid Build Coastguard Worker // Exclude these switches which are very frequently on the command line but
353*6777b538SAndroid Build Coastguard Worker // serve no meaningful purpose.
354*6777b538SAndroid Build Coastguard Worker static const char* const kSwitchesToFilter[] = {
355*6777b538SAndroid Build Coastguard Worker switches::kFlagSwitchesBegin,
356*6777b538SAndroid Build Coastguard Worker switches::kFlagSwitchesEnd,
357*6777b538SAndroid Build Coastguard Worker };
358*6777b538SAndroid Build Coastguard Worker
359*6777b538SAndroid Build Coastguard Worker for (const char* filter_switch : kSwitchesToFilter)
360*6777b538SAndroid Build Coastguard Worker command_line_copy.RemoveSwitch(filter_switch);
361*6777b538SAndroid Build Coastguard Worker
362*6777b538SAndroid Build Coastguard Worker for (const auto& command_line_switch : command_line_copy.GetSwitches()) {
363*6777b538SAndroid Build Coastguard Worker system_profile->add_command_line_key_hash(
364*6777b538SAndroid Build Coastguard Worker variations::HashName(command_line_switch.first));
365*6777b538SAndroid Build Coastguard Worker }
366*6777b538SAndroid Build Coastguard Worker }
367*6777b538SAndroid Build Coastguard Worker
368*6777b538SAndroid Build Coastguard Worker // static
RecordCoreSystemProfile(const std::string & version,metrics::SystemProfileProto::Channel channel,bool is_extended_stable_channel,const std::string & application_locale,const std::string & package_name,SystemProfileProto * system_profile)369*6777b538SAndroid Build Coastguard Worker void MetricsLog::RecordCoreSystemProfile(
370*6777b538SAndroid Build Coastguard Worker const std::string& version,
371*6777b538SAndroid Build Coastguard Worker metrics::SystemProfileProto::Channel channel,
372*6777b538SAndroid Build Coastguard Worker bool is_extended_stable_channel,
373*6777b538SAndroid Build Coastguard Worker const std::string& application_locale,
374*6777b538SAndroid Build Coastguard Worker const std::string& package_name,
375*6777b538SAndroid Build Coastguard Worker SystemProfileProto* system_profile) {
376*6777b538SAndroid Build Coastguard Worker system_profile->set_build_timestamp(metrics::MetricsLog::GetBuildTime());
377*6777b538SAndroid Build Coastguard Worker system_profile->set_app_version(version);
378*6777b538SAndroid Build Coastguard Worker system_profile->set_channel(channel);
379*6777b538SAndroid Build Coastguard Worker if (is_extended_stable_channel)
380*6777b538SAndroid Build Coastguard Worker system_profile->set_is_extended_stable_channel(true);
381*6777b538SAndroid Build Coastguard Worker system_profile->set_application_locale(application_locale);
382*6777b538SAndroid Build Coastguard Worker
383*6777b538SAndroid Build Coastguard Worker #if defined(ADDRESS_SANITIZER) || DCHECK_IS_ON()
384*6777b538SAndroid Build Coastguard Worker // Set if a build is instrumented (e.g. built with ASAN, or with DCHECKs).
385*6777b538SAndroid Build Coastguard Worker system_profile->set_is_instrumented_build(true);
386*6777b538SAndroid Build Coastguard Worker #endif
387*6777b538SAndroid Build Coastguard Worker
388*6777b538SAndroid Build Coastguard Worker system_profile->set_session_hash(GetSessionHash());
389*6777b538SAndroid Build Coastguard Worker
390*6777b538SAndroid Build Coastguard Worker metrics::SystemProfileProto::Hardware* hardware =
391*6777b538SAndroid Build Coastguard Worker system_profile->mutable_hardware();
392*6777b538SAndroid Build Coastguard Worker hardware->set_cpu_architecture(base::SysInfo::OperatingSystemArchitecture());
393*6777b538SAndroid Build Coastguard Worker auto app_os_arch = base::SysInfo::ProcessCPUArchitecture();
394*6777b538SAndroid Build Coastguard Worker if (!app_os_arch.empty())
395*6777b538SAndroid Build Coastguard Worker hardware->set_app_cpu_architecture(app_os_arch);
396*6777b538SAndroid Build Coastguard Worker hardware->set_system_ram_mb(base::SysInfo::AmountOfPhysicalMemoryMB());
397*6777b538SAndroid Build Coastguard Worker hardware->set_hardware_class(base::SysInfo::HardwareModelName());
398*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_WIN)
399*6777b538SAndroid Build Coastguard Worker hardware->set_dll_base(reinterpret_cast<uint64_t>(CURRENT_MODULE()));
400*6777b538SAndroid Build Coastguard Worker #endif
401*6777b538SAndroid Build Coastguard Worker
402*6777b538SAndroid Build Coastguard Worker metrics::SystemProfileProto::OS* os = system_profile->mutable_os();
403*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_CHROMEOS_LACROS)
404*6777b538SAndroid Build Coastguard Worker // The Lacros browser runs on Chrome OS, but reports a special OS name to
405*6777b538SAndroid Build Coastguard Worker // differentiate itself from the built-in ash browser + window manager binary.
406*6777b538SAndroid Build Coastguard Worker os->set_name("Lacros");
407*6777b538SAndroid Build Coastguard Worker #elif BUILDFLAG(IS_CHROMEOS_ASH)
408*6777b538SAndroid Build Coastguard Worker os->set_name("CrOS");
409*6777b538SAndroid Build Coastguard Worker #else
410*6777b538SAndroid Build Coastguard Worker os->set_name(base::SysInfo::OperatingSystemName());
411*6777b538SAndroid Build Coastguard Worker #endif
412*6777b538SAndroid Build Coastguard Worker os->set_version(base::SysInfo::OperatingSystemVersion());
413*6777b538SAndroid Build Coastguard Worker
414*6777b538SAndroid Build Coastguard Worker // On ChromeOS, KernelVersion refers to the Linux kernel version and
415*6777b538SAndroid Build Coastguard Worker // OperatingSystemVersion refers to the ChromeOS release version.
416*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_CHROMEOS_ASH)
417*6777b538SAndroid Build Coastguard Worker os->set_kernel_version(base::SysInfo::KernelVersion());
418*6777b538SAndroid Build Coastguard Worker #elif BUILDFLAG(IS_LINUX) || BUILDFLAG(IS_CHROMEOS_LACROS)
419*6777b538SAndroid Build Coastguard Worker // Linux operating system version is copied over into kernel version to be
420*6777b538SAndroid Build Coastguard Worker // consistent.
421*6777b538SAndroid Build Coastguard Worker os->set_kernel_version(base::SysInfo::OperatingSystemVersion());
422*6777b538SAndroid Build Coastguard Worker #endif
423*6777b538SAndroid Build Coastguard Worker
424*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_ANDROID)
425*6777b538SAndroid Build Coastguard Worker const auto* build_info = base::android::BuildInfo::GetInstance();
426*6777b538SAndroid Build Coastguard Worker os->set_build_fingerprint(build_info->android_build_fp());
427*6777b538SAndroid Build Coastguard Worker if (!package_name.empty() && package_name != "com.android.chrome")
428*6777b538SAndroid Build Coastguard Worker system_profile->set_app_package_name(package_name);
429*6777b538SAndroid Build Coastguard Worker system_profile->set_installer_package(
430*6777b538SAndroid Build Coastguard Worker internal::ToInstallerPackage(build_info->installer_package_name()));
431*6777b538SAndroid Build Coastguard Worker #elif BUILDFLAG(IS_IOS)
432*6777b538SAndroid Build Coastguard Worker os->set_build_number(base::SysInfo::GetIOSBuildNumber());
433*6777b538SAndroid Build Coastguard Worker #endif
434*6777b538SAndroid Build Coastguard Worker
435*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_LINUX)
436*6777b538SAndroid Build Coastguard Worker std::unique_ptr<base::Environment> env = base::Environment::Create();
437*6777b538SAndroid Build Coastguard Worker os->set_xdg_session_type(ToProtoSessionType(base::nix::GetSessionType(*env)));
438*6777b538SAndroid Build Coastguard Worker os->set_xdg_current_desktop(
439*6777b538SAndroid Build Coastguard Worker ToProtoCurrentDesktop(base::nix::GetDesktopEnvironment(env.get())));
440*6777b538SAndroid Build Coastguard Worker #endif
441*6777b538SAndroid Build Coastguard Worker }
442*6777b538SAndroid Build Coastguard Worker
RecordHistogramDelta(const std::string & histogram_name,const base::HistogramSamples & snapshot)443*6777b538SAndroid Build Coastguard Worker void MetricsLog::RecordHistogramDelta(const std::string& histogram_name,
444*6777b538SAndroid Build Coastguard Worker const base::HistogramSamples& snapshot) {
445*6777b538SAndroid Build Coastguard Worker DCHECK(!closed_);
446*6777b538SAndroid Build Coastguard Worker log_metadata_.AddSampleCount(snapshot.TotalCount());
447*6777b538SAndroid Build Coastguard Worker EncodeHistogramDelta(histogram_name, snapshot, &uma_proto_);
448*6777b538SAndroid Build Coastguard Worker }
449*6777b538SAndroid Build Coastguard Worker
RecordPreviousSessionData(DelegatingProvider * delegating_provider,PrefService * local_state)450*6777b538SAndroid Build Coastguard Worker void MetricsLog::RecordPreviousSessionData(
451*6777b538SAndroid Build Coastguard Worker DelegatingProvider* delegating_provider,
452*6777b538SAndroid Build Coastguard Worker PrefService* local_state) {
453*6777b538SAndroid Build Coastguard Worker delegating_provider->ProvidePreviousSessionData(uma_proto());
454*6777b538SAndroid Build Coastguard Worker // Schedule a Local State write to flush updated prefs to disk. This is done
455*6777b538SAndroid Build Coastguard Worker // because a side effect of providing data—namely stability data—is updating
456*6777b538SAndroid Build Coastguard Worker // Local State prefs.
457*6777b538SAndroid Build Coastguard Worker local_state->CommitPendingWrite();
458*6777b538SAndroid Build Coastguard Worker }
459*6777b538SAndroid Build Coastguard Worker
RecordCurrentSessionData(base::TimeDelta incremental_uptime,base::TimeDelta uptime,DelegatingProvider * delegating_provider,PrefService * local_state)460*6777b538SAndroid Build Coastguard Worker void MetricsLog::RecordCurrentSessionData(
461*6777b538SAndroid Build Coastguard Worker base::TimeDelta incremental_uptime,
462*6777b538SAndroid Build Coastguard Worker base::TimeDelta uptime,
463*6777b538SAndroid Build Coastguard Worker DelegatingProvider* delegating_provider,
464*6777b538SAndroid Build Coastguard Worker PrefService* local_state) {
465*6777b538SAndroid Build Coastguard Worker DCHECK(!closed_);
466*6777b538SAndroid Build Coastguard Worker DCHECK(has_environment_);
467*6777b538SAndroid Build Coastguard Worker
468*6777b538SAndroid Build Coastguard Worker // Record recent delta for critical stability metrics. We can't wait for a
469*6777b538SAndroid Build Coastguard Worker // restart to gather these, as that delay biases our observation away from
470*6777b538SAndroid Build Coastguard Worker // users that run happily for a looooong time. We send increments with each
471*6777b538SAndroid Build Coastguard Worker // UMA log upload, just as we send histogram data.
472*6777b538SAndroid Build Coastguard Worker WriteRealtimeStabilityAttributes(incremental_uptime, uptime);
473*6777b538SAndroid Build Coastguard Worker
474*6777b538SAndroid Build Coastguard Worker delegating_provider->ProvideCurrentSessionData(uma_proto());
475*6777b538SAndroid Build Coastguard Worker // Schedule a Local State write to flush updated prefs to disk. This is done
476*6777b538SAndroid Build Coastguard Worker // because a side effect of providing data—namely stability data—is updating
477*6777b538SAndroid Build Coastguard Worker // Local State prefs.
478*6777b538SAndroid Build Coastguard Worker local_state->CommitPendingWrite();
479*6777b538SAndroid Build Coastguard Worker }
480*6777b538SAndroid Build Coastguard Worker
WriteMetricsEnableDefault(EnableMetricsDefault metrics_default,SystemProfileProto * system_profile)481*6777b538SAndroid Build Coastguard Worker void MetricsLog::WriteMetricsEnableDefault(EnableMetricsDefault metrics_default,
482*6777b538SAndroid Build Coastguard Worker SystemProfileProto* system_profile) {
483*6777b538SAndroid Build Coastguard Worker if (client_->IsReportingPolicyManaged()) {
484*6777b538SAndroid Build Coastguard Worker // If it's managed, then it must be reporting, otherwise we wouldn't be
485*6777b538SAndroid Build Coastguard Worker // sending metrics.
486*6777b538SAndroid Build Coastguard Worker system_profile->set_uma_default_state(
487*6777b538SAndroid Build Coastguard Worker SystemProfileProto_UmaDefaultState_POLICY_FORCED_ENABLED);
488*6777b538SAndroid Build Coastguard Worker return;
489*6777b538SAndroid Build Coastguard Worker }
490*6777b538SAndroid Build Coastguard Worker
491*6777b538SAndroid Build Coastguard Worker switch (metrics_default) {
492*6777b538SAndroid Build Coastguard Worker case EnableMetricsDefault::DEFAULT_UNKNOWN:
493*6777b538SAndroid Build Coastguard Worker // Don't set the field if it's unknown.
494*6777b538SAndroid Build Coastguard Worker break;
495*6777b538SAndroid Build Coastguard Worker case EnableMetricsDefault::OPT_IN:
496*6777b538SAndroid Build Coastguard Worker system_profile->set_uma_default_state(
497*6777b538SAndroid Build Coastguard Worker SystemProfileProto_UmaDefaultState_OPT_IN);
498*6777b538SAndroid Build Coastguard Worker break;
499*6777b538SAndroid Build Coastguard Worker case EnableMetricsDefault::OPT_OUT:
500*6777b538SAndroid Build Coastguard Worker system_profile->set_uma_default_state(
501*6777b538SAndroid Build Coastguard Worker SystemProfileProto_UmaDefaultState_OPT_OUT);
502*6777b538SAndroid Build Coastguard Worker }
503*6777b538SAndroid Build Coastguard Worker }
504*6777b538SAndroid Build Coastguard Worker
WriteRealtimeStabilityAttributes(base::TimeDelta incremental_uptime,base::TimeDelta uptime)505*6777b538SAndroid Build Coastguard Worker void MetricsLog::WriteRealtimeStabilityAttributes(
506*6777b538SAndroid Build Coastguard Worker base::TimeDelta incremental_uptime,
507*6777b538SAndroid Build Coastguard Worker base::TimeDelta uptime) {
508*6777b538SAndroid Build Coastguard Worker // Update the stats which are critical for real-time stability monitoring.
509*6777b538SAndroid Build Coastguard Worker // Since these are "optional," only list ones that are non-zero, as the counts
510*6777b538SAndroid Build Coastguard Worker // are aggregated (summed) server side.
511*6777b538SAndroid Build Coastguard Worker
512*6777b538SAndroid Build Coastguard Worker SystemProfileProto::Stability* stability =
513*6777b538SAndroid Build Coastguard Worker uma_proto()->mutable_system_profile()->mutable_stability();
514*6777b538SAndroid Build Coastguard Worker
515*6777b538SAndroid Build Coastguard Worker const uint64_t incremental_uptime_sec = incremental_uptime.InSeconds();
516*6777b538SAndroid Build Coastguard Worker if (incremental_uptime_sec)
517*6777b538SAndroid Build Coastguard Worker stability->set_incremental_uptime_sec(incremental_uptime_sec);
518*6777b538SAndroid Build Coastguard Worker const uint64_t uptime_sec = uptime.InSeconds();
519*6777b538SAndroid Build Coastguard Worker if (uptime_sec)
520*6777b538SAndroid Build Coastguard Worker stability->set_uptime_sec(uptime_sec);
521*6777b538SAndroid Build Coastguard Worker }
522*6777b538SAndroid Build Coastguard Worker
RecordEnvironment(DelegatingProvider * delegating_provider)523*6777b538SAndroid Build Coastguard Worker const SystemProfileProto& MetricsLog::RecordEnvironment(
524*6777b538SAndroid Build Coastguard Worker DelegatingProvider* delegating_provider) {
525*6777b538SAndroid Build Coastguard Worker // If |has_environment_| is true, then the system profile in |uma_proto_| has
526*6777b538SAndroid Build Coastguard Worker // previously been fully filled in. We still want to fill it in again with
527*6777b538SAndroid Build Coastguard Worker // more up to date information (e.g. current field trials), but in order to
528*6777b538SAndroid Build Coastguard Worker // not have duplicate repeated fields, we must first clear it. Clearing it
529*6777b538SAndroid Build Coastguard Worker // will reset the information filled in by RecordCoreSystemProfile() that was
530*6777b538SAndroid Build Coastguard Worker // previously done in the constructor, so re-add that too.
531*6777b538SAndroid Build Coastguard Worker //
532*6777b538SAndroid Build Coastguard Worker // The |has_environment| case will happen on the very first log, where we
533*6777b538SAndroid Build Coastguard Worker // call RecordEnvironment() in order to persist the system profile in the
534*6777b538SAndroid Build Coastguard Worker // persistent histograms .pma file.
535*6777b538SAndroid Build Coastguard Worker if (has_environment_) {
536*6777b538SAndroid Build Coastguard Worker std::string client_uuid = uma_proto_.system_profile().client_uuid();
537*6777b538SAndroid Build Coastguard Worker uma_proto_.clear_system_profile();
538*6777b538SAndroid Build Coastguard Worker MetricsLog::RecordCoreSystemProfile(client_,
539*6777b538SAndroid Build Coastguard Worker uma_proto_.mutable_system_profile());
540*6777b538SAndroid Build Coastguard Worker uma_proto_.mutable_system_profile()->set_client_uuid(client_uuid);
541*6777b538SAndroid Build Coastguard Worker }
542*6777b538SAndroid Build Coastguard Worker
543*6777b538SAndroid Build Coastguard Worker has_environment_ = true;
544*6777b538SAndroid Build Coastguard Worker
545*6777b538SAndroid Build Coastguard Worker SystemProfileProto* system_profile = uma_proto_.mutable_system_profile();
546*6777b538SAndroid Build Coastguard Worker WriteMetricsEnableDefault(client_->GetMetricsReportingDefaultState(),
547*6777b538SAndroid Build Coastguard Worker system_profile);
548*6777b538SAndroid Build Coastguard Worker
549*6777b538SAndroid Build Coastguard Worker delegating_provider->ProvideSystemProfileMetricsWithLogCreationTime(
550*6777b538SAndroid Build Coastguard Worker creation_time_, system_profile);
551*6777b538SAndroid Build Coastguard Worker
552*6777b538SAndroid Build Coastguard Worker return *system_profile;
553*6777b538SAndroid Build Coastguard Worker }
554*6777b538SAndroid Build Coastguard Worker
LoadSavedEnvironmentFromPrefs(PrefService * local_state)555*6777b538SAndroid Build Coastguard Worker bool MetricsLog::LoadSavedEnvironmentFromPrefs(PrefService* local_state) {
556*6777b538SAndroid Build Coastguard Worker DCHECK(!has_environment_);
557*6777b538SAndroid Build Coastguard Worker has_environment_ = true;
558*6777b538SAndroid Build Coastguard Worker
559*6777b538SAndroid Build Coastguard Worker SystemProfileProto* system_profile = uma_proto()->mutable_system_profile();
560*6777b538SAndroid Build Coastguard Worker EnvironmentRecorder recorder(local_state);
561*6777b538SAndroid Build Coastguard Worker return recorder.LoadEnvironmentFromPrefs(system_profile);
562*6777b538SAndroid Build Coastguard Worker }
563*6777b538SAndroid Build Coastguard Worker
564*6777b538SAndroid Build Coastguard Worker metrics::ChromeUserMetricsExtension::RealLocalTime
GetCurrentClockTime(bool record_time_zone)565*6777b538SAndroid Build Coastguard Worker MetricsLog::GetCurrentClockTime(bool record_time_zone) {
566*6777b538SAndroid Build Coastguard Worker CHECK_EQ(log_type_, MetricsLog::ONGOING_LOG);
567*6777b538SAndroid Build Coastguard Worker metrics::ChromeUserMetricsExtension::RealLocalTime time;
568*6777b538SAndroid Build Coastguard Worker RecordCurrentTime(clock_, network_clock_, record_time_zone, &time);
569*6777b538SAndroid Build Coastguard Worker return time;
570*6777b538SAndroid Build Coastguard Worker }
571*6777b538SAndroid Build Coastguard Worker
FinalizeLog(bool truncate_events,const std::string & current_app_version,std::optional<ChromeUserMetricsExtension::RealLocalTime> close_time,std::string * encoded_log)572*6777b538SAndroid Build Coastguard Worker void MetricsLog::FinalizeLog(
573*6777b538SAndroid Build Coastguard Worker bool truncate_events,
574*6777b538SAndroid Build Coastguard Worker const std::string& current_app_version,
575*6777b538SAndroid Build Coastguard Worker std::optional<ChromeUserMetricsExtension::RealLocalTime> close_time,
576*6777b538SAndroid Build Coastguard Worker std::string* encoded_log) {
577*6777b538SAndroid Build Coastguard Worker if (truncate_events)
578*6777b538SAndroid Build Coastguard Worker TruncateEvents();
579*6777b538SAndroid Build Coastguard Worker RecordLogWrittenByAppVersionIfNeeded(current_app_version);
580*6777b538SAndroid Build Coastguard Worker if (close_time.has_value()) {
581*6777b538SAndroid Build Coastguard Worker *uma_proto_.mutable_time_log_closed() = std::move(close_time.value());
582*6777b538SAndroid Build Coastguard Worker }
583*6777b538SAndroid Build Coastguard Worker CloseLog();
584*6777b538SAndroid Build Coastguard Worker
585*6777b538SAndroid Build Coastguard Worker uma_proto_.SerializeToString(encoded_log);
586*6777b538SAndroid Build Coastguard Worker }
587*6777b538SAndroid Build Coastguard Worker
CloseLog()588*6777b538SAndroid Build Coastguard Worker void MetricsLog::CloseLog() {
589*6777b538SAndroid Build Coastguard Worker DCHECK(!closed_);
590*6777b538SAndroid Build Coastguard Worker
591*6777b538SAndroid Build Coastguard Worker // Ongoing logs (and only ongoing logs) should have a closed timestamp. Other
592*6777b538SAndroid Build Coastguard Worker // types of logs (initial stability and independent) contain metrics from
593*6777b538SAndroid Build Coastguard Worker // previous sessions, so do not add timestamps as they would not accurately
594*6777b538SAndroid Build Coastguard Worker // represent the time at which those metrics were emitted.
595*6777b538SAndroid Build Coastguard Worker CHECK(log_type_ == MetricsLog::ONGOING_LOG
596*6777b538SAndroid Build Coastguard Worker ? uma_proto_.has_time_log_closed()
597*6777b538SAndroid Build Coastguard Worker : !uma_proto_.has_time_log_closed());
598*6777b538SAndroid Build Coastguard Worker
599*6777b538SAndroid Build Coastguard Worker closed_ = true;
600*6777b538SAndroid Build Coastguard Worker }
601*6777b538SAndroid Build Coastguard Worker
RecordLogWrittenByAppVersionIfNeeded(const std::string & current_version)602*6777b538SAndroid Build Coastguard Worker void MetricsLog::RecordLogWrittenByAppVersionIfNeeded(
603*6777b538SAndroid Build Coastguard Worker const std::string& current_version) {
604*6777b538SAndroid Build Coastguard Worker DCHECK(!closed_);
605*6777b538SAndroid Build Coastguard Worker if (uma_proto()->system_profile().app_version() != current_version) {
606*6777b538SAndroid Build Coastguard Worker uma_proto()->mutable_system_profile()->set_log_written_by_app_version(
607*6777b538SAndroid Build Coastguard Worker current_version);
608*6777b538SAndroid Build Coastguard Worker }
609*6777b538SAndroid Build Coastguard Worker }
610*6777b538SAndroid Build Coastguard Worker
TruncateEvents()611*6777b538SAndroid Build Coastguard Worker void MetricsLog::TruncateEvents() {
612*6777b538SAndroid Build Coastguard Worker DCHECK(!closed_);
613*6777b538SAndroid Build Coastguard Worker if (uma_proto_.user_action_event_size() > internal::kUserActionEventLimit) {
614*6777b538SAndroid Build Coastguard Worker UMA_HISTOGRAM_COUNTS_100000("UMA.TruncatedEvents.UserAction",
615*6777b538SAndroid Build Coastguard Worker uma_proto_.user_action_event_size());
616*6777b538SAndroid Build Coastguard Worker for (int i = internal::kUserActionEventLimit;
617*6777b538SAndroid Build Coastguard Worker i < uma_proto_.user_action_event_size(); ++i) {
618*6777b538SAndroid Build Coastguard Worker // No histograms.xml entry is added for this histogram because it uses an
619*6777b538SAndroid Build Coastguard Worker // enum that is generated from actions.xml in our processing pipelines.
620*6777b538SAndroid Build Coastguard Worker // Instead, a histogram description will also be produced in our
621*6777b538SAndroid Build Coastguard Worker // pipelines.
622*6777b538SAndroid Build Coastguard Worker UMA_HISTOGRAM_SPARSE(
623*6777b538SAndroid Build Coastguard Worker "UMA.TruncatedEvents.UserAction.Type",
624*6777b538SAndroid Build Coastguard Worker // Truncate the unsigned 64-bit hash to 31 bits, to make it a suitable
625*6777b538SAndroid Build Coastguard Worker // histogram sample.
626*6777b538SAndroid Build Coastguard Worker uma_proto_.user_action_event(i).name_hash() & 0x7fffffff);
627*6777b538SAndroid Build Coastguard Worker }
628*6777b538SAndroid Build Coastguard Worker uma_proto_.mutable_user_action_event()->DeleteSubrange(
629*6777b538SAndroid Build Coastguard Worker internal::kUserActionEventLimit,
630*6777b538SAndroid Build Coastguard Worker uma_proto_.user_action_event_size() - internal::kUserActionEventLimit);
631*6777b538SAndroid Build Coastguard Worker }
632*6777b538SAndroid Build Coastguard Worker
633*6777b538SAndroid Build Coastguard Worker if (uma_proto_.omnibox_event_size() > internal::kOmniboxEventLimit) {
634*6777b538SAndroid Build Coastguard Worker uma_proto_.mutable_omnibox_event()->DeleteSubrange(
635*6777b538SAndroid Build Coastguard Worker internal::kOmniboxEventLimit,
636*6777b538SAndroid Build Coastguard Worker uma_proto_.omnibox_event_size() - internal::kOmniboxEventLimit);
637*6777b538SAndroid Build Coastguard Worker }
638*6777b538SAndroid Build Coastguard Worker }
639*6777b538SAndroid Build Coastguard Worker
640*6777b538SAndroid Build Coastguard Worker #if BUILDFLAG(IS_CHROMEOS_ASH)
SetUserId(const std::string & user_id)641*6777b538SAndroid Build Coastguard Worker void MetricsLog::SetUserId(const std::string& user_id) {
642*6777b538SAndroid Build Coastguard Worker uint64_t hashed_user_id = Hash(user_id);
643*6777b538SAndroid Build Coastguard Worker uma_proto_.set_user_id(hashed_user_id);
644*6777b538SAndroid Build Coastguard Worker log_metadata_.user_id = hashed_user_id;
645*6777b538SAndroid Build Coastguard Worker }
646*6777b538SAndroid Build Coastguard Worker #endif // BUILDFLAG(IS_CHROMEOS_ASH)
647*6777b538SAndroid Build Coastguard Worker
648*6777b538SAndroid Build Coastguard Worker } // namespace metrics
649