Alternative Multi-dimensional Rappor

components/rappor/rappor_service.h

 // 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.
 
 #ifndef COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_
 #define COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_
 
 #include <map>
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/callback.h"
 #include "base/macros.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/timer/timer.h"
 #include "components/metrics/daily_event.h"
 #include "components/rappor/rappor_parameters.h"
+#include "components/rappor/sample.h"
+#include "components/rappor/sampler.h"
 
 class PrefRegistrySimple;
 class PrefService;
 
 namespace net {
 class URLRequestContextGetter;
 }
 
 namespace rappor {
 
@@ skipping 28 matching lines @@
   // preferences from disk.
   void Initialize(net::URLRequestContextGetter* context);
 
   // Updates the settings for metric recording and uploading.
   // The RapporService must be initialized before this method is called.
   // If |recording_level| > REPORTING_DISABLED, periodic reports will be
   // generated and queued for upload.
   // If |may_upload| is true, reports will be uploaded from the queue.
   void Update(RecordingLevel recording_level, bool may_upload);
 
+  // Constructs a Sample object for the caller to record fields in.
+  scoped_ptr<Sample> CreateSample(RapporType);
+
+  // Records a Sample of rappor metric specified by |metric_name|.
+  //
+  // TODO(holte): Rename RecordSample to RecordString and then rename this
+  // to RecordSample.
+  //
+  // example:
+  // scoped_ptr<Sample> sample = rappor_service->CreateSample(MY_METRIC_TYPE);
+  // sample->SetStringField("Field1", "some string");
+  // sample->SetFlagsValue("Field2", SOME|FLAGS);
+  // rappor_service->RecordSample("MyMetric", sample.Pass());
+  //
+  // This will result in a report setting two metrics "MyMetric.Field1" and
+  // "MyMetric.Field2", and they will both be generated from the same sample,
+  // to allow for correllations to be computed.
+  void RecordSampleObj(const std::string& metric_name,
+                       scoped_ptr<Sample> sample);
+
   // Records a sample of the rappor metric specified by |metric_name|.
   // Creates and initializes the metric, if it doesn't yet exist.
   virtual void RecordSample(const std::string& metric_name,
                             RapporType type,
                             const std::string& sample);
 
   // Registers the names of all of the preferences used by RapporService in the
   // provided PrefRegistry. This should be called before calling Start().
   static void RegisterPrefs(PrefRegistrySimple* registry);
 
@@ skipping 58 matching lines @@
   // A private LogUploader instance for sending reports to the server.
   scoped_ptr<LogUploaderInterface> uploader_;
 
   // What reporting level of metrics are being reported.
   RecordingLevel recording_level_;
 
   // We keep all registered metrics in a map, from name to metric.
   // The map owns the metrics it contains.
   std::map<std::string, RapporMetric*> metrics_map_;
 
+  internal::Sampler sampler_;
+
   DISALLOW_COPY_AND_ASSIGN(RapporService);
 };
 
 }  // namespace rappor
 
 #endif  // COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_