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
|
// 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 <string>
#include "base/callback_forward.h"
#include "base/memory/scoped_ptr.h"
#include "base/strings/string16.h"
#include "base/time/time.h"
#include "components/metrics/proto/system_profile.pb.h"
namespace base {
class FilePath;
}
namespace metrics {
class MetricsLogUploader;
class MetricsService;
// An abstraction of operations that depend on the embedder's (e.g. Chrome)
// environment.
class MetricsServiceClient {
public:
// Default value of the enable metrics recording. This relates to the state of
// the enable checkbox shown on first-run. This enum is used to store values
// in a pref, and shouldn't be renumbered.
enum EnableMetricsDefault {
// We only record the value during first-run. The default of existing
// installs is considered unknown.
DEFAULT_UNKNOWN,
// The first-run checkbox was unchecked by default.
OPT_IN,
// The first-run checkbox was checked by default.
OPT_OUT,
};
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;
// 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;
// Notifies the client that recording is disabled, so that other services
// (such as crash reporting) can clear any association with metrics.
virtual void OnRecordingDisabled() = 0;
// Whether there's an "off the record" (aka "Incognito") session active.
virtual bool IsOffTheRecordSessionActive() = 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 log has been uploaded.
virtual void OnLogUploadComplete() = 0;
// Gathers metrics that will be filled into the system profile protobuf,
// calling |done_callback| when complete.
virtual void InitializeSystemProfileMetrics(
const base::Closure& done_callback) = 0;
// 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(
const base::Closure& done_callback) = 0;
// Creates a MetricsLogUploader with the specified parameters (see comments on
// MetricsLogUploader for details).
virtual scoped_ptr<MetricsLogUploader> CreateUploader(
const base::Callback<void(int)>& on_upload_complete) = 0;
// Returns the standard interval between upload attempts.
virtual base::TimeDelta GetStandardUploadInterval() = 0;
// Returns the name of a key under HKEY_CURRENT_USER that can be used to store
// backups of metrics data. Unused except on Windows.
virtual base::string16 GetRegistryBackupKey();
// 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 enable metrics reporting
// checkbox shown during first-run.
virtual EnableMetricsDefault GetDefaultOptIn();
// Returns whether cellular logic is enabled for metrics reporting.
virtual bool IsUMACellularUploadLogicEnabled();
};
} // namespace metrics
#endif // COMPONENTS_METRICS_METRICS_SERVICE_CLIENT_H_
|
