OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 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 | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_ | 5 #ifndef COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_ |
6 #define COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_ | 6 #define COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_ |
7 | 7 |
| 8 #include <map> |
8 #include <string> | 9 #include <string> |
9 | 10 |
10 #include "base/basictypes.h" | 11 #include "base/basictypes.h" |
11 #include "base/prefs/pref_service.h" | 12 #include "base/macros.h" |
12 #include "base/time/time.h" | 13 #include "base/memory/scoped_ptr.h" |
13 #include "base/timer/timer.h" | 14 #include "base/timer/timer.h" |
14 #include "components/rappor/log_uploader.h" | |
15 #include "components/rappor/proto/rappor_metric.pb.h" | |
16 #include "components/rappor/rappor_metric.h" | |
17 | 15 |
18 class PrefRegistrySimple; | 16 class PrefRegistrySimple; |
| 17 class PrefService; |
| 18 |
| 19 namespace net { |
| 20 class URLRequestContextGetter; |
| 21 } |
19 | 22 |
20 namespace rappor { | 23 namespace rappor { |
21 | 24 |
| 25 class LogUploader; |
| 26 class RapporMetric; |
| 27 class RapporReports; |
| 28 struct RapporParameters; |
| 29 |
22 // The type of data stored in a metric. | 30 // The type of data stored in a metric. |
23 enum RapporType { | 31 enum RapporType { |
| 32 // For sampling the eTLD+1 of a URL. |
24 ETLD_PLUS_ONE_RAPPOR_TYPE = 0, | 33 ETLD_PLUS_ONE_RAPPOR_TYPE = 0, |
25 NUM_RAPPOR_TYPES | 34 NUM_RAPPOR_TYPES |
26 }; | 35 }; |
27 | 36 |
28 // This class provides an interface for recording samples for rappor metrics, | 37 // This class provides an interface for recording samples for rappor metrics, |
29 // and periodically generates and uploads reports based on the collected data. | 38 // and periodically generates and uploads reports based on the collected data. |
30 class RapporService { | 39 class RapporService { |
31 public: | 40 public: |
32 RapporService(); | 41 RapporService(); |
33 virtual ~RapporService(); | 42 virtual ~RapporService(); |
(...skipping 11 matching lines...) Expand all Loading... |
45 void SetCohortForTesting(uint32_t cohort) { cohort_ = cohort; } | 54 void SetCohortForTesting(uint32_t cohort) { cohort_ = cohort; } |
46 | 55 |
47 // Sets the secret value. For use by tests only. | 56 // Sets the secret value. For use by tests only. |
48 void SetSecretForTesting(const std::string& secret) { secret_ = secret; } | 57 void SetSecretForTesting(const std::string& secret) { secret_ = secret; } |
49 | 58 |
50 // Registers the names of all of the preferences used by RapporService in the | 59 // Registers the names of all of the preferences used by RapporService in the |
51 // provided PrefRegistry. This should be called before calling Start(). | 60 // provided PrefRegistry. This should be called before calling Start(). |
52 static void RegisterPrefs(PrefRegistrySimple* registry); | 61 static void RegisterPrefs(PrefRegistrySimple* registry); |
53 | 62 |
54 protected: | 63 protected: |
55 // Logs all of the collected metrics to the reports proto message. Exposed | 64 // Logs all of the collected metrics to the reports proto message and clears |
56 // for tests. Returns true if any metrics were recorded. | 65 // the internal map. Exposed for tests. Returns true if any metrics were |
| 66 // recorded. |
57 bool ExportMetrics(RapporReports* reports); | 67 bool ExportMetrics(RapporReports* reports); |
58 | 68 |
59 // Records a sample of the rappor metric specified by |parameters|. | 69 // Records a sample of the rappor metric specified by |parameters|. |
60 // Creates and initializes the metric, if it doesn't yet exist. | 70 // Creates and initializes the metric, if it doesn't yet exist. |
61 // Exposed for tests. | 71 // Exposed for tests. |
62 void RecordSampleInternal(const std::string& metric_name, | 72 void RecordSampleInternal(const std::string& metric_name, |
63 const RapporParameters& parameters, | 73 const RapporParameters& parameters, |
64 const std::string& sample); | 74 const std::string& sample); |
65 | 75 |
66 private: | 76 private: |
(...skipping 17 matching lines...) Expand all Loading... |
84 // exist. | 94 // exist. |
85 RapporMetric* LookUpMetric(const std::string& metric_name, | 95 RapporMetric* LookUpMetric(const std::string& metric_name, |
86 const RapporParameters& parameters); | 96 const RapporParameters& parameters); |
87 | 97 |
88 // Client-side secret used to generate fake bits. | 98 // Client-side secret used to generate fake bits. |
89 std::string secret_; | 99 std::string secret_; |
90 | 100 |
91 // The cohort this client is assigned to. -1 is uninitialized. | 101 // The cohort this client is assigned to. -1 is uninitialized. |
92 int32_t cohort_; | 102 int32_t cohort_; |
93 | 103 |
94 // Timer which schedules calls to OnLogInterval() | 104 // Timer which schedules calls to OnLogInterval(). |
95 base::OneShotTimer<RapporService> log_rotation_timer_; | 105 base::OneShotTimer<RapporService> log_rotation_timer_; |
96 | 106 |
97 // A private LogUploader instance for sending reports to the server. | 107 // A private LogUploader instance for sending reports to the server. |
98 scoped_ptr<LogUploader> uploader_; | 108 scoped_ptr<LogUploader> uploader_; |
99 | 109 |
100 // We keep all registered metrics in a map, from name to metric. | 110 // We keep all registered metrics in a map, from name to metric. |
101 // The map owns the metrics it contains. | 111 // The map owns the metrics it contains. |
102 std::map<std::string, RapporMetric*> metrics_map_; | 112 std::map<std::string, RapporMetric*> metrics_map_; |
103 | 113 |
104 DISALLOW_COPY_AND_ASSIGN(RapporService); | 114 DISALLOW_COPY_AND_ASSIGN(RapporService); |
105 }; | 115 }; |
106 | 116 |
107 } // namespace rappor | 117 } // namespace rappor |
108 | 118 |
109 #endif // COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_ | 119 #endif // COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_ |
OLD | NEW |