components/metrics/structured/structured_metrics_provider.cc

// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "components/metrics/structured/structured_metrics_provider.h"

#include <sstream>
#include <utility>

#include "base/logging.h"
#include "base/metrics/histogram_macros.h"
#include "base/task/current_thread.h"
#include "components/metrics/structured/histogram_util.h"
#include "components/metrics/structured/structured_metrics_features.h"
#include "third_party/metrics_proto/chrome_user_metrics_extension.pb.h"

namespace metrics::structured {
namespace {

using ::metrics::ChromeUserMetricsExtension;
using ::metrics::SystemProfileProto;

}  // namespace

StructuredMetricsProvider::StructuredMetricsProvider(
    raw_ptr<StructuredMetricsRecorder> structured_metrics_recorder)
    : StructuredMetricsProvider(base::Minutes(GetUploadCadenceMinutes()),
                                structured_metrics_recorder) {}

StructuredMetricsProvider::StructuredMetricsProvider(
    base::TimeDelta min_independent_metrics_interval,
    raw_ptr<StructuredMetricsRecorder> structured_metrics_recorder)
    : min_independent_metrics_interval_(min_independent_metrics_interval),
      structured_metrics_recorder_(structured_metrics_recorder) {
  DCHECK(structured_metrics_recorder_);
}

StructuredMetricsProvider::~StructuredMetricsProvider() = default;

void StructuredMetricsProvider::Purge() {
  recorder().Purge();
}

void StructuredMetricsProvider::OnRecordingEnabled() {
  recording_enabled_ = true;
  recorder().EnableRecording();
}

void StructuredMetricsProvider::OnRecordingDisabled() {
  recording_enabled_ = false;
  recorder().DisableRecording();
}

void StructuredMetricsProvider::ProvideCurrentSessionData(
    ChromeUserMetricsExtension* uma_proto) {
  DCHECK(base::CurrentUIThread::IsSet());
  // When StructuredMetricsService is enabled then the StructuredMetricsProvider
  // will not upload metrics.
  if (base::FeatureList::IsEnabled(kEnabledStructuredMetricsService)) {
    return;
  }
  recorder().ProvideUmaEventMetrics(*uma_proto);
}

bool StructuredMetricsProvider::HasIndependentMetrics() {
  // If the StructuredMetricsService is enabled then we should not upload using
  // |this|. When enabled this function will always return false, resulting in
  // ProviderIndependentMetrics never being called.
  if (base::FeatureList::IsEnabled(kEnabledStructuredMetricsService)) {
    return false;
  }

  if (!IsIndependentMetricsUploadEnabled()) {
    return false;
  }

  if (!recorder().CanProvideMetrics()) {
    return false;
  }

  if (base::Time::Now() - last_provided_independent_metrics_ <
      min_independent_metrics_interval_) {
    return false;
  }

  return recorder().event_storage()->HasEvents();
}

void StructuredMetricsProvider::ProvideIndependentMetrics(
    base::OnceClosure serialize_log_callback,
    base::OnceCallback<void(bool)> done_callback,
    ChromeUserMetricsExtension* uma_proto,
    base::HistogramSnapshotManager*) {
  DCHECK(base::CurrentUIThread::IsSet());

  // When StructuredMetricsService is enabled then the StructuredMetricsProvider
  // will not upload metrics.
  if (base::FeatureList::IsEnabled(kEnabledStructuredMetricsService)) {
    NOTREACHED();
    std::move(done_callback).Run(false);
    return;
  }

  if (!recording_enabled_) {
    std::move(done_callback).Run(false);
    return;
  }

  last_provided_independent_metrics_ = base::Time::Now();

  recorder().ProvideEventMetrics(*uma_proto);

  // Independent events should not be associated with the client_id, so clear
  // it.
  uma_proto->clear_client_id();

  // Do not call |serialize_log_callback| on a background thread here because
  // ProvideEventMetrics() above has already removed the data from disk. Doing
  // so could imply data loss, e.g. if |done_callback| is never posted back due
  // to the user shutting down the browser (so the log is never stored).

  std::move(done_callback).Run(true);
}

}  // namespace metrics::structured