File: usage_telemetry_periodic_collector_base.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 (60 lines) | stat: -rw-r--r-- 2,639 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
// 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_CHROMEOS_REPORTING_USAGE_TELEMETRY_PERIODIC_COLLECTOR_BASE_H_
#define CHROME_BROWSER_CHROMEOS_REPORTING_USAGE_TELEMETRY_PERIODIC_COLLECTOR_BASE_H_

#include <memory>
#include <optional>
#include <string>

#include "base/memory/raw_ptr.h"
#include "base/time/time.h"
#include "components/reporting/metrics/collector_base.h"
#include "components/reporting/metrics/metric_rate_controller.h"
#include "components/reporting/metrics/metric_report_queue.h"
#include "components/reporting/metrics/reporting_settings.h"
#include "components/reporting/metrics/sampler.h"
#include "components/reporting/proto/synced/metric_data.pb.h"

namespace reporting {

// Periodic collector base class implementation that collects and reports usage
// telemetry data originally tracked by the usage observer. Only used by
// standalone components that are meant to be similar to the `PeriodicCollector`
// but only control the collection rate based on the specified policy setting.
// This can also be used to prevent data staleness because usage observers do
// not associate telemetry data with a timestamp today.
class UsageTelemetryPeriodicCollectorBase : public CollectorBase {
 public:
  UsageTelemetryPeriodicCollectorBase(Sampler* sampler,
                                      MetricReportQueue* metric_report_queue,
                                      ReportingSettings* reporting_settings,
                                      const std::string& rate_setting_path,
                                      base::TimeDelta default_rate,
                                      int rate_unit_to_ms = 1);
  UsageTelemetryPeriodicCollectorBase(
      const UsageTelemetryPeriodicCollectorBase& other) = delete;
  UsageTelemetryPeriodicCollectorBase& operator=(
      const UsageTelemetryPeriodicCollectorBase& other) = delete;
  ~UsageTelemetryPeriodicCollectorBase() override;

 private:
  // CollectorBase:
  void OnMetricDataCollected(bool is_event_driven,
                             std::optional<MetricData> metric_data) override;

  // CollectorBase:
  bool CanCollect() const override;

  // `MetricReportQueue` used for enqueueing data collected by the sampler.
  const raw_ptr<MetricReportQueue> metric_report_queue_;

  // Component used to control collection rate based on the policy setting.
  const std::unique_ptr<MetricRateController> rate_controller_;
};

}  // namespace reporting

#endif  // CHROME_BROWSER_CHROMEOS_REPORTING_USAGE_TELEMETRY_PERIODIC_COLLECTOR_BASE_H_