/
BoundInstrument.ts
151 lines (135 loc) · 3.69 KB
/
BoundInstrument.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
/*
* 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 { Aggregator } from './export/types';
/**
* This class represent the base to BoundInstrument, which is responsible for generating
* the TimeSeries.
*/
export class BaseBoundInstrument {
protected _labels: api.Labels;
constructor(
labels: api.Labels,
private readonly _disabled: boolean,
private readonly _valueType: api.ValueType,
private readonly _aggregator: Aggregator
) {
this._labels = labels;
}
update(value: number): void {
if (this._disabled) return;
if (typeof value !== 'number') {
diag.error(
`Metric cannot accept a non-number value for ${Object.values(
this._labels
)}.`
);
return;
}
if (this._valueType === api.ValueType.INT && !Number.isInteger(value)) {
diag.warn(
`INT value type cannot accept a floating-point value for ${Object.values(
this._labels
)}, ignoring the fractional digits.`
);
value = Math.trunc(value);
}
this._aggregator.update(value);
}
getLabels(): api.Labels {
return this._labels;
}
getAggregator(): Aggregator {
return this._aggregator;
}
}
/**
* BoundCounter allows the SDK to observe/record a single metric event. The
* value of single instrument in the `Counter` associated with specified Labels.
*/
export class BoundCounter
extends BaseBoundInstrument
implements api.BoundCounter {
constructor(
labels: api.Labels,
disabled: boolean,
valueType: api.ValueType,
aggregator: Aggregator
) {
super(labels, disabled, valueType, aggregator);
}
add(value: number): void {
if (value < 0) {
diag.error(`Counter cannot descend for ${Object.values(this._labels)}`);
return;
}
this.update(value);
}
}
/**
* BoundUpDownCounter allows the SDK to observe/record a single metric event.
* The value of single instrument in the `UpDownCounter` associated with
* specified Labels.
*/
export class BoundUpDownCounter
extends BaseBoundInstrument
implements api.BoundCounter {
constructor(
labels: api.Labels,
disabled: boolean,
valueType: api.ValueType,
aggregator: Aggregator
) {
super(labels, disabled, valueType, aggregator);
}
add(value: number): void {
this.update(value);
}
}
/**
* BoundMeasure is an implementation of the {@link BoundMeasure} interface.
*/
export class BoundValueRecorder
extends BaseBoundInstrument
implements api.BoundValueRecorder {
constructor(
labels: api.Labels,
disabled: boolean,
valueType: api.ValueType,
aggregator: Aggregator
) {
super(labels, disabled, valueType, aggregator);
}
record(value: number): void {
this.update(value);
}
}
/**
* BoundObserver is an implementation of the {@link BoundObserver} interface.
*/
export class BoundObserver
extends BaseBoundInstrument
implements api.BoundBaseObserver {
constructor(
labels: api.Labels,
disabled: boolean,
valueType: api.ValueType,
aggregator: Aggregator
) {
super(labels, disabled, valueType, aggregator);
}
}