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_METRICS_METRICS_SERVICE_CLIENT_H_ 6 #define COMPONENTS_METRICS_METRICS_SERVICE_CLIENT_H_ 7 8 #include <string> 9 10 #include "base/basictypes.h" 11 #include "base/callback_forward.h" 12 #include "base/memory/scoped_ptr.h" 13 #include "base/strings/string16.h" 14 #include "components/metrics/proto/system_profile.pb.h" 15 16 namespace metrics { 17 18 class MetricsLogUploader; 19 20 // An abstraction of operations that depend on the embedder's (e.g. Chrome) 21 // environment. 22 class MetricsServiceClient { 23 public: 24 virtual ~MetricsServiceClient() {} 25 26 // Registers the client id with other services (e.g. crash reporting), called 27 // when metrics recording gets enabled. 28 virtual void SetMetricsClientId(const std::string& client_id) = 0; 29 30 // Whether there's an "off the record" (aka "Incognito") session active. 31 virtual bool IsOffTheRecordSessionActive() = 0; 32 33 // Returns the current application locale (e.g. "en-US"). 34 virtual std::string GetApplicationLocale() = 0; 35 36 // Retrieves the brand code string associated with the install, returning 37 // false if no brand code is available. 38 virtual bool GetBrand(std::string* brand_code) = 0; 39 40 // Returns the release channel (e.g. stable, beta, etc) of the application. 41 virtual SystemProfileProto::Channel GetChannel() = 0; 42 43 // Returns the version of the application as a string. 44 virtual std::string GetVersionString() = 0; 45 46 // Called by the metrics service when a log has been uploaded. 47 virtual void OnLogUploadComplete() = 0; 48 49 // Starts gathering metrics, calling |done_callback| when initial metrics 50 // gathering is complete. 51 virtual void StartGatheringMetrics(const base::Closure& done_callback) = 0; 52 53 // Called prior to a metrics log being closed, allowing the client to collect 54 // extra histograms that will go in that log. Asynchronous API - the client 55 // implementation should call |done_callback| when complete. 56 virtual void CollectFinalMetrics(const base::Closure& done_callback) = 0; 57 58 // Creates a MetricsLogUploader with the specified parameters (see comments on 59 // MetricsLogUploader for details). 60 virtual scoped_ptr<MetricsLogUploader> CreateUploader( 61 const std::string& server_url, 62 const std::string& mime_type, 63 const base::Callback<void(int)>& on_upload_complete) = 0; 64 65 // Returns the name of a key under HKEY_CURRENT_USER that can be used to store 66 // backups of metrics data. Unused except on Windows. 67 virtual base::string16 GetRegistryBackupKey(); 68 }; 69 70 } // namespace metrics 71 72 #endif // COMPONENTS_METRICS_METRICS_SERVICE_CLIENT_H_ 73
