fix: respect isRecordingEvents flag (open-telemetry#180)

repl-chris · Aug 13, 2019 · a27536e · a27536e
1 parent aab5cc1
commit a27536e
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 2 deletions.
diff --git a/packages/opentelemetry-basic-tracer/src/BasicTracer.ts b/packages/opentelemetry-basic-tracer/src/BasicTracer.ts
@@ -77,8 +77,8 @@ export class BasicTracer implements types.Tracer {
       ? TraceOptions.SAMPLED
       : TraceOptions.UNSAMPLED;
     const spanContext = { traceId, spanId, traceOptions, traceState };
-
-    if (!samplingDecision) {
+    const recordEvents = options.isRecordingEvents || false;
+    if (!recordEvents && !samplingDecision) {
       return new NoRecordingSpan(spanContext);
     }
 

diff --git a/packages/opentelemetry-basic-tracer/test/BasicTracer.test.ts b/packages/opentelemetry-basic-tracer/test/BasicTracer.test.ts
@@ -167,6 +167,50 @@ describe('BasicTracer', () => {
       assert.deepStrictEqual(context.traceState, undefined);
     });
 
+    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');