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
|
// 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_PROVIDER_H_
#define COMPONENTS_METRICS_METRICS_PROVIDER_H_
#include "base/callback.h"
#include "base/macros.h"
namespace base {
class HistogramSnapshotManager;
} // namespace base
namespace metrics {
class ChromeUserMetricsExtension;
class SystemProfileProto;
// MetricsProvider is an interface allowing different parts of the UMA protos to
// be filled out by different classes.
class MetricsProvider {
public:
MetricsProvider();
virtual ~MetricsProvider();
// Called after initialiazation of MetricsService and field trials.
virtual void Init();
// Called during service initialization to allow the provider to start any
// async initialization tasks. The service will wait for the provider to
// call |done_callback| before generating logs for the current session.
virtual void AsyncInit(const base::Closure& done_callback);
// Called when a new MetricsLog is created.
virtual void OnDidCreateMetricsLog();
// Called when metrics recording has been enabled.
virtual void OnRecordingEnabled();
// Called when metrics recording has been disabled.
virtual void OnRecordingDisabled();
// Called when the application is going into background mode, on platforms
// where applications may be killed when going into the background (Android,
// iOS). Providers that buffer histogram data in memory should persist
// histograms in this callback, as the application may be killed without
// further notification after this callback.
virtual void OnAppEnterBackground();
// Returns whether there are "independent" metrics that can be retrieved
// with a call to ProvideIndependentMetrics().
virtual bool HasIndependentMetrics();
// Provides a complete and independent uma proto + metrics for uploading.
// Called once every time HasIndependentMetrics() returns true. The passed in
// |uma_proto| is by default filled with current session id and core system
// profile infomration. This function is called on main thread, but the
// provider can do async work to fill in |uma_proto| and run |done_callback|
// on calling thread when complete. Ownership of the passed objects remains
// with the caller and those objects will live until the callback is executed.
virtual void ProvideIndependentMetrics(
base::OnceCallback<void(bool)> done_callback,
ChromeUserMetricsExtension* uma_proto,
base::HistogramSnapshotManager* snapshot_manager);
// Provides additional metrics into the system profile.
virtual void ProvideSystemProfileMetrics(
SystemProfileProto* system_profile_proto);
// Called once at startup to see whether this provider has critical data
// to provide about the previous session.
// Returning true will trigger ProvidePreviousSessionData on all other
// registered metrics providers.
// Default implementation always returns false.
virtual bool HasPreviousSessionData();
// Called when building a log about the previous session, so the provider
// can provide data about it. Stability metrics can be provided
// directly into |stability_proto| fields or by logging stability histograms
// via the UMA_STABILITY_HISTOGRAM_ENUMERATION() macro.
virtual void ProvidePreviousSessionData(
ChromeUserMetricsExtension* uma_proto);
// Called when building a log about the current session, so the provider
// can provide data about it.
virtual void ProvideCurrentSessionData(ChromeUserMetricsExtension* uma_proto);
// Provides additional stability metrics. Stability metrics can be provided
// directly into |stability_proto| fields or by logging stability histograms
// via the UMA_STABILITY_HISTOGRAM_ENUMERATION() macro.
virtual void ProvideStabilityMetrics(
SystemProfileProto* system_profile_proto);
// Called to indicate that saved stability prefs should be cleared, e.g.
// because they are from an old version and should not be kept.
virtual void ClearSavedStabilityMetrics();
// Called during regular collection to explicitly load histogram snapshots
// using a snapshot manager. PrepareDeltas() will have already been called
// and FinishDeltas() will be called later; calls to only PrepareDelta(),
// not PrepareDeltas (plural), should be made.
virtual void RecordHistogramSnapshots(
base::HistogramSnapshotManager* snapshot_manager);
// Called during collection of initial metrics to explicitly load histogram
// snapshots using a snapshot manager. PrepareDeltas() will have already
// been called and FinishDeltas() will be called later; calls to only
// PrepareDelta(), not PrepareDeltas (plural), should be made.
virtual void RecordInitialHistogramSnapshots(
base::HistogramSnapshotManager* snapshot_manager);
private:
DISALLOW_COPY_AND_ASSIGN(MetricsProvider);
};
} // namespace metrics
#endif // COMPONENTS_METRICS_METRICS_PROVIDER_H_
|
