/
Meter.ts
355 lines (336 loc) · 10.6 KB
/
Meter.ts
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
/*
* Copyright The OpenTelemetry Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { diag } from '@opentelemetry/api';
import * as api from '@opentelemetry/api-metrics';
import { InstrumentationLibrary } from '@opentelemetry/core';
import { Resource } from '@opentelemetry/resources';
import { BatchObserver } from './BatchObserver';
import { BaseBoundInstrument } from './BoundInstrument';
import { CounterMetric } from './CounterMetric';
import { PushController } from './export/Controller';
import { NoopExporter } from './export/NoopExporter';
import { Processor, UngroupedProcessor } from './export/Processor';
import { Metric } from './Metric';
import { SumObserverMetric } from './SumObserverMetric';
import { DEFAULT_CONFIG, DEFAULT_METRIC_OPTIONS, MeterConfig } from './types';
import { UpDownCounterMetric } from './UpDownCounterMetric';
import { UpDownSumObserverMetric } from './UpDownSumObserverMetric';
import { ValueObserverMetric } from './ValueObserverMetric';
import { ValueRecorderMetric } from './ValueRecorderMetric';
// eslint-disable-next-line @typescript-eslint/no-var-requires
const merge = require('lodash.merge');
/**
* Meter is an implementation of the {@link Meter} interface.
*/
export class Meter implements api.Meter {
private readonly _batchObservers: BatchObserver[] = [];
private readonly _metrics = new Map<string, Metric<BaseBoundInstrument>>();
private readonly _processor: Processor;
private readonly _resource: Resource;
private readonly _instrumentationLibrary: InstrumentationLibrary;
private readonly _controller: PushController;
private _isShutdown = false;
private _shuttingDownPromise: Promise<void> = Promise.resolve();
/**
* Constructs a new Meter instance.
*/
constructor(
instrumentationLibrary: InstrumentationLibrary,
config: MeterConfig = {}
) {
const mergedConfig = merge({}, DEFAULT_CONFIG, config);
this._processor = mergedConfig.processor ?? new UngroupedProcessor();
this._resource =
mergedConfig.resource || Resource.empty();
this._instrumentationLibrary = instrumentationLibrary;
// start the push controller
const exporter = mergedConfig.exporter || new NoopExporter();
const interval = mergedConfig.interval;
this._controller = new PushController(this, exporter, interval);
}
/**
* Creates and returns a new {@link ValueRecorder}.
* @param name the name of the metric.
* @param [options] the metric options.
*/
createValueRecorder(
name: string,
options?: api.MetricOptions
): api.ValueRecorder {
if (!this._isValidName(name)) {
diag.warn(
`Invalid metric name ${name}. Defaulting to noop metric implementation.`
);
return api.NOOP_VALUE_RECORDER_METRIC;
}
const opt: api.MetricOptions = {
...DEFAULT_METRIC_OPTIONS,
...options,
};
const valueRecorder = new ValueRecorderMetric(
name,
opt,
this._processor,
this._resource,
this._instrumentationLibrary
);
this._registerMetric(name, valueRecorder);
return valueRecorder;
}
/**
* Creates a new counter metric. Generally, this kind of metric when the
* value is a quantity, the sum is of primary interest, and the event count
* and value distribution are not of primary interest.
* @param name the name of the metric.
* @param [options] the metric options.
*/
createCounter(name: string, options?: api.MetricOptions): api.Counter {
if (!this._isValidName(name)) {
diag.warn(
`Invalid metric name ${name}. Defaulting to noop metric implementation.`
);
return api.NOOP_COUNTER_METRIC;
}
const opt: api.MetricOptions = {
...DEFAULT_METRIC_OPTIONS,
...options,
};
const counter = new CounterMetric(
name,
opt,
this._processor,
this._resource,
this._instrumentationLibrary
);
this._registerMetric(name, counter);
return counter;
}
/**
* Creates a new `UpDownCounter` metric. UpDownCounter is a synchronous
* instrument and very similar to Counter except that Add(increment)
* supports negative increments. It is generally useful for capturing changes
* in an amount of resources used, or any quantity that rises and falls
* during a request.
*
* @param name the name of the metric.
* @param [options] the metric options.
*/
createUpDownCounter(
name: string,
options?: api.MetricOptions
): api.UpDownCounter {
if (!this._isValidName(name)) {
diag.warn(
`Invalid metric name ${name}. Defaulting to noop metric implementation.`
);
return api.NOOP_COUNTER_METRIC;
}
const opt: api.MetricOptions = {
...DEFAULT_METRIC_OPTIONS,
...options,
};
const upDownCounter = new UpDownCounterMetric(
name,
opt,
this._processor,
this._resource,
this._instrumentationLibrary
);
this._registerMetric(name, upDownCounter);
return upDownCounter;
}
/**
* Creates a new `ValueObserver` metric.
* @param name the name of the metric.
* @param [options] the metric options.
* @param [callback] the value observer callback
*/
createValueObserver(
name: string,
options: api.MetricOptions = {},
callback?: (observerResult: api.ObserverResult) => unknown
): api.ValueObserver {
if (!this._isValidName(name)) {
diag.warn(
`Invalid metric name ${name}. Defaulting to noop metric implementation.`
);
return api.NOOP_VALUE_OBSERVER_METRIC;
}
const opt: api.MetricOptions = {
...DEFAULT_METRIC_OPTIONS,
...options,
};
const valueObserver = new ValueObserverMetric(
name,
opt,
this._processor,
this._resource,
this._instrumentationLibrary,
callback
);
this._registerMetric(name, valueObserver);
return valueObserver;
}
createSumObserver(
name: string,
options: api.MetricOptions = {},
callback?: (observerResult: api.ObserverResult) => unknown
): api.SumObserver {
if (!this._isValidName(name)) {
diag.warn(
`Invalid metric name ${name}. Defaulting to noop metric implementation.`
);
return api.NOOP_SUM_OBSERVER_METRIC;
}
const opt: api.MetricOptions = {
...DEFAULT_METRIC_OPTIONS,
...options,
};
const sumObserver = new SumObserverMetric(
name,
opt,
this._processor,
this._resource,
this._instrumentationLibrary,
callback
);
this._registerMetric(name, sumObserver);
return sumObserver;
}
/**
* Creates a new `UpDownSumObserver` metric.
* @param name the name of the metric.
* @param [options] the metric options.
* @param [callback] the value observer callback
*/
createUpDownSumObserver(
name: string,
options: api.MetricOptions = {},
callback?: (observerResult: api.ObserverResult) => unknown
): api.UpDownSumObserver {
if (!this._isValidName(name)) {
diag.warn(
`Invalid metric name ${name}. Defaulting to noop metric implementation.`
);
return api.NOOP_UP_DOWN_SUM_OBSERVER_METRIC;
}
const opt: api.MetricOptions = {
...DEFAULT_METRIC_OPTIONS,
...options,
};
const upDownSumObserver = new UpDownSumObserverMetric(
name,
opt,
this._processor,
this._resource,
this._instrumentationLibrary,
callback
);
this._registerMetric(name, upDownSumObserver);
return upDownSumObserver;
}
/**
* Creates a new batch observer.
* @param callback the batch observer callback
* @param [options] the batch options.
*/
createBatchObserver(
callback: (observerResult: api.BatchObserverResult) => void,
options: api.BatchObserverOptions = {}
): BatchObserver {
const opt: api.BatchObserverOptions = {
...options,
};
const batchObserver = new BatchObserver(opt, callback);
this._batchObservers.push(batchObserver);
return batchObserver;
}
/**
* Collects all the metrics created with this `Meter` for export.
*
* Utilizes the processor to create checkpoints of the current values in
* each aggregator belonging to the metrics that were created with this
* meter instance.
*/
async collect(): Promise<void> {
// call batch observers first
const observations = this._batchObservers.map(observer => {
return observer.collect();
});
await Promise.all(observations);
// after this all remaining metrics can be run
const metricsRecords = Array.from(this._metrics.values()).map(metric => {
return metric.getMetricRecord();
});
await Promise.all(metricsRecords).then(records => {
records.forEach(metrics => {
metrics.forEach(metric => this._processor.process(metric));
});
});
}
getProcessor(): Processor {
return this._processor;
}
shutdown(): Promise<void> {
if (this._isShutdown) {
return this._shuttingDownPromise;
}
this._isShutdown = true;
this._shuttingDownPromise = new Promise((resolve, reject) => {
Promise.resolve()
.then(() => {
return this._controller.shutdown();
})
.then(resolve)
.catch(e => {
reject(e);
});
});
return this._shuttingDownPromise;
}
/**
* Registers metric to register.
* @param name The name of the metric.
* @param metric The metric to register.
*/
private _registerMetric<T extends BaseBoundInstrument>(
name: string,
metric: Metric<T>
): void {
if (this._metrics.has(name)) {
diag.error(`A metric with the name ${name} has already been registered.`);
return;
}
this._metrics.set(name, metric);
}
/**
* Ensure a metric name conforms to the following rules:
*
* 1. They are non-empty strings
*
* 2. The first character must be non-numeric, non-space, non-punctuation
*
* 3. Subsequent characters must be belong to the alphanumeric characters,
* '_', '.', and '-'.
*
* Names are case insensitive
*
* @param name Name of metric to be created
*/
private _isValidName(name: string): boolean {
return Boolean(name.match(/^[a-z][a-z0-9_.-]*$/i));
}
}