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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
// 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.
#include "components/rappor/rappor_service.h"
#include "base/base64.h"
#include "base/metrics/field_trial.h"
#include "base/prefs/pref_registry_simple.h"
#include "base/prefs/pref_service.h"
#include "base/rand_util.h"
#include "base/stl_util.h"
#include "base/time/time.h"
#include "components/metrics/metrics_hashes.h"
#include "components/rappor/log_uploader.h"
#include "components/rappor/proto/rappor_metric.pb.h"
#include "components/rappor/rappor_metric.h"
#include "components/rappor/rappor_pref_names.h"
#include "components/variations/variations_associated_data.h"
namespace rappor {
namespace {
// The number of cohorts we divide clients into.
const int kNumCohorts = 32;
// Seconds before the initial log is generated.
const int kInitialLogIntervalSeconds = 15;
// Interval between ongoing logs.
const int kLogIntervalSeconds = 30 * 60;
const char kMimeType[] = "application/vnd.chrome.rappor";
// Constants for the RAPPOR rollout field trial.
const char kRapporRolloutFieldTrialName[] = "RapporRollout";
// Constant for the finch parameter name for the server URL
const char kRapporRolloutServerUrlParam[] = "ServerUrl";
GURL GetServerUrl() {
return GURL(chrome_variations::GetVariationParamValue(
kRapporRolloutFieldTrialName,
kRapporRolloutServerUrlParam));
}
const RapporParameters kRapporParametersForType[NUM_RAPPOR_TYPES] = {
// ETLD_PLUS_ONE_RAPPOR_TYPE
{16 /* Bloom filter size bytes */,
2 /* Bloom filter hash count */,
rappor::PROBABILITY_75 /* Fake data probability */,
rappor::PROBABILITY_50 /* Fake one probability */,
rappor::PROBABILITY_75 /* One coin probability */,
rappor::PROBABILITY_50 /* Zero coin probability */},
};
} // namespace
RapporService::RapporService() : cohort_(-1) {}
RapporService::~RapporService() {
STLDeleteValues(&metrics_map_);
}
void RapporService::Start(PrefService* pref_service,
net::URLRequestContextGetter* request_context) {
const GURL server_url = GetServerUrl();
if (!server_url.is_valid())
return;
DCHECK(!uploader_);
LoadSecret(pref_service);
LoadCohort(pref_service);
uploader_.reset(new LogUploader(server_url, kMimeType, request_context));
log_rotation_timer_.Start(
FROM_HERE,
base::TimeDelta::FromSeconds(kInitialLogIntervalSeconds),
this,
&RapporService::OnLogInterval);
}
void RapporService::OnLogInterval() {
DCHECK(uploader_);
RapporReports reports;
if (ExportMetrics(&reports)) {
std::string log_text;
bool success = reports.SerializeToString(&log_text);
DCHECK(success);
uploader_->QueueLog(log_text);
}
log_rotation_timer_.Start(FROM_HERE,
base::TimeDelta::FromSeconds(kLogIntervalSeconds),
this,
&RapporService::OnLogInterval);
}
// static
void RapporService::RegisterPrefs(PrefRegistrySimple* registry) {
registry->RegisterStringPref(prefs::kRapporSecret, std::string());
registry->RegisterIntegerPref(prefs::kRapporCohort, -1);
}
void RapporService::LoadCohort(PrefService* pref_service) {
DCHECK(!IsInitialized());
cohort_ = pref_service->GetInteger(prefs::kRapporCohort);
// If the user is already assigned to a valid cohort, we're done.
if (cohort_ >= 0 && cohort_ < kNumCohorts)
return;
// This is the first time the client has started the service (or their
// preferences were corrupted). Randomly assign them to a cohort.
cohort_ = base::RandGenerator(kNumCohorts);
pref_service->SetInteger(prefs::kRapporCohort, cohort_);
}
void RapporService::LoadSecret(PrefService* pref_service) {
DCHECK(secret_.empty());
std::string secret_base64 = pref_service->GetString(prefs::kRapporSecret);
if (!secret_base64.empty()) {
bool decoded = base::Base64Decode(secret_base64, &secret_);
if (decoded && secret_.size() == HmacByteVectorGenerator::kEntropyInputSize)
return;
// If the preference fails to decode, or is the wrong size, it must be
// corrupt, so continue as though it didn't exist yet and generate a new
// one.
}
secret_ = HmacByteVectorGenerator::GenerateEntropyInput();
base::Base64Encode(secret_, &secret_base64);
pref_service->SetString(prefs::kRapporSecret, secret_base64);
}
bool RapporService::ExportMetrics(RapporReports* reports) {
if (metrics_map_.empty())
return false;
DCHECK_GE(cohort_, 0);
reports->set_cohort(cohort_);
for (std::map<std::string, RapporMetric*>::const_iterator it =
metrics_map_.begin();
it != metrics_map_.end();
++it) {
const RapporMetric* metric = it->second;
RapporReports::Report* report = reports->add_report();
report->set_name_hash(metrics::HashMetricName(it->first));
ByteVector bytes = metric->GetReport(secret_);
report->set_bits(std::string(bytes.begin(), bytes.end()));
}
STLDeleteValues(&metrics_map_);
return true;
}
bool RapporService::IsInitialized() const {
return cohort_ >= 0;
}
void RapporService::RecordSample(const std::string& metric_name,
RapporType type,
const std::string& sample) {
// Ignore the sample if the service hasn't started yet.
if (!IsInitialized())
return;
DCHECK_LT(type, NUM_RAPPOR_TYPES);
RecordSampleInternal(metric_name, kRapporParametersForType[type], sample);
}
void RapporService::RecordSampleInternal(const std::string& metric_name,
const RapporParameters& parameters,
const std::string& sample) {
DCHECK(IsInitialized());
RapporMetric* metric = LookUpMetric(metric_name, parameters);
metric->AddSample(sample);
}
RapporMetric* RapporService::LookUpMetric(const std::string& metric_name,
const RapporParameters& parameters) {
DCHECK(IsInitialized());
std::map<std::string, RapporMetric*>::const_iterator it =
metrics_map_.find(metric_name);
if (it != metrics_map_.end()) {
RapporMetric* metric = it->second;
DCHECK_EQ(parameters.ToString(), metric->parameters().ToString());
return metric;
}
RapporMetric* new_metric = new RapporMetric(metric_name, parameters, cohort_);
metrics_map_[metric_name] = new_metric;
return new_metric;
}
} // namespace rappor
|
