Multi-dimension rappor metrics

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_metric.h"
 #include "components/rappor/rappor_parameters.h"
 
 class PrefRegistrySimple;
 class PrefService;
 
 namespace net {
 class URLRequestContextGetter;
 }
 
 namespace rappor {
 
 class LogUploaderInterface;
 class RapporMetric;
 class RapporReports;
 
 // The type of data stored in a metric.
 enum RapporType {
   // For sampling the eTLD+1 of a URL.
   ETLD_PLUS_ONE_RAPPOR_TYPE = 0,
   COARSE_RAPPOR_TYPE,
+  SB_STRING_W_FLAGS_TYPE,

[Alexei Svitkine (slow), 2015/04/09 21:25:03]

Please comment these - also I don't understand this - what is the "W"? is it
"WITH" or does it stand for something else? I actually suggest spelling out the
acronyms.

[Steven Holte, 2015/04/14 20:07:38]

Renamed, this and the other metrics, to be more consistent, and understandable.

   NUM_RAPPOR_TYPES
 };
 
 // This class provides an interface for recording samples for rappor metrics,
 // and periodically generates and uploads reports based on the collected data.
 class RapporService {
  public:
   // Constructs a RapporService.
   // Calling code is responsible for ensuring that the lifetime of
   // |pref_service| is longer than the lifetime of RapporService.
@@ skipping 15 matching lines @@
   // 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);
 
   // 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);
 
+  void RecordStringAndFlags(const std::string& metric_name,
+                                         RapporType type,

[Alexei Svitkine (slow), 2015/04/09 21:25:03]

Nit: Align and add a comment.

[Steven Holte, 2015/04/14 20:07:38]

Done.

+                                         const std::string& str,
+                                         uint64_t flags);

[Alexei Svitkine (slow), 2015/04/09 21:25:03]

Are you planning to add rappor.xml mechanism for specifying the flags values?

[Steven Holte, 2015/04/14 20:07:38]

Done.

+
   // 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);
 
  protected:
   // Initializes the state of the RapporService.
   void InitializeInternal(scoped_ptr<LogUploaderInterface> uploader,
                           int32_t cohort,
                           const std::string& secret);
 
@@ skipping 10 matching lines @@
   // the internal map. Exposed for tests. Returns true if any metrics were
   // recorded.
   bool ExportMetrics(RapporReports* reports);
 
  private:
   // Records a sample of the rappor metric specified by |parameters|.
   // Creates and initializes the metric, if it doesn't yet exist.
   // Exposed for tests.
   void RecordSampleInternal(const std::string& metric_name,
                             const RapporParameters& parameters,
-                            const std::string& sample);
+                            const Sample& sample);
 
   // Checks if the service has been started successfully.
   bool IsInitialized() const;
 
   // Called whenever the logging interval elapses to generate a new log of
   // reports and pass it to the uploader.
   void OnLogInterval();
 
   // Finds a metric in the metrics_map_, creating it if it doesn't already
   // exist.
@@ skipping 27 matching lines @@
   // 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_;
 
   DISALLOW_COPY_AND_ASSIGN(RapporService);
 };
 
 }  // namespace rappor
 
 #endif  // COMPONENTS_RAPPOR_RAPPOR_SERVICE_H_