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
|
// 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_STRUCTURED_METRICS_CLIENT_H_
#define COMPONENTS_METRICS_STRUCTURED_STRUCTURED_METRICS_CLIENT_H_
#include "base/component_export.h"
#include "base/memory/raw_ptr.h"
#include "base/no_destructor.h"
#include "build/buildflag.h"
#include "components/metrics/structured/event.h"
namespace metrics::structured {
// Singleton to interact with StructuredMetrics.
//
// It allows a delegate to be set to control the recording logic as different
// embedders have different requirements (ie ash vs lacros).
class COMPONENT_EXPORT(METRICS_STRUCTURED) StructuredMetricsClient {
public:
class RecordingDelegate {
public:
virtual ~RecordingDelegate() = default;
// Return true when the delegate is ready to write events.
virtual bool IsReadyToRecord() const = 0;
// Recording logic.
virtual void RecordEvent(Event&& event) = 0;
};
StructuredMetricsClient(const StructuredMetricsClient& client) = delete;
StructuredMetricsClient& operator=(const StructuredMetricsClient& client) =
delete;
// Windows errors out with dllexport class cannot be applied to member of
// dllexport class.
#if BUILDFLAG(IS_WIN)
// Provides access to global StructuredMetricsClient instance to record
// metrics. This is typically used in the codegen.
static StructuredMetricsClient* Get();
// Records |event| using singleton from Get().
static void Record(Event&& event);
#else
// Provides access to global StructuredMetricsClient instance to record
// metrics. This is typically used in the codegen.
static COMPONENT_EXPORT(METRICS_STRUCTURED) StructuredMetricsClient* Get();
// Records |event| using singleton from Get().
static COMPONENT_EXPORT(METRICS_STRUCTURED) void Record(Event&& event);
#endif // BUILDFLAG(IS_WIN)
// Sets the delegate for the client's recording logic. Should be called before
// anything else. |this| does not take ownership of |delegate| and assumes
// that the caller will properly manage the lifetime of delegate and call
// |UnsetDelegate| before |delegate| is destructed.
void SetDelegate(RecordingDelegate* delegate);
void UnsetDelegate();
private:
friend class base::NoDestructor<StructuredMetricsClient>;
// Forwards to |delegate_|. If no delegate has been set, then no-op.
void RecordEvent(Event&& event);
StructuredMetricsClient();
~StructuredMetricsClient();
// Not owned. Assumes that the delegate's lifetime will exceed |this|.
raw_ptr<RecordingDelegate> delegate_ = nullptr;
};
} // namespace metrics::structured
#endif // COMPONENTS_METRICS_STRUCTURED_STRUCTURED_METRICS_CLIENT_H_
|
