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 2021 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_METRICS_STRUCTURED_EVENT_H_
#define COMPONENTS_METRICS_STRUCTURED_EVENT_H_
#include <map>
#include <memory>
#include <string>
#include "base/time/time.h"
#include "base/values.h"
#include "components/metrics/structured/enums.h"
// Builder classes for sending events are generated in
// //components/metrics/structured/structured_events.h based on XML
// configuration.
namespace metrics::structured {
// Event to be built and sent by StructuredMetrics clients. Builder
// classes will be codegen'd from metrics definitions in structured.xml, but
// clients may choose to use this class directly to build Events.
class Event {
public:
// There should be a 1-1 mapping between MetricType and the mojom enums.
//
// TODO(jongahn): Move this into common enum file.
enum class MetricType {
kHmac = 0,
kLong = 1,
kInt = 2,
kDouble = 3,
kRawString = 4,
kBoolean = 5,
};
// Holds the value and the type of the metric encoded.
struct MetricValue {
MetricValue() = default;
MetricValue(MetricType type, base::Value value);
MetricValue(MetricValue&& other);
MetricValue& operator=(MetricValue&& other);
bool operator==(const MetricValue& rhs) const;
~MetricValue();
MetricType type;
base::Value value;
};
Event();
Event(const std::string& project_name, const std::string& event_name);
Event(Event&& other);
Event& operator=(Event&& other);
virtual ~Event();
virtual bool IsCrOSEvent() const;
Event Clone() const;
// Records |this|. Once this method is called, |this| will be unsafe to
// access.
void Record();
// Returns true if the value was added successfully. |type| and type of
// |value| must be consistent and will be enforced. If the data in |value| and
// |type| do match, then |value| will be moved into |this| when called.
bool AddMetric(const std::string& metric_name,
MetricType type,
base::Value&& value);
const std::string& project_name() const;
const std::string& event_name() const;
const std::map<std::string, MetricValue>& metric_values() const;
base::TimeDelta recorded_time_since_boot() const;
private:
std::string project_name_;
std::string event_name_;
std::map<std::string, MetricValue> metric_values_;
// Explicitly set the system uptime.
void SetRecordedTimeSinceBoot(base::TimeDelta recorded_time_since_boot);
// System uptime for which the event was recorded.
base::TimeDelta recorded_time_since_boot_;
};
} // namespace metrics::structured
#endif // COMPONENTS_METRICS_STRUCTURED_EVENT_H_
|
