/
CollectorTraceExporter.test.ts
318 lines (280 loc) · 10.2 KB
/
CollectorTraceExporter.test.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
/*
* 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 core from '@opentelemetry/core';
import { ReadableSpan } from '@opentelemetry/tracing';
import * as http from 'http';
import * as assert from 'assert';
import * as sinon from 'sinon';
import { PassThrough, Stream } from 'stream';
import * as zlib from 'zlib';
import {
CollectorTraceExporter,
CollectorExporterNodeConfigBase,
} from '../../src/platform/node';
import * as collectorTypes from '../../src/types';
import { MockedResponse } from './nodeHelpers';
import {
ensureExportTraceServiceRequestIsSet,
ensureSpanIsCorrect,
mockedReadableSpan,
} from '../helper';
let fakeRequest: PassThrough;
const address = 'localhost:1501';
describe('CollectorTraceExporter - node with json over http', () => {
let collectorExporter: CollectorTraceExporter;
let collectorExporterConfig: CollectorExporterNodeConfigBase;
let stubRequest: sinon.SinonStub;
let spans: ReadableSpan[];
afterEach(() => {
fakeRequest = new Stream.PassThrough();
sinon.restore();
});
describe('instance', () => {
it('should warn about metadata when using json', () => {
const metadata = 'foo';
// Need to stub/spy on the underlying logger as the "diag" instance is global
const spyLoggerWarn = sinon.stub(diag, 'warn');
collectorExporter = new CollectorTraceExporter({
serviceName: 'basic-service',
metadata,
url: address,
} as any);
const args = spyLoggerWarn.args[0];
assert.strictEqual(args[0], 'Metadata cannot be set when using http');
});
});
describe('when configuring via environment', () => {
const envSource = process.env;
it('should use url defined in env', () => {
envSource.OTEL_EXPORTER_OTLP_ENDPOINT = 'http://foo.bar';
const collectorExporter = new CollectorTraceExporter();
assert.strictEqual(
collectorExporter.url,
envSource.OTEL_EXPORTER_OTLP_ENDPOINT
);
envSource.OTEL_EXPORTER_OTLP_ENDPOINT = '';
});
it('should override global exporter url with signal url defined in env', () => {
envSource.OTEL_EXPORTER_OTLP_ENDPOINT = 'http://foo.bar';
envSource.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT = 'http://foo.traces';
const collectorExporter = new CollectorTraceExporter();
assert.strictEqual(
collectorExporter.url,
envSource.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
);
envSource.OTEL_EXPORTER_OTLP_ENDPOINT = '';
envSource.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT = '';
});
it('should use headers defined via env', () => {
envSource.OTEL_EXPORTER_OTLP_HEADERS = 'foo=bar';
const collectorExporter = new CollectorTraceExporter();
assert.strictEqual(collectorExporter.headers.foo, 'bar');
envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
});
it('should override global headers config with signal headers defined via env', () => {
envSource.OTEL_EXPORTER_OTLP_HEADERS = 'foo=bar,bar=foo';
envSource.OTEL_EXPORTER_OTLP_TRACES_HEADERS = 'foo=boo';
const collectorExporter = new CollectorTraceExporter();
assert.strictEqual(collectorExporter.headers.foo, 'boo');
assert.strictEqual(collectorExporter.headers.bar, 'foo');
envSource.OTEL_EXPORTER_OTLP_TRACES_HEADERS = '';
envSource.OTEL_EXPORTER_OTLP_HEADERS = '';
});
});
describe('export', () => {
beforeEach(() => {
stubRequest = sinon.stub(http, 'request').returns(fakeRequest as any);
collectorExporterConfig = {
headers: {
foo: 'bar',
},
hostname: 'foo',
attributes: {},
url: 'http://foo.bar.com',
keepAlive: true,
httpAgentOptions: { keepAliveMsecs: 2000 },
};
collectorExporter = new CollectorTraceExporter(collectorExporterConfig);
spans = [];
spans.push(Object.assign({}, mockedReadableSpan));
});
it('should open the connection', done => {
collectorExporter.export(spans, () => { });
setTimeout(() => {
const args = stubRequest.args[0];
const options = args[0];
assert.strictEqual(options.hostname, 'foo.bar.com');
assert.strictEqual(options.method, 'POST');
assert.strictEqual(options.path, '/');
done();
});
});
it('should set custom headers', done => {
collectorExporter.export(spans, () => { });
setTimeout(() => {
const args = stubRequest.args[0];
const options = args[0];
assert.strictEqual(options.headers['foo'], 'bar');
done();
});
});
it('should have keep alive and keepAliveMsecs option set', done => {
collectorExporter.export(spans, () => { });
setTimeout(() => {
const args = stubRequest.args[0];
const options = args[0];
const agent = options.agent;
assert.strictEqual(agent.keepAlive, true);
assert.strictEqual(agent.options.keepAliveMsecs, 2000);
done();
});
});
it('different http export requests should use the same agent', done => {
collectorExporter.export(spans, () => { });
collectorExporter.export(spans, () => { });
setTimeout(() => {
const [firstExportAgent, secondExportAgent] = stubRequest.args.map(
a => a[0].agent
);
assert.strictEqual(firstExportAgent, secondExportAgent);
done();
});
});
it('should successfully send the spans', done => {
collectorExporter.export(spans, () => { });
let buff = Buffer.from('');
fakeRequest.on('end', () => {
const responseBody = buff.toString();
const json = JSON.parse(
responseBody
) as collectorTypes.opentelemetryProto.collector.trace.v1.ExportTraceServiceRequest;
const span1 =
json.resourceSpans[0].instrumentationLibrarySpans[0].spans[0];
assert.ok(typeof span1 !== 'undefined', "span doesn't exist");
if (span1) {
ensureSpanIsCorrect(span1);
}
ensureExportTraceServiceRequestIsSet(json);
done();
});
fakeRequest.on('data', chunk => {
buff = Buffer.concat([buff, chunk]);
});
});
it('should log the successful message', done => {
// Need to stub/spy on the underlying logger as the "diag" instance is global
const stubLoggerError = sinon.stub(diag, 'error');
const responseSpy = sinon.spy();
collectorExporter.export(spans, responseSpy);
setTimeout(() => {
const mockRes = new MockedResponse(200);
const args = stubRequest.args[0];
const callback = args[1];
callback(mockRes);
mockRes.send('success');
setTimeout(() => {
assert.strictEqual(stubLoggerError.args.length, 0);
assert.strictEqual(
responseSpy.args[0][0].code,
core.ExportResultCode.SUCCESS
);
done();
});
});
});
it('should log the error message', done => {
const responseSpy = sinon.spy();
collectorExporter.export(spans, responseSpy);
setTimeout(() => {
const mockResError = new MockedResponse(400);
const args = stubRequest.args[0];
const callback = args[1];
callback(mockResError);
mockResError.send('failed');
setTimeout(() => {
const result = responseSpy.args[0][0] as core.ExportResult;
assert.strictEqual(result.code, core.ExportResultCode.FAILED);
const error = result.error as collectorTypes.CollectorExporterError;
assert.ok(error !== undefined);
assert.strictEqual(error.code, 400);
assert.strictEqual(error.data, 'failed');
done();
});
});
});
});
describe('export - with compression', () => {
beforeEach(() => {
stubRequest = sinon.stub(http, 'request').returns(fakeRequest as any);
collectorExporterConfig = {
headers: {
foo: 'bar',
},
hostname: 'foo',
attributes: {},
url: 'http://foo.bar.com',
keepAlive: true,
compress: true,
httpAgentOptions: { keepAliveMsecs: 2000 },
};
collectorExporter = new CollectorTraceExporter(collectorExporterConfig);
spans = [];
spans.push(Object.assign({}, mockedReadableSpan));
});
it('should successfully send the spans', done => {
collectorExporter.export(spans, () => { });
let buff = Buffer.from('');
fakeRequest.on('end', () => {
const responseBody = zlib.gunzipSync(buff).toString();
const json = JSON.parse(
responseBody
) as collectorTypes.opentelemetryProto.collector.trace.v1.ExportTraceServiceRequest;
const span1 =
json.resourceSpans[0].instrumentationLibrarySpans[0].spans[0];
assert.ok(typeof span1 !== 'undefined', "span doesn't exist");
if (span1) {
ensureSpanIsCorrect(span1);
}
ensureExportTraceServiceRequestIsSet(json);
done();
});
fakeRequest.on('data', chunk => {
buff = Buffer.concat([buff, chunk]);
});
});
});
describe('CollectorTraceExporter - node (getDefaultUrl)', () => {
it('should default to localhost', done => {
const collectorExporter = new CollectorTraceExporter();
setTimeout(() => {
assert.strictEqual(
collectorExporter['url'],
'http://localhost:55681/v1/traces'
);
done();
});
});
it('should keep the URL if included', done => {
const url = 'http://foo.bar.com';
const collectorExporter = new CollectorTraceExporter({ url });
setTimeout(() => {
assert.strictEqual(collectorExporter['url'], url);
done();
});
});
});
});