File: ash_structured_metrics_recorder.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (97 lines) | stat: -rw-r--r-- 3,754 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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_METRICS_STRUCTURED_ASH_STRUCTURED_METRICS_RECORDER_H_
#define CHROME_BROWSER_METRICS_STRUCTURED_ASH_STRUCTURED_METRICS_RECORDER_H_

#include <memory>

#include "base/memory/weak_ptr.h"
#include "chrome/browser/metrics/structured/profile_observer.h"
#include "components/metrics/metrics_provider.h"
#include "components/metrics/structured/external_metrics.h"
#include "components/metrics/structured/structured_metrics_recorder.h"
#include "third_party/metrics_proto/structured_data.pb.h"

namespace base {
class FilePath;
}

namespace metrics::structured {

// A Recorder implementation for Ash Chrome.
//
// This implementation uses KeyDataProviderAsh and AshEventStorage for key and
// event handling. This class also provides the interface for external metrics
// from platform2.
//
// Initialization of the StructuredMetricsRecorder is in two phases:
//
// 1. The device events and keys are loaded. Once the keys are loaded, device
// events can be processed.
//
// 2. Once a profile is added, it will load the profiles events and keys. Once
// keys are loaded, profile events can be processed.
//
// 3. Once both keys and events are loaded then AshStructuredMetricsRecorder is
// considered fully initialized.
class AshStructuredMetricsRecorder : public StructuredMetricsRecorder,
                                     public ProfileObserver {
 public:
  explicit AshStructuredMetricsRecorder(
      metrics::MetricsProvider* system_profile_provider);

  void OnExternalMetricsCollected(const EventsProto& events);

  // StructuredMetricsRecorder:
  void EnableRecording() override;
  void DisableRecording() override;
  void ProvideEventMetrics(ChromeUserMetricsExtension& uma_proto) override;
  void AddSequenceMetadata(StructuredEventProto* proto,
                           const Event& event,
                           const ProjectValidator& project_validator,
                           const KeyData& key_data) override;
  void ProvideLogMetadata(ChromeUserMetricsExtension& uma_proto) override;

  // Recorder::RecorderImpl:
  void OnSystemProfileInitialized() override;

  void SetExternalMetricsDirForTest(const base::FilePath& dir);

  // ProfileObserver:
  void ProfileAdded(const Profile& profile) override;

 private:
  friend class base::RefCountedDeleteOnSequence<StructuredMetricsRecorder>;
  friend class base::DeleteHelper<StructuredMetricsRecorder>;
  friend class AshStructuredMetricsRecorderTest;
  ~AshStructuredMetricsRecorder() override;

  AshStructuredMetricsRecorder(
      std::unique_ptr<KeyDataProvider> key_provider,
      std::unique_ptr<EventStorage<StructuredEventProto>> event_storage,
      metrics::MetricsProvider* system_profile_provider);

  void ProvideSystemProfile(SystemProfileProto* system_profile);

  // Whether the system profile has been initialized.
  bool system_profile_initialized_ = false;

  // Note this could be the real ChromeOSSystemProfileProvider now.
  // Interface for providing the SystemProfile to metrics.
  // See chrome/browser/metrics/chrome_metrics_service_client.h
  MayBeDangling<metrics::MetricsProvider> system_profile_provider_;

  // Periodically reports metrics from cros.
  std::unique_ptr<ExternalMetrics> external_metrics_;

  // The number of scans of external metrics that occurred since the last
  // upload. This is only incremented if events were added by the scan.
  int external_metrics_scans_ = 0;

  base::WeakPtrFactory<AshStructuredMetricsRecorder> weak_factory_{this};
};
}  // namespace metrics::structured

#endif  // CHROME_BROWSER_METRICS_STRUCTURED_ASH_STRUCTURED_METRICS_RECORDER_H_