1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_METRICS_METRICS_SERVICE_CLIENT_H_
#define COMPONENTS_METRICS_METRICS_SERVICE_CLIENT_H_
#include <stdint.h>
#include <memory>
#include <string>
#include "base/callback.h"
#include "base/strings/string16.h"
#include "base/time/time.h"
#include "components/metrics/metrics_log_uploader.h"
#include "components/metrics/metrics_reporting_default_state.h"
#include "third_party/metrics_proto/system_profile.pb.h"
#include "url/gurl.h"
namespace base {
class FilePath;
}
namespace ukm {
class UkmService;
}
namespace metrics {
class MetricsLogUploader;
class MetricsService;
// An abstraction of operations that depend on the embedder's (e.g. Chrome)
// environment.
class MetricsServiceClient {
public:
MetricsServiceClient();
virtual ~MetricsServiceClient();
// Returns the MetricsService instance that this client is associated with.
// With the exception of testing contexts, the returned instance must be valid
// for the lifetime of this object (typically, the embedder's client
// implementation will own the MetricsService instance being returned).
virtual MetricsService* GetMetricsService() = 0;
// Returns the UkmService instance that this client is associated with.
virtual ukm::UkmService* GetUkmService();
// Registers the client id with other services (e.g. crash reporting), called
// when metrics recording gets enabled.
virtual void SetMetricsClientId(const std::string& client_id) = 0;
// Returns the product value to use in uploaded reports, which will be used to
// set the ChromeUserMetricsExtension.product field. See comments on that
// field on why it's an int32_t rather than an enum.
virtual int32_t GetProduct() = 0;
// Returns the current application locale (e.g. "en-US").
virtual std::string GetApplicationLocale() = 0;
// Retrieves the brand code string associated with the install, returning
// false if no brand code is available.
virtual bool GetBrand(std::string* brand_code) = 0;
// Returns the release channel (e.g. stable, beta, etc) of the application.
virtual SystemProfileProto::Channel GetChannel() = 0;
// Returns the version of the application as a string.
virtual std::string GetVersionString() = 0;
// Called by the metrics service when a new environment has been recorded.
// Takes the serialized environment as a parameter. The contents of
// |serialized_environment| are consumed by the call, but the caller maintains
// ownership.
virtual void OnEnvironmentUpdate(std::string* serialized_environment) {}
// Called by the metrics service to record a clean shutdown.
virtual void OnLogCleanShutdown() {}
// Called prior to a metrics log being closed, allowing the client to collect
// extra histograms that will go in that log. Asynchronous API - the client
// implementation should call |done_callback| when complete.
virtual void CollectFinalMetricsForLog(base::OnceClosure done_callback) = 0;
// Get the URL of the metrics server.
virtual GURL GetMetricsServerUrl();
// Get the fallback HTTP URL of the metrics server.
virtual GURL GetInsecureMetricsServerUrl();
// Creates a MetricsLogUploader with the specified parameters (see comments on
// MetricsLogUploader for details).
virtual std::unique_ptr<MetricsLogUploader> CreateUploader(
const GURL& server_url,
const GURL& insecure_server_url,
base::StringPiece mime_type,
metrics::MetricsLogUploader::MetricServiceType service_type,
const MetricsLogUploader::UploadCallback& on_upload_complete) = 0;
// Returns the interval between upload attempts. Checks if debugging flags
// have been set, otherwise defaults to GetStandardUploadInterval().
base::TimeDelta GetUploadInterval();
// Returns the standard interval between upload attempts.
virtual base::TimeDelta GetStandardUploadInterval() = 0;
// Whether or not the MetricsService should start up quickly and upload the
// initial report quickly. By default, this work may be delayed by some
// amount. Only the default behavior should be used in production, but clients
// can override this in tests if tests need to make assertions on the log
// data.
virtual bool ShouldStartUpFastForTesting() const;
// Called on plugin loading errors.
virtual void OnPluginLoadingError(const base::FilePath& plugin_path) {}
// Called on renderer crashes in some embedders (e.g., those that do not use
// //content and thus do not have //content's notification system available
// as a mechanism for observing renderer crashes).
virtual void OnRendererProcessCrash() {}
// Returns whether metrics reporting is managed by policy.
virtual bool IsReportingPolicyManaged();
// Gets information about the default value for the metrics reporting checkbox
// shown during first-run.
virtual EnableMetricsDefault GetMetricsReportingDefaultState();
// Returns whether cellular logic is enabled for metrics reporting.
virtual bool IsUMACellularUploadLogicEnabled();
// Returns whether the allowlist for external experiment ids is enabled. Some
// embedders like WebLayer disable it. For Chrome, it should be enabled.
virtual bool IsExternalExperimentAllowlistEnabled();
// Returns true iff UKM is allowed for all profiles.
// See //components/ukm/observers/ukm_consent_state_observer.h for details.
virtual bool IsUkmAllowedForAllProfiles();
// Returns true iff UKM is allowed to capture extensions for all profiles.
// See //components/ukm/observers/ukm_consent_state_observer.h for details.
virtual bool IsUkmAllowedWithExtensionsForAllProfiles();
// Returns whether UKM notification listeners were attached to all profiles.
virtual bool AreNotificationListenersEnabledOnAllProfiles();
// Gets the app package name (as defined by the embedder). Since package name
// is only meaningful for Android, other platforms should return the empty
// string (this is the same as the default behavior). If the package name
// should not be logged for privacy/fingerprintability reasons, the embedder
// should return the empty string.
virtual std::string GetAppPackageName();
// Gets the key used to sign metrics uploads. This will be used to compute an
// HMAC-SHA256 signature of an uploaded log.
virtual std::string GetUploadSigningKey();
// Checks if the cloned install detector says that client ids should be reset.
virtual bool ShouldResetClientIdsOnClonedInstall();
// Sets the callback to run MetricsServiceManager::UpdateRunningServices.
void SetUpdateRunningServicesCallback(const base::RepeatingClosure& callback);
// Notify MetricsServiceManager to UpdateRunningServices using callback.
void UpdateRunningServices();
// Checks if the user has forced metrics collection on via the override flag.
bool IsMetricsReportingForceEnabled() const;
private:
base::RepeatingClosure update_running_services_;
DISALLOW_COPY_AND_ASSIGN(MetricsServiceClient);
};
} // namespace metrics
#endif // COMPONENTS_METRICS_METRICS_SERVICE_CLIENT_H_
|
