components/ukm/ukm_reporting_service.h

   1 // Copyright 2017 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 // This file defines a service that sends ukm logs to a server.
   6
   7 #ifndef COMPONENTS_UKM_UKM_REPORTING_SERVICE_H_
   8 #define COMPONENTS_UKM_UKM_REPORTING_SERVICE_H_
   9
  10 #include <stdint.h>
  11
  12 #include <string>
  13
  14 #include "base/macros.h"
  15 #include "components/metrics/persisted_logs.h"
  16 #include "components/metrics/reporting_service.h"
  17
  18 class PrefService;
  19 class PrefRegistrySimple;
  20
  21 namespace metrics {
  22 class MetricsServiceClient;
  23 }
  24
  25 namespace ukm {
  26
  27 // A service that uploads logs to the UKM server.
  28 class UkmReportingService : public metrics::ReportingService {
  29  public:
  30   // Creates the UkmReportingService with the given |client|, and
  31   // |local_state|.  Does not take ownership of the paramaters; instead stores
  32   // a weak pointer to each. Caller should ensure that the parameters are valid
  33   // for the lifetime of this class.
  34   UkmReportingService(metrics::MetricsServiceClient* client,
  35                       PrefService* local_state);
  36   ~UkmReportingService() override;
  37
  38   // At startup, prefs needs to be called with a list of all the pref names and
  39   // types we'll be using.
  40   static void RegisterPrefs(PrefRegistrySimple* registry);
  41
  42   metrics::PersistedLogs* ukm_log_store() { return &persisted_logs_; }
  43   const metrics::PersistedLogs* ukm_log_store() const {
  44     return &persisted_logs_;
  45   }
  46
  47  private:
  48   // metrics:ReportingService:
  49   metrics::LogStore* log_store() override;
  50   std::string GetUploadUrl() const override;
  51   // Returns an empty string since retrying over HTTP is not enabled for UKM
  52   std::string GetInsecureUploadUrl() const override;
  53   base::StringPiece upload_mime_type() const override;
  54   metrics::MetricsLogUploader::MetricServiceType service_type() const override;
  55   void LogCellularConstraint(bool upload_canceled) override;
  56   void LogResponseOrErrorCode(int response_code,
  57                               int error_code,
  58                               bool was_https) override;
  59   void LogSuccess(size_t log_size) override;
  60   void LogLargeRejection(size_t log_size) override;
  61
  62   metrics::PersistedLogs persisted_logs_;
  63
  64   DISALLOW_COPY_AND_ASSIGN(UkmReportingService);
  65 };
  66
  67 }  // namespace ukm
  68
  69 #endif  // COMPONENTS_UKM_UKM_REPORTING_SERVICE_H_