• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2014 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #ifndef COMPONENTS_METRICS_METRICS_PROVIDER_H_
6 #define COMPONENTS_METRICS_METRICS_PROVIDER_H_
7 
8 #include "base/basictypes.h"
9 
10 namespace metrics {
11 
12 class ChromeUserMetricsExtension;
13 class SystemProfileProto;
14 class SystemProfileProto_Stability;
15 
16 // MetricsProvider is an interface allowing different parts of the UMA protos to
17 // be filled out by different classes.
18 class MetricsProvider {
19  public:
MetricsProvider()20   MetricsProvider() {}
~MetricsProvider()21   virtual ~MetricsProvider() {}
22 
23   // Called when a new MetricsLog is created.
OnDidCreateMetricsLog()24   virtual void OnDidCreateMetricsLog() {}
25 
26   // Called when metrics recording has been enabled.
OnRecordingEnabled()27   virtual void OnRecordingEnabled() {}
28 
29   // Called when metrics recording has been disabled.
OnRecordingDisabled()30   virtual void OnRecordingDisabled() {}
31 
32   // Provides additional metrics into the system profile.
ProvideSystemProfileMetrics(SystemProfileProto * system_profile_proto)33   virtual void ProvideSystemProfileMetrics(
34       SystemProfileProto* system_profile_proto) {}
35 
36   // Provides additional stability metrics. Stability metrics can be provided
37   // directly into |stability_proto| fields or by logging stability histograms
38   // via the UMA_STABILITY_HISTOGRAM_ENUMERATION() macro.
ProvideStabilityMetrics(SystemProfileProto * system_profile_proto)39   virtual void ProvideStabilityMetrics(
40       SystemProfileProto* system_profile_proto) {}
41 
42   // Provides general metrics that are neither system profile nor stability
43   // metrics.
ProvideGeneralMetrics(ChromeUserMetricsExtension * uma_proto)44   virtual void ProvideGeneralMetrics(
45       ChromeUserMetricsExtension* uma_proto) {}
46 
47   // TODO(asvitkine): Remove this method. http://crbug.com/379148
RecordCurrentState()48   virtual void RecordCurrentState() {}
49 
50  private:
51   DISALLOW_COPY_AND_ASSIGN(MetricsProvider);
52 };
53 
54 }  // namespace metrics
55 
56 #endif  // COMPONENTS_METRICS_METRICS_PROVIDER_H_
57