File: suspend_perf_reporter.cc

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 (125 lines) | stat: -rw-r--r-- 4,717 bytes parent folder | download | duplicates (5)
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/ash/power/suspend_perf_reporter.h"

#include <string>
#include <vector>

#include "base/functional/bind.h"
#include "base/logging.h"
#include "base/metrics/dummy_histogram.h"
#include "base/metrics/histogram.h"
#include "base/metrics/histogram_base.h"
#include "base/metrics/statistics_recorder.h"
#include "base/strings/strcat.h"

namespace ash {

namespace {

constexpr base::TimeDelta kDelayBetweenSnapshot = base::Minutes(1);

constexpr char kAfterResumeMetricSuffix[] = ".1MinAfterResume";

// UMA metrics to collect for 1 minutes after resuming the device.
//
// The metrics to take snapshots should satisfy these conditions.
//
// * The metrics should be submitted frequently enough in the 1 minute window.
// * The metrics should be submitted on the browser process mainly.
//   `HistogramBase::SnapshotSamples()` may not contains samples of
//   sub-processes depending on the timing.
static const constexpr std::string_view kMetricNames[] = {
    // Browser.MainThreadsCongestion is submitted every 30 seconds on the
    // browser process. At least 1 data point is collected in 1 minute window.
    "Browser.MainThreadsCongestion",
    // Ash.EventLatency.MousePressed.TotalLatency is submitted on the main
    // thread of the browser process every frame drop which is frequent enough.
    "Ash.EventLatency.MousePressed.TotalLatency",
    // The characteristcs of Ash.EventLatency.KeyPressed.TotalLatency is the
    // same as Ash.EventLatency.MousePressed.TotalLatency.
    "Ash.EventLatency.KeyPressed.TotalLatency",
    // Graphics.Smoothness.PercentDroppedFrames3.AllAnimations is submitted
    // every 100 frames which is less than 2 seconds if it is 60fps.
    // This is mainly submitted on the main thread of the browser process, but
    // renderer process can submit.
    "Graphics.Smoothness.PercentDroppedFrames3.AllAnimations",
    // The characteristcs of
    // Graphics.Smoothness.PercentDroppedFrames3.AllInteractions is the same as
    // Graphics.Smoothness.PercentDroppedFrames3.AllAnimations.
    "Graphics.Smoothness.PercentDroppedFrames3.AllInteractions"};

struct MetricsSnapshot {
  std::string_view histogram_name;
  std::unique_ptr<base::HistogramSamples> samples;
};

void OneMinuteAfterResume(std::vector<MetricsSnapshot> snapshots) {
  DCHECK(snapshots.size() == std::size(kMetricNames));

  for (auto& snapshot : snapshots) {
    base::HistogramBase* histogram_base =
        base::StatisticsRecorder::FindHistogram(snapshot.histogram_name);
    if (!histogram_base) {
      continue;
    }

    switch (histogram_base->GetHistogramType()) {
      case base::HistogramType::HISTOGRAM:
      case base::HistogramType::LINEAR_HISTOGRAM:
      case base::HistogramType::BOOLEAN_HISTOGRAM:
      case base::HistogramType::CUSTOM_HISTOGRAM:
        // These 4 histogram types inherit base::Histogram.
        break;
      default:
        DLOG(FATAL) << "SuspendPerfReporter does not support histogram type of "
                    << snapshot.histogram_name;
        continue;
    }
    base::Histogram* histogram = static_cast<base::Histogram*>(histogram_base);

    std::unique_ptr<base::HistogramSamples> samples =
        histogram->SnapshotSamples();
    samples->Subtract(*snapshot.samples.get());

    base::Histogram::FactoryGet(
        base::StrCat({snapshot.histogram_name, kAfterResumeMetricSuffix}),
        histogram->declared_min(), histogram->declared_max(),
        histogram->bucket_count(),
        base::HistogramBase::Flags::kUmaTargetedHistogramFlag)
        ->AddSamples(*samples.get());
  }
}

}  // namespace

SuspendPerfReporter::SuspendPerfReporter(
    chromeos::PowerManagerClient* power_manager_client) {
  observation_.Observe(power_manager_client);
}

SuspendPerfReporter::~SuspendPerfReporter() = default;

void SuspendPerfReporter::SuspendDone(base::TimeDelta duration) {
  DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);

  std::vector<MetricsSnapshot> snapshot_samples;
  for (auto& histogram_name : kMetricNames) {
    base::HistogramBase* histogram =
        base::StatisticsRecorder::FindHistogram(histogram_name);
    if (!histogram) {
      histogram = base::DummyHistogram::GetInstance();
    }
    snapshot_samples.push_back({histogram_name, histogram->SnapshotSamples()});
  }

  // Note: If user suspends and resumes the device again in a minute, the
  // previous metrics is replaced with the new data.
  timer_.Start(
      FROM_HERE, kDelayBetweenSnapshot,
      base::BindOnce(&OneMinuteAfterResume, std::move(snapshot_samples)));
}

}  // namespace ash