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.
srikanthccv · Mar 4, 2020 · 4127913 · 4127913
1 parent 5a5b6b8
commit 4127913
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 43 deletions.
diff --git a/packages/opentelemetry-api/src/trace/SpanOptions.ts b/packages/opentelemetry-api/src/trace/SpanOptions.ts
@@ -33,12 +33,6 @@ export interface SpanOptions {
   /** A spans attributes */
   attributes?: Attributes;
 
-  /**
-   * Indicates that if this Span is active and recording information like
-   * events with the `AddEvent` operation and attributes using `setAttributes`.
-   */
-  isRecording?: boolean;
-
   /** A spans links */
   links?: Link[];
 

diff --git a/packages/opentelemetry-api/test/noop-implementations/noop-tracer.test.ts b/packages/opentelemetry-api/test/noop-implementations/noop-tracer.test.ts
@@ -30,7 +30,6 @@ describe('NoopTracer', () => {
     assert.deepStrictEqual(
       tracer.startSpan('span-name2', {
         kind: SpanKind.CLIENT,
-        isRecording: true,
       }),
       NOOP_SPAN
     );

diff --git a/packages/opentelemetry-tracing/src/Tracer.ts b/packages/opentelemetry-tracing/src/Tracer.ts
@@ -83,8 +83,7 @@ export class Tracer implements api.Tracer {
       ? api.TraceFlags.SAMPLED
       : api.TraceFlags.UNSAMPLED;
     const spanContext = { traceId, spanId, traceFlags, traceState };
-    const recordEvents = options.isRecording || false;
-    if (!recordEvents && !samplingDecision) {
+    if (!samplingDecision) {
       this.logger.debug('Sampling is off, starting no recording span');
       return new NoRecordingSpan(spanContext);
     }

diff --git a/packages/opentelemetry-tracing/test/BasicTracerProvider.test.ts b/packages/opentelemetry-tracing/test/BasicTracerProvider.test.ts
@@ -281,43 +281,11 @@ describe('BasicTracerProvider', () => {
       span.end();
     });
 
-    it('should create real span when not sampled but recording events true', () => {
-      const tracer = new BasicTracerProvider({
-        sampler: NEVER_SAMPLER,
-      }).getTracer('default');
-      const span = tracer.startSpan('my-span', { isRecording: true });
-      assert.ok(span instanceof Span);
-      assert.strictEqual(span.context().traceFlags, TraceFlags.UNSAMPLED);
-      assert.strictEqual(span.isRecording(), true);
-    });
-
-    it('should not create real span when not sampled and recording events false', () => {
-      const tracer = new BasicTracerProvider({
-        sampler: NEVER_SAMPLER,
-        logger: new NoopLogger(),
-      }).getTracer('default');
-      const span = tracer.startSpan('my-span', { isRecording: false });
-      assert.ok(span instanceof NoRecordingSpan);
-      assert.strictEqual(span.context().traceFlags, TraceFlags.UNSAMPLED);
-      assert.strictEqual(span.isRecording(), false);
-    });
-
-    it('should not create real span when not sampled and no recording events configured', () => {
-      const tracer = new BasicTracerProvider({
-        sampler: NEVER_SAMPLER,
-        logger: new NoopLogger(),
-      }).getTracer('default');
-      const span = tracer.startSpan('my-span');
-      assert.ok(span instanceof NoRecordingSpan);
-      assert.strictEqual(span.context().traceFlags, TraceFlags.UNSAMPLED);
-      assert.strictEqual(span.isRecording(), false);
-    });
-
-    it('should create real span when sampled and recording events true', () => {
+    it('should create real span when sampled', () => {
       const tracer = new BasicTracerProvider({
         sampler: ALWAYS_SAMPLER,
       }).getTracer('default');
-      const span = tracer.startSpan('my-span', { isRecording: true });
+      const span = tracer.startSpan('my-span');
       assert.ok(span instanceof Span);
       assert.strictEqual(span.context().traceFlags, TraceFlags.SAMPLED);
       assert.strictEqual(span.isRecording(), true);