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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_glean_Labeled_h
#define mozilla_glean_Labeled_h
#include "nsISupports.h"
#include "nsWrapperCache.h"
#include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/glean/bindings/Boolean.h"
#include "mozilla/glean/bindings/Counter.h"
#include "mozilla/glean/bindings/GleanMetric.h"
#include "mozilla/glean/bindings/ScalarGIFFTMap.h"
#include "mozilla/glean/bindings/String.h"
#include "mozilla/glean/fog_ffi_generated.h"
enum class DynamicLabel : uint16_t;
namespace mozilla::glean {
namespace impl {
template <typename T, typename E>
class Labeled {
public:
constexpr explicit Labeled<T, E>(uint32_t id) : mId(id) {}
/**
* Gets a specific metric for a given label.
*
* If a set of acceptable labels were specified in the `metrics.yaml` file,
* and the given label is not in the set, it will be recorded under the
* special `OTHER_LABEL` label.
*
* If a set of acceptable labels was not specified in the `metrics.yaml` file,
* only the first 16 unique labels will be used.
* After that, any additional labels will be recorded under the special
* `OTHER_LABEL` label.
*
* @param aLabel - a snake_case string under 30 characters in length,
* otherwise the metric will be recorded under the special
* `OTHER_LABEL` label and an error will be recorded.
*/
T Get(const nsACString& aLabel) const;
/**
* Gets a specific metric for a given label, using the label's enum variant.
*
* @param aLabel - a variant of this label's label enum.
*/
T EnumGet(E aLabel) const;
private:
const uint32_t mId;
};
static inline void UpdateLabeledMirror(Telemetry::ScalarID aMirrorId,
uint32_t aSubmetricId,
const nsACString& aLabel) {
GetLabeledMirrorLock().apply([&](const auto& lock) {
auto tuple = std::make_tuple<Telemetry::ScalarID, nsString>(
std::move(aMirrorId), NS_ConvertUTF8toUTF16(aLabel));
lock.ref()->InsertOrUpdate(aSubmetricId, std::move(tuple));
});
}
template <typename E>
class Labeled<BooleanMetric, E> {
public:
constexpr explicit Labeled(uint32_t id) : mId(id) {}
BooleanMetric Get(const nsACString& aLabel) const {
auto submetricId = fog_labeled_boolean_get(mId, &aLabel);
// If this labeled metric is mirrored, we need to map the submetric id back
// to the label string and mirrored scalar so we can mirror its operations.
auto mirrorId = ScalarIdForMetric(mId);
if (mirrorId) {
UpdateLabeledMirror(mirrorId.extract(), submetricId, aLabel);
}
return BooleanMetric(submetricId);
}
BooleanMetric EnumGet(E aLabel) const {
auto submetricId =
fog_labeled_boolean_enum_get(mId, static_cast<uint16_t>(aLabel));
auto mirrorId = ScalarIdForMetric(mId);
if (mirrorId) {
// Telemetry's keyed scalars operate on (16-bit) strings,
// so we're going to need the string for this enum.
nsCString label;
fog_labeled_enum_to_str(mId, static_cast<uint16_t>(aLabel), &label);
UpdateLabeledMirror(mirrorId.extract(), submetricId, label);
}
return BooleanMetric(submetricId);
}
private:
const uint32_t mId;
};
template <typename E>
class Labeled<CounterMetric, E> {
public:
constexpr explicit Labeled(uint32_t id) : mId(id) {}
CounterMetric Get(const nsACString& aLabel) const {
auto submetricId = fog_labeled_counter_get(mId, &aLabel);
// If this labeled metric is mirrored, we need to map the submetric id back
// to the label string and mirrored scalar so we can mirror its operations.
auto mirrorId = ScalarIdForMetric(mId);
if (mirrorId) {
UpdateLabeledMirror(mirrorId.extract(), submetricId, aLabel);
}
return CounterMetric(submetricId);
}
CounterMetric EnumGet(E aLabel) const {
auto submetricId =
fog_labeled_counter_enum_get(mId, static_cast<uint16_t>(aLabel));
auto mirrorId = ScalarIdForMetric(mId);
if (mirrorId) {
// Telemetry's keyed scalars operate on (16-bit) strings,
// so we're going to need the string for this enum.
nsCString label;
fog_labeled_enum_to_str(mId, static_cast<uint16_t>(aLabel), &label);
UpdateLabeledMirror(mirrorId.extract(), submetricId, label);
}
return CounterMetric(submetricId);
}
private:
const uint32_t mId;
};
template <typename E>
class Labeled<StringMetric, E> {
public:
constexpr explicit Labeled(uint32_t id) : mId(id) {}
StringMetric Get(const nsACString& aLabel) const {
auto submetricId = fog_labeled_string_get(mId, &aLabel);
// Why no GIFFT map here?
// Labeled Strings can't be mirrored. Telemetry has no compatible probe.
return StringMetric(submetricId);
}
StringMetric EnumGet(E aLabel) const {
auto submetricId =
fog_labeled_string_enum_get(mId, static_cast<uint16_t>(aLabel));
// Why no GIFFT map here?
// Labeled Strings can't be mirrored. Telemetry has no compatible probe.
return StringMetric(submetricId);
}
private:
const uint32_t mId;
};
template <>
class Labeled<BooleanMetric, DynamicLabel> {
public:
constexpr explicit Labeled(uint32_t id) : mId(id) {}
BooleanMetric Get(const nsACString& aLabel) const {
auto submetricId = fog_labeled_boolean_get(mId, &aLabel);
// If this labeled metric is mirrored, we need to map the submetric id back
// to the label string and mirrored scalar so we can mirror its operations.
auto mirrorId = ScalarIdForMetric(mId);
if (mirrorId) {
UpdateLabeledMirror(mirrorId.extract(), submetricId, aLabel);
}
return BooleanMetric(submetricId);
}
BooleanMetric EnumGet(DynamicLabel aLabel) const = delete;
private:
const uint32_t mId;
};
template <>
class Labeled<CounterMetric, DynamicLabel> {
public:
constexpr explicit Labeled(uint32_t id) : mId(id) {}
CounterMetric Get(const nsACString& aLabel) const {
auto submetricId = fog_labeled_counter_get(mId, &aLabel);
// If this labeled metric is mirrored, we need to map the submetric id back
// to the label string and mirrored scalar so we can mirror its operations.
auto mirrorId = ScalarIdForMetric(mId);
if (mirrorId) {
UpdateLabeledMirror(mirrorId.extract(), submetricId, aLabel);
}
return CounterMetric(submetricId);
}
CounterMetric EnumGet(DynamicLabel aLabel) const = delete;
private:
const uint32_t mId;
};
template <>
class Labeled<StringMetric, DynamicLabel> {
public:
constexpr explicit Labeled(uint32_t id) : mId(id) {}
StringMetric Get(const nsACString& aLabel) const {
auto submetricId = fog_labeled_string_get(mId, &aLabel);
// Why no GIFFT map here?
// Labeled Strings can't be mirrored. Telemetry has no compatible probe.
return StringMetric(submetricId);
}
StringMetric EnumGet(DynamicLabel aLabel) const = delete;
private:
const uint32_t mId;
};
} // namespace impl
class GleanLabeled final : public GleanMetric {
public:
explicit GleanLabeled(uint32_t aId, uint32_t aTypeId, nsISupports* aParent)
: GleanMetric(aParent), mId(aId), mTypeId(aTypeId) {}
JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override final;
already_AddRefed<GleanMetric> NamedGetter(const nsAString& aName,
bool& aFound);
bool NameIsEnumerable(const nsAString& aName);
void GetSupportedNames(nsTArray<nsString>& aNames);
private:
virtual ~GleanLabeled() = default;
const uint32_t mId;
const uint32_t mTypeId;
};
} // namespace mozilla::glean
#endif /* mozilla_glean_Labeled_h */
|
