-
Notifications
You must be signed in to change notification settings - Fork 790
/
sdk.ts
200 lines (169 loc) · 5.9 KB
/
sdk.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
/*
* 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 { ContextManager, TextMapPropagator } from '@opentelemetry/api';
import { metrics } from '@opentelemetry/api-metrics';
import {
InstrumentationOption,
registerInstrumentations
} from '@opentelemetry/instrumentation';
import {
detectResources,
envDetector,
processDetector,
Resource,
ResourceDetectionConfig
} from '@opentelemetry/resources';
import { MeterProvider, MetricReader } from '@opentelemetry/sdk-metrics-base';
import {
BatchSpanProcessor,
SpanProcessor
} from '@opentelemetry/sdk-trace-base';
import { NodeTracerConfig, NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
import { NodeSDKConfiguration } from './types';
/** This class represents everything needed to register a fully configured OpenTelemetry Node.js SDK */
export class NodeSDK {
private _tracerProviderConfig?: {
tracerConfig: NodeTracerConfig;
spanProcessor: SpanProcessor;
contextManager?: ContextManager;
textMapPropagator?: TextMapPropagator;
};
private _instrumentations: InstrumentationOption[];
private _metricReader?: MetricReader;
private _resource: Resource;
private _autoDetectResources: boolean;
private _tracerProvider?: NodeTracerProvider;
private _meterProvider?: MeterProvider;
private _serviceName?: string;
/**
* Create a new NodeJS SDK instance
*/
public constructor(configuration: Partial<NodeSDKConfiguration> = {}) {
this._resource = configuration.resource ?? new Resource({});
this._serviceName = configuration.serviceName;
this._autoDetectResources = configuration.autoDetectResources ?? true;
if (configuration.spanProcessor || configuration.traceExporter) {
const tracerProviderConfig: NodeTracerConfig = {};
if (configuration.sampler) {
tracerProviderConfig.sampler = configuration.sampler;
}
if (configuration.spanLimits) {
tracerProviderConfig.spanLimits = configuration.spanLimits;
}
const spanProcessor =
configuration.spanProcessor ??
new BatchSpanProcessor(configuration.traceExporter!);
this.configureTracerProvider(
tracerProviderConfig,
spanProcessor,
configuration.contextManager,
configuration.textMapPropagator
);
}
if (configuration.metricReader) {
this.configureMeterProvider(configuration.metricReader);
}
let instrumentations: InstrumentationOption[] = [];
if (configuration.instrumentations) {
instrumentations = configuration.instrumentations;
}
this._instrumentations = instrumentations;
}
/** Set configurations required to register a NodeTracerProvider */
public configureTracerProvider(
tracerConfig: NodeTracerConfig,
spanProcessor: SpanProcessor,
contextManager?: ContextManager,
textMapPropagator?: TextMapPropagator
): void {
this._tracerProviderConfig = {
tracerConfig,
spanProcessor,
contextManager,
textMapPropagator,
};
}
/** Set configurations needed to register a MeterProvider */
public configureMeterProvider(reader: MetricReader): void {
this._metricReader = reader;
}
/** Detect resource attributes */
public async detectResources(
config?: ResourceDetectionConfig
): Promise<void> {
const internalConfig: ResourceDetectionConfig = {
detectors: [ envDetector, processDetector],
...config,
};
this.addResource(await detectResources(internalConfig));
}
/** Manually add a resource */
public addResource(resource: Resource): void {
this._resource = this._resource.merge(resource);
}
/**
* Once the SDK has been configured, call this method to construct SDK components and register them with the OpenTelemetry API.
*/
public async start(): Promise<void> {
if (this._autoDetectResources) {
await this.detectResources();
}
this._resource = this._serviceName === undefined
? this._resource
: this._resource.merge(new Resource(
{[SemanticResourceAttributes.SERVICE_NAME]: this._serviceName}
));
if (this._tracerProviderConfig) {
const tracerProvider = new NodeTracerProvider({
...this._tracerProviderConfig.tracerConfig,
resource: this._resource,
});
this._tracerProvider = tracerProvider;
tracerProvider.addSpanProcessor(this._tracerProviderConfig.spanProcessor);
tracerProvider.register({
contextManager: this._tracerProviderConfig.contextManager,
propagator: this._tracerProviderConfig.textMapPropagator,
});
}
if (this._metricReader) {
const meterProvider = new MeterProvider({
resource: this._resource,
});
meterProvider.addMetricReader(this._metricReader);
this._meterProvider = meterProvider;
metrics.setGlobalMeterProvider(meterProvider);
}
registerInstrumentations({
instrumentations: this._instrumentations,
});
}
public shutdown(): Promise<void> {
const promises: Promise<unknown>[] = [];
if (this._tracerProvider) {
promises.push(this._tracerProvider.shutdown());
}
if (this._meterProvider) {
promises.push(this._meterProvider.shutdown());
}
return (
Promise.all(promises)
// return void instead of the array from Promise.all
.then(() => {
})
);
}
}