OLD | NEW |
(Empty) | |
| 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_RAPPOR_RAPPOR_SERVICE_H_ |
| 6 #define COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_ |
| 7 |
| 8 #include <string> |
| 9 |
| 10 #include "base/basictypes.h" |
| 11 #include "base/prefs/pref_service.h" |
| 12 #include "base/time/time.h" |
| 13 #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 |
| 18 class PrefRegistrySimple; |
| 19 |
| 20 namespace rappor { |
| 21 |
| 22 // The type of data stored in a metric. |
| 23 enum RapporType { |
| 24 ETLD_PLUS_ONE_RAPPOR_TYPE = 0, |
| 25 NUM_RAPPOR_TYPES |
| 26 }; |
| 27 |
| 28 // This class provides an interface for recording samples for rappor metrics, |
| 29 // and periodically generates and uploads reports based on the collected data. |
| 30 class RapporService { |
| 31 public: |
| 32 RapporService(); |
| 33 virtual ~RapporService(); |
| 34 |
| 35 // Starts the periodic generation of reports and upload attempts. |
| 36 void Start(PrefService* pref_service, net::URLRequestContextGetter* context); |
| 37 |
| 38 // Records a sample of the rappor metric specified by |metric_name|. |
| 39 // Creates and initializes the metric, if it doesn't yet exist. |
| 40 void RecordSample(const std::string& metric_name, |
| 41 RapporType type, |
| 42 const std::string& sample); |
| 43 |
| 44 // Sets the cohort value. For use by tests only. |
| 45 void SetCohortForTesting(uint32_t cohort) { cohort_ = cohort; } |
| 46 |
| 47 // Sets the secret value. For use by tests only. |
| 48 void SetSecretForTesting(const std::string& secret) { secret_ = secret; } |
| 49 |
| 50 // Registers the names of all of the preferences used by RapporService in the |
| 51 // provided PrefRegistry. This should be called before calling Start(). |
| 52 static void RegisterPrefs(PrefRegistrySimple* registry); |
| 53 |
| 54 protected: |
| 55 // Logs all of the collected metrics to the reports proto message. Exposed |
| 56 // for tests. Returns true if any metrics were recorded. |
| 57 bool ExportMetrics(RapporReports* reports); |
| 58 |
| 59 // Records a sample of the rappor metric specified by |parameters|. |
| 60 // Creates and initializes the metric, if it doesn't yet exist. |
| 61 // Exposed for tests. |
| 62 void RecordSampleInternal(const std::string& metric_name, |
| 63 const RapporParameters& parameters, |
| 64 const std::string& sample); |
| 65 |
| 66 private: |
| 67 // Check if the service has been started successfully. |
| 68 bool IsInitialized() const; |
| 69 |
| 70 // Retrieves the cohort number this client was assigned to, generating it if |
| 71 // doesn't already exist. The cohort should be persistent. |
| 72 void LoadCohort(PrefService* pref_service); |
| 73 |
| 74 // Retrieves the value for secret_ from preferences, generating it if doesn't |
| 75 // already exist. The secret should be persistent, so that additional bits |
| 76 // from the client do not get exposed over time. |
| 77 void LoadSecret(PrefService* pref_service); |
| 78 |
| 79 // Called whenever the logging interval elapses to generate a new log of |
| 80 // reports and pass it to the uploader. |
| 81 void OnLogInterval(); |
| 82 |
| 83 // Finds a metric in the metrics_map_, creating it if it doesn't already |
| 84 // exist. |
| 85 RapporMetric* LookUpMetric(const std::string& metric_name, |
| 86 const RapporParameters& parameters); |
| 87 |
| 88 // Client-side secret used to generate fake bits. |
| 89 std::string secret_; |
| 90 |
| 91 // The cohort this client is assigned to. -1 is uninitialized. |
| 92 int32_t cohort_; |
| 93 |
| 94 // Timer which schedules calls to OnLogInterval() |
| 95 base::OneShotTimer<RapporService> log_rotation_timer_; |
| 96 |
| 97 // A private LogUploader instance for sending reports to the server. |
| 98 scoped_ptr<LogUploader> uploader_; |
| 99 |
| 100 // We keep all registered metrics in a map, from name to metric. |
| 101 // The map owns the metrics it contains. |
| 102 std::map<std::string, RapporMetric*> metrics_map_; |
| 103 |
| 104 DISALLOW_COPY_AND_ASSIGN(RapporService); |
| 105 }; |
| 106 |
| 107 } // namespace rappor |
| 108 |
| 109 #endif // COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_ |
OLD | NEW |