File: background_tracing_metrics_provider.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (70 lines) | stat: -rw-r--r-- 2,616 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_TRACING_COMMON_BACKGROUND_TRACING_METRICS_PROVIDER_H_
#define COMPONENTS_TRACING_COMMON_BACKGROUND_TRACING_METRICS_PROVIDER_H_

#include <vector>

#include "base/functional/callback.h"
#include "components/metrics/metrics_provider.h"
#include "components/tracing/tracing_export.h"
#include "third_party/metrics_proto/system_profile.pb.h"
#include "third_party/metrics_proto/trace_log.pb.h"

namespace tracing {

// Provides trace log metrics collected using BackgroundTracingManager to UMA
// proto. Background tracing uploads metrics of larger size compared to UMA
// histograms and it is better to upload them as independent metrics rather
// than part of UMA histograms log. The background tracing manager will make
// sure the traces are small when uploading over data.
class TRACING_EXPORT BackgroundTracingMetricsProvider
    : public metrics::MetricsProvider {
 public:
  BackgroundTracingMetricsProvider();

  BackgroundTracingMetricsProvider(const BackgroundTracingMetricsProvider&) =
      delete;
  BackgroundTracingMetricsProvider& operator=(
      const BackgroundTracingMetricsProvider&) = delete;

  ~BackgroundTracingMetricsProvider() override;

  std::string RecordSystemProfileMetrics();

  // metrics::MetricsProvider:
  bool HasIndependentMetrics() override;
  void ProvideIndependentMetrics(
      base::OnceClosure serialize_log_callback,
      base::OnceCallback<void(bool)> done_callback,
      metrics::ChromeUserMetricsExtension* uma_proto,
      base::HistogramSnapshotManager* snapshot_manager) override;
  void Init() override;

 protected:
  // Embedders can override this to do any additional processing of the log
  // before it is sent. This includes processing of the trace itself (e.g.
  // compression).
  virtual base::OnceCallback<bool(metrics::ChromeUserMetricsExtension*,
                                  std::string&&)>
  GetEmbedderMetricsProvider();

  virtual void DoInit() = 0;

  virtual void RecordCoreSystemProfileMetrics(
      metrics::SystemProfileProto* system_profile_proto) = 0;

  // Writes |serialized_trace| into |logs|'s |raw_data| field.
  static void SetTrace(metrics::TraceLog* log, std::string&& serialized_trace);

  std::vector<std::unique_ptr<metrics::MetricsProvider>>
      system_profile_providers_;

  base::WeakPtrFactory<BackgroundTracingMetricsProvider> weak_factory_{this};
};

}  // namespace tracing

#endif  // COMPONENTS_TRACING_COMMON_BACKGROUND_TRACING_METRICS_PROVIDER_H_