Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(475)

Side by Side Diff: components/rappor/rappor_service.h

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

Powered by Google App Engine
This is Rietveld 408576698