File: periodic_metrics_service.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 (104 lines) | stat: -rw-r--r-- 3,648 bytes parent folder | download | duplicates (3)
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
// 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 CHROME_BROWSER_ASH_APP_MODE_METRICS_PERIODIC_METRICS_SERVICE_H_
#define CHROME_BROWSER_ASH_APP_MODE_METRICS_PERIODIC_METRICS_SERVICE_H_

#include "base/memory/raw_ptr.h"
#include "base/timer/timer.h"
#include "components/prefs/pref_service.h"

namespace ash {

extern const char kKioskRamUsagePercentageHistogram[];
extern const char kKioskSwapUsagePercentageHistogram[];
extern const char kKioskDiskUsagePercentageHistogram[];
extern const char kKioskChromeProcessCountHistogram[];
extern const char kKioskSessionRestartInternetAccessHistogram[];
extern const char kKioskSessionRestartUserActivityHistogram[];
extern const char kKioskInternetAccessInfo[];
extern const char kKioskUserActivity[];

extern const base::TimeDelta kPeriodicMetricsInterval;
extern const base::TimeDelta kFirstIdleTimeout;
extern const base::TimeDelta kRegularIdleTimeout;

// These values are used in UMA metrics. Entries should not be renumbered and
// numeric values should never be reused. Keep in sync with respective enum in
// tools/metrics/histograms/enums.xml
enum class KioskInternetAccessInfo {
  kOnlineAndAppRequiresInternet = 0,
  kOnlineAndAppSupportsOffline = 1,
  kOfflineAndAppRequiresInternet = 2,
  kOfflineAndAppSupportsOffline = 3,
  kMaxValue = kOfflineAndAppSupportsOffline,
};

// These values are used in UMA metrics. Entries should not be renumbered and
// numeric values should never be reused. Keep in sync with respective enum in
// tools/metrics/histograms/enums.xml
enum class KioskUserActivity {
  kActive = 0,
  kIdle = 1,
  kMaxValue = kIdle,
};

class DiskSpaceCalculator;

// This class save and record kiosk UMA metrics every
// `kPeriodicMetricsInterval`.
class PeriodicMetricsService {
 public:
  explicit PeriodicMetricsService(PrefService* prefs);
  PeriodicMetricsService(const PeriodicMetricsService&) = delete;
  PeriodicMetricsService& operator=(const PeriodicMetricsService&) = delete;
  ~PeriodicMetricsService();

  // Record metrics about the previous kiosk session. Should be called in the
  // beginning of the kiosk session and before `StartRecordingPeriodicMetrics`.
  void RecordPreviousSessionMetrics() const;

  void StartRecordingPeriodicMetrics(bool is_offline_enabled);

 private:
  void RecordPeriodicMetrics(const base::TimeDelta& idle_timeout);

  void RecordRamUsage() const;

  void RecordSwapUsage() const;

  void RecordDiskSpaceUsage() const;

  void RecordChromeProcessCount() const;

  void RecordPreviousInternetAccessInfo() const;

  void RecordPreviousUserActivity() const;

  // Save the Internet access info to record
  // `kKioskSessionRestartInternetAccessHistogram` during the next kiosk session
  // start.
  void SaveInternetAccessInfo() const;

  // Save the user activity info to record
  // `kKioskSessionRestartUserActivityHistogram` during the next kiosk session
  // start. The first idle timeout is `kFirstIdleTimeout`, but then when
  // ChromeOS records user activity, it uses `kRegularIdleTimeout`.
  void SaveUserActivity(const base::TimeDelta& idle_timeout) const;

  // Invokes callback to record continuously monitored metrics. Starts when
  // the kiosk session is started.
  base::RepeatingTimer metrics_timer_;

  bool is_offline_enabled_ = true;

  raw_ptr<PrefService> prefs_;

  const std::unique_ptr<DiskSpaceCalculator> disk_space_calculator_;
  base::WeakPtrFactory<PeriodicMetricsService> weak_ptr_factory_{this};
};

}  // namespace ash

#endif  // CHROME_BROWSER_ASH_APP_MODE_METRICS_PERIODIC_METRICS_SERVICE_H_