-
Notifications
You must be signed in to change notification settings - Fork 730
/
BasicTracer.test.ts
287 lines (262 loc) · 9.69 KB
/
BasicTracer.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
/**
* Copyright 2019, 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 * as assert from 'assert';
import {
ALWAYS_SAMPLER,
BinaryTraceContext,
HttpTraceContext,
NEVER_SAMPLER,
NoopLogger,
TraceState,
NoRecordingSpan,
NoopSpan,
} from '@opentelemetry/core';
import { BasicTracer } from '../src/BasicTracer';
import { NoopScopeManager } from '@opentelemetry/scope-base';
import { Span } from '../src/Span';
import { TraceOptions } from '@opentelemetry/types';
describe('BasicTracer', () => {
describe('constructor', () => {
it('should construct an instance with required only options', () => {
const tracer = new BasicTracer({
scopeManager: new NoopScopeManager(),
});
assert.ok(tracer instanceof BasicTracer);
});
it('should construct an instance with binary format', () => {
const tracer = new BasicTracer({
binaryFormat: new BinaryTraceContext(),
scopeManager: new NoopScopeManager(),
});
assert.ok(tracer instanceof BasicTracer);
});
it('should construct an instance with http text format', () => {
const tracer = new BasicTracer({
httpTextFormat: new HttpTraceContext(),
scopeManager: new NoopScopeManager(),
});
assert.ok(tracer instanceof BasicTracer);
});
it('should construct an instance with logger', () => {
const tracer = new BasicTracer({
logger: new NoopLogger(),
scopeManager: new NoopScopeManager(),
});
assert.ok(tracer instanceof BasicTracer);
});
it('should construct an instance with sampler', () => {
const tracer = new BasicTracer({
scopeManager: new NoopScopeManager(),
sampler: ALWAYS_SAMPLER,
});
assert.ok(tracer instanceof BasicTracer);
});
it('should construct an instance with default attributes', () => {
const tracer = new BasicTracer({
defaultAttributes: {
region: 'eu-west',
asg: 'my-asg',
},
scopeManager: new NoopScopeManager(),
});
assert.ok(tracer instanceof BasicTracer);
});
});
describe('.startSpan()', () => {
it('should start a span with name only', () => {
const tracer = new BasicTracer({
scopeManager: new NoopScopeManager(),
});
const span = tracer.startSpan('my-span');
assert.ok(span);
assert.ok(span instanceof Span);
});
it('should start a span with name and options', () => {
const tracer = new BasicTracer({
scopeManager: new NoopScopeManager(),
});
const span = tracer.startSpan('my-span', {});
assert.ok(span);
assert.ok(span instanceof Span);
const context = span.context();
assert.ok(context.traceId.match(/[a-f0-9]{32}/));
assert.ok(context.spanId.match(/[a-f0-9]{16}/));
assert.strictEqual(context.traceOptions, TraceOptions.SAMPLED);
assert.deepStrictEqual(context.traceState, undefined);
span.end();
});
it('should start a span with name and parent spancontext', () => {
const tracer = new BasicTracer({
scopeManager: new NoopScopeManager(),
});
const state = new TraceState('a=1,b=2');
const span = tracer.startSpan('my-span', {
parent: {
traceId: 'd4cda95b652f4a1592b449d5929fda1b',
spanId: '6e0c63257de34c92',
traceState: state,
},
});
assert.ok(span instanceof Span);
const context = span.context();
assert.strictEqual(context.traceId, 'd4cda95b652f4a1592b449d5929fda1b');
assert.strictEqual(context.traceOptions, TraceOptions.SAMPLED);
assert.deepStrictEqual(context.traceState, state);
span.end();
});
it('should start a span with name and parent span', () => {
const tracer = new BasicTracer({
scopeManager: new NoopScopeManager(),
});
const span = tracer.startSpan('my-span');
const childSpan = tracer.startSpan('child-span', {
parent: span,
});
const context = childSpan.context();
assert.strictEqual(context.traceId, span.context().traceId);
assert.strictEqual(context.traceOptions, TraceOptions.SAMPLED);
span.end();
childSpan.end();
});
it('should start a span with name and with invalid spancontext', () => {
const tracer = new BasicTracer({
scopeManager: new NoopScopeManager(),
});
const span = tracer.startSpan('my-span', {
parent: { traceId: '0', spanId: '0' },
});
assert.ok(span instanceof Span);
const context = span.context();
assert.ok(context.traceId.match(/[a-f0-9]{32}/));
assert.ok(context.spanId.match(/[a-f0-9]{16}/));
assert.strictEqual(context.traceOptions, TraceOptions.SAMPLED);
assert.deepStrictEqual(context.traceState, undefined);
});
it('should return a no recording span when never sampling', () => {
const tracer = new BasicTracer({
sampler: NEVER_SAMPLER,
scopeManager: new NoopScopeManager(),
});
const span = tracer.startSpan('my-span');
assert.ok(span instanceof NoRecordingSpan);
const context = span.context();
assert.ok(context.traceId.match(/[a-f0-9]{32}/));
assert.ok(context.spanId.match(/[a-f0-9]{16}/));
assert.strictEqual(context.traceOptions, TraceOptions.UNSAMPLED);
assert.deepStrictEqual(context.traceState, undefined);
span.end();
});
it('Should create real span when not sampled but recording events true', () => {
const tracer = new BasicTracer({
sampler: NEVER_SAMPLER,
scopeManager: new NoopScopeManager(),
});
const span = tracer.startSpan('my-span', { isRecordingEvents: true });
assert.ok(span instanceof Span);
assert.strictEqual(span.context().traceOptions, TraceOptions.UNSAMPLED);
assert.strictEqual(span.isRecordingEvents(), true);
});
it('Should not create real span when not sampled and recording events false', () => {
const tracer = new BasicTracer({
sampler: NEVER_SAMPLER,
scopeManager: new NoopScopeManager(),
});
const span = tracer.startSpan('my-span', { isRecordingEvents: false });
assert.ok(span instanceof NoRecordingSpan);
assert.strictEqual(span.context().traceOptions, TraceOptions.UNSAMPLED);
assert.strictEqual(span.isRecordingEvents(), false);
});
it('Should not create real span when not sampled and no recording events configured', () => {
const tracer = new BasicTracer({
sampler: NEVER_SAMPLER,
scopeManager: new NoopScopeManager(),
});
const span = tracer.startSpan('my-span');
assert.ok(span instanceof NoRecordingSpan);
assert.strictEqual(span.context().traceOptions, TraceOptions.UNSAMPLED);
assert.strictEqual(span.isRecordingEvents(), false);
});
it('Should create real span when sampled and recording events true', () => {
const tracer = new BasicTracer({
sampler: ALWAYS_SAMPLER,
scopeManager: new NoopScopeManager(),
});
const span = tracer.startSpan('my-span', { isRecordingEvents: true });
assert.ok(span instanceof Span);
assert.strictEqual(span.context().traceOptions, TraceOptions.SAMPLED);
assert.strictEqual(span.isRecordingEvents(), true);
});
// @todo: implement
it('should start a Span with always sampling');
// @todo: implement
it('should set default attributes on span');
});
describe('.getCurrentSpan()', () => {
it('should return NoopSpan with NoopScopeManager', () => {
const tracer = new BasicTracer({
scopeManager: new NoopScopeManager(),
});
const currentSpan = tracer.getCurrentSpan();
assert.ok(currentSpan instanceof NoopSpan);
});
});
describe('.withSpan()', () => {
it('should run scope with NoopScopeManager scope manager', done => {
const tracer = new BasicTracer({
scopeManager: new NoopScopeManager(),
});
const span = tracer.startSpan('my-span');
tracer.withSpan(span, () => {
assert.ok(tracer.getCurrentSpan() instanceof NoopSpan);
return done();
});
});
});
describe('.bind()', () => {
it('should bind scope with NoopScopeManager scope manager', done => {
const tracer = new BasicTracer({
scopeManager: new NoopScopeManager(),
});
const span = tracer.startSpan('my-span');
const fn = () => {
assert.ok(tracer.getCurrentSpan() instanceof NoopSpan);
return done();
};
const patchedFn = tracer.bind(fn, span);
return patchedFn();
});
});
describe('.recordSpanData()', () => {
// @todo: implement
it('should call exporters with span data');
});
describe('.getBinaryFormat()', () => {
it('should get default binary formatter', () => {
const tracer = new BasicTracer({
scopeManager: new NoopScopeManager(),
});
assert.ok(tracer.getBinaryFormat() instanceof BinaryTraceContext);
});
});
describe('.getHttpTextFormat()', () => {
it('should get default HTTP text formatter', () => {
const tracer = new BasicTracer({
scopeManager: new NoopScopeManager(),
});
assert.ok(tracer.getHttpTextFormat() instanceof HttpTraceContext);
});
});
});