[sampler] treat invalid SpanContext as no SpanContext (#2165)

open-telemetry · Apr 28, 2021 · c4341c3 · c4341c3
1 parent b9c8426
commit c4341c3
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 1 deletion.
diff --git a/packages/opentelemetry-core/src/trace/sampler/ParentBasedSampler.ts b/packages/opentelemetry-core/src/trace/sampler/ParentBasedSampler.ts
@@ -18,6 +18,7 @@ import {
   SpanAttributes,
   Context,
   getSpanContext,
+  isSpanContextValid,
   Link,
   Sampler,
   SamplingResult,
@@ -69,7 +70,7 @@ export class ParentBasedSampler implements Sampler {
   ): SamplingResult {
     const parentContext = getSpanContext(context);
 
-    if (!parentContext) {
+    if (!parentContext || !isSpanContextValid(parentContext)) {
       return this._root.shouldSample(
         context,
         traceId,

diff --git a/packages/opentelemetry-core/test/trace/ParentBasedSampler.test.ts b/packages/opentelemetry-core/test/trace/ParentBasedSampler.test.ts
@@ -71,6 +71,24 @@ describe('ParentBasedSampler', () => {
     );
   });
 
+  it('should return api.SamplingDecision.RECORD_AND_SAMPLED for invalid parent spanContext while composited with AlwaysOnSampler', () => {
+    const sampler = new ParentBasedSampler({ root: new AlwaysOnSampler() });
+
+    assert.deepStrictEqual(
+      sampler.shouldSample(
+        setSpanContext(api.ROOT_CONTEXT, api.INVALID_SPAN_CONTEXT),
+        traceId,
+        spanName,
+        SpanKind.CLIENT,
+        {},
+        []
+      ),
+      {
+        decision: api.SamplingDecision.RECORD_AND_SAMPLED,
+      }
+    );
+  });
+
   it('should return api.SamplingDecision.RECORD_AND_SAMPLED while composited with AlwaysOnSampler', () => {
     const sampler = new ParentBasedSampler({ root: new AlwaysOnSampler() });
 
@@ -112,6 +130,24 @@ describe('ParentBasedSampler', () => {
     );
   });
 
+  it('should return api.SamplingDecision.NOT_RECORD for invalid parent spanContext while composited with AlwaysOffSampler', () => {
+    const sampler = new ParentBasedSampler({ root: new AlwaysOffSampler() });
+
+    assert.deepStrictEqual(
+      sampler.shouldSample(
+        setSpanContext(api.ROOT_CONTEXT, api.INVALID_SPAN_CONTEXT),
+        traceId,
+        spanName,
+        SpanKind.CLIENT,
+        {},
+        []
+      ),
+      {
+        decision: api.SamplingDecision.NOT_RECORD,
+      }
+    );
+  });
+
   it('should return api.SamplingDecision.RECORD_AND_SAMPLED while composited with AlwaysOffSampler', () => {
     const sampler = new ParentBasedSampler({ root: new AlwaysOffSampler() });