blob: 1a1e81b3e7da51b031dce69621e488a9300ebea0 [file] [log] [blame]
// 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 <memory>
#include "base/macros.h"
#include "base/metrics/field_trial.h"
#include "base/threading/thread_checker.h"
namespace base {
class FilePath;
namespace metrics {
class MetricsService;
class MetricsServiceClient;
class MetricsStateManager;
namespace rappor {
class RapporServiceImpl;
namespace ukm {
class UkmService;
namespace variations {
class VariationsService;
namespace metrics_services_manager {
class MetricsServicesManagerClient;
// MetricsServicesManager is a helper class for embedders that use the various
// metrics-related services in a Chrome-like fashion: MetricsService (via its
// client), RapporServiceImpl and VariationsService.
class MetricsServicesManager {
// Creates the MetricsServicesManager with the given client.
explicit MetricsServicesManager(
std::unique_ptr<MetricsServicesManagerClient> client);
virtual ~MetricsServicesManager();
// Returns the preferred entropy provider used to seed persistent activities
// based on whether or not metrics reporting is permitted on this client.
// If there's consent to report metrics, this method returns an entropy
// provider that has a high source of entropy, partially based on the client
// ID. Otherwise, it returns an entropy provider that is based on a low
// entropy source.
std::unique_ptr<const base::FieldTrial::EntropyProvider>
// Returns the MetricsService, creating it if it hasn't been created yet (and
// additionally creating the MetricsServiceClient in that case).
metrics::MetricsService* GetMetricsService();
// Returns the RapporServiceImpl, creating it if it hasn't been created yet.
rappor::RapporServiceImpl* GetRapporServiceImpl();
// Returns the UkmService, creating it if it hasn't been created yet.
ukm::UkmService* GetUkmService();
// Returns the VariationsService, creating it if it hasn't been created yet.
variations::VariationsService* GetVariationsService();
// Should be called when a plugin loading error occurs.
void OnPluginLoadingError(const base::FilePath& plugin_path);
// Some embedders use this method to notify the metrics system when a
// renderer process exits unexpectedly.
void OnRendererProcessCrash();
// Update the managed services when permissions for uploading metrics change.
void UpdateUploadPermissions(bool may_upload);
// Update the managed services when permissions for recording/uploading
// metrics change.
void UpdateRapporServiceImpl();
// Returns the MetricsServiceClient, creating it if it hasn't been
// created yet (and additionally creating the MetricsService in that case).
metrics::MetricsServiceClient* GetMetricsServiceClient();
metrics::MetricsStateManager* GetMetricsStateManager();
// Update which services are running to match current permissions.
void UpdateRunningServices();
// Update the state of UkmService to match current permissions.
void UpdateUkmService();
// Update the managed services when permissions for recording/uploading
// metrics change.
void UpdatePermissions(bool current_may_record,
bool current_consent_given,
bool current_may_upload);
// The client passed in from the embedder.
const std::unique_ptr<MetricsServicesManagerClient> client_;
// Ensures that all functions are called from the same thread.
base::ThreadChecker thread_checker_;
// The current metrics reporting setting.
bool may_upload_;
// The current metrics recording setting.
bool may_record_;
// The current metrics setting reflecting if consent was given.
bool consent_given_;
// The MetricsServiceClient. Owns the MetricsService.
std::unique_ptr<metrics::MetricsServiceClient> metrics_service_client_;
// The RapporServiceImpl, for RAPPOR metric uploads.
std::unique_ptr<rappor::RapporServiceImpl> rappor_service_;
// The VariationsService, for server-side experiments infrastructure.
std::unique_ptr<variations::VariationsService> variations_service_;
} // namespace metrics_services_manager