Skip to content

Commit 4127913

Browse files
authored
chore: remove SpanOptions.isRecording (open-telemetry#817)
Remove SpanOptions.isRecording as it seems to be quite useless and I found only Span.isRecording in spec. Also Java seems to have no such option for span creation.
1 parent 5a5b6b8 commit 4127913

File tree

4 files changed

+3
-43
lines changed

4 files changed

+3
-43
lines changed

packages/opentelemetry-api/src/trace/SpanOptions.ts

-6
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,6 @@ export interface SpanOptions {
3333
/** A spans attributes */
3434
attributes?: Attributes;
3535

36-
/**
37-
* Indicates that if this Span is active and recording information like
38-
* events with the `AddEvent` operation and attributes using `setAttributes`.
39-
*/
40-
isRecording?: boolean;
41-
4236
/** A spans links */
4337
links?: Link[];
4438

packages/opentelemetry-api/test/noop-implementations/noop-tracer.test.ts

-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ describe('NoopTracer', () => {
3030
assert.deepStrictEqual(
3131
tracer.startSpan('span-name2', {
3232
kind: SpanKind.CLIENT,
33-
isRecording: true,
3433
}),
3534
NOOP_SPAN
3635
);

packages/opentelemetry-tracing/src/Tracer.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,7 @@ export class Tracer implements api.Tracer {
8383
? api.TraceFlags.SAMPLED
8484
: api.TraceFlags.UNSAMPLED;
8585
const spanContext = { traceId, spanId, traceFlags, traceState };
86-
const recordEvents = options.isRecording || false;
87-
if (!recordEvents && !samplingDecision) {
86+
if (!samplingDecision) {
8887
this.logger.debug('Sampling is off, starting no recording span');
8988
return new NoRecordingSpan(spanContext);
9089
}

packages/opentelemetry-tracing/test/BasicTracerProvider.test.ts

+2-34
Original file line numberDiff line numberDiff line change
@@ -281,43 +281,11 @@ describe('BasicTracerProvider', () => {
281281
span.end();
282282
});
283283

284-
it('should create real span when not sampled but recording events true', () => {
285-
const tracer = new BasicTracerProvider({
286-
sampler: NEVER_SAMPLER,
287-
}).getTracer('default');
288-
const span = tracer.startSpan('my-span', { isRecording: true });
289-
assert.ok(span instanceof Span);
290-
assert.strictEqual(span.context().traceFlags, TraceFlags.UNSAMPLED);
291-
assert.strictEqual(span.isRecording(), true);
292-
});
293-
294-
it('should not create real span when not sampled and recording events false', () => {
295-
const tracer = new BasicTracerProvider({
296-
sampler: NEVER_SAMPLER,
297-
logger: new NoopLogger(),
298-
}).getTracer('default');
299-
const span = tracer.startSpan('my-span', { isRecording: false });
300-
assert.ok(span instanceof NoRecordingSpan);
301-
assert.strictEqual(span.context().traceFlags, TraceFlags.UNSAMPLED);
302-
assert.strictEqual(span.isRecording(), false);
303-
});
304-
305-
it('should not create real span when not sampled and no recording events configured', () => {
306-
const tracer = new BasicTracerProvider({
307-
sampler: NEVER_SAMPLER,
308-
logger: new NoopLogger(),
309-
}).getTracer('default');
310-
const span = tracer.startSpan('my-span');
311-
assert.ok(span instanceof NoRecordingSpan);
312-
assert.strictEqual(span.context().traceFlags, TraceFlags.UNSAMPLED);
313-
assert.strictEqual(span.isRecording(), false);
314-
});
315-
316-
it('should create real span when sampled and recording events true', () => {
284+
it('should create real span when sampled', () => {
317285
const tracer = new BasicTracerProvider({
318286
sampler: ALWAYS_SAMPLER,
319287
}).getTracer('default');
320-
const span = tracer.startSpan('my-span', { isRecording: true });
288+
const span = tracer.startSpan('my-span');
321289
assert.ok(span instanceof Span);
322290
assert.strictEqual(span.context().traceFlags, TraceFlags.SAMPLED);
323291
assert.strictEqual(span.isRecording(), true);

0 commit comments

Comments
 (0)