Move suppress tracing context key to SDK (#2202)

Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>

packages/opentelemetry-core/package.json

@@ -56,7 +56,6 @@
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.0.0-rc.0",
-    "@opentelemetry/propagator-b3": "0.19.0",
     "@types/mocha": "8.2.2",
     "@types/node": "14.14.43",
     "@types/semver": "7.3.5",

packages/opentelemetry-core/src/baggage/propagation/HttpBaggagePropagator.ts

@@ -15,23 +15,27 @@
  */
 
 import {
-  Context,
   BaggageEntry,
+  Context,
+  createBaggage,
   getBaggage,
   setBaggage,
   TextMapGetter,
   TextMapPropagator,
-  TextMapSetter,
-  createBaggage,
-  isInstrumentationSuppressed,
+  TextMapSetter
 } from '@opentelemetry/api';
-import { getKeyPairs, serializeKeyPairs, parsePairKeyValue } from '../utils';
+import { isTracingSuppressed } from '../../trace/suppress-tracing';
 import {
-  BAGGAGE_MAX_NAME_VALUE_PAIRS,
-  BAGGAGE_ITEMS_SEPARATOR,
   BAGGAGE_HEADER,
-  BAGGAGE_MAX_PER_NAME_VALUE_PAIRS,
+  BAGGAGE_ITEMS_SEPARATOR,
+  BAGGAGE_MAX_NAME_VALUE_PAIRS,
+  BAGGAGE_MAX_PER_NAME_VALUE_PAIRS
 } from '../constants';
+import {
+  getKeyPairs,
+  parsePairKeyValue,
+  serializeKeyPairs
+} from '../utils';
 
 /**
  * Propagates {@link Baggage} through Context format propagation.
@@ -42,7 +46,7 @@ import {
 export class HttpBaggagePropagator implements TextMapPropagator {
   inject(context: Context, carrier: unknown, setter: TextMapSetter) {
     const baggage = getBaggage(context);
-    if (!baggage || isInstrumentationSuppressed(context)) return;
+    if (!baggage || isTracingSuppressed(context)) return;
     const keyPairs = getKeyPairs(baggage)
       .filter((pair: string) => {
         return pair.length <= BAGGAGE_MAX_PER_NAME_VALUE_PAIRS;

packages/opentelemetry-core/src/index.ts

@@ -31,6 +31,7 @@ export * from './trace/sampler/AlwaysOffSampler';
 export * from './trace/sampler/AlwaysOnSampler';
 export * from './trace/sampler/ParentBasedSampler';
 export * from './trace/sampler/TraceIdRatioBasedSampler';
+export * from './trace/suppress-tracing';
 export * from './trace/TraceState';
 export * from './utils/environment';
 export * from './utils/sampling';

packages/opentelemetry-core/src/trace/HttpTraceContextPropagator.ts

@@ -17,7 +17,6 @@
 import {
   Context,
   getSpanContext,
-  isInstrumentationSuppressed,
   isSpanContextValid,
   setSpanContext,
   SpanContext,
@@ -26,6 +25,7 @@ import {
   TextMapSetter,
   TraceFlags,
 } from '@opentelemetry/api';
+import { isTracingSuppressed } from './suppress-tracing';
 import { TraceState } from './TraceState';
 
 export const TRACE_PARENT_HEADER = 'traceparent';
@@ -77,7 +77,7 @@ export class HttpTraceContextPropagator implements TextMapPropagator {
     const spanContext = getSpanContext(context);
     if (
       !spanContext ||
-      isInstrumentationSuppressed(context) ||
+      isTracingSuppressed(context) ||
       !isSpanContextValid(spanContext)
     )
       return;

packages/opentelemetry-core/src/trace/suppress-tracing.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright The 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 { Context, createContextKey } from '@opentelemetry/api';
+
+const SUPPRESS_TRACING_KEY = createContextKey(
+  'OpenTelemetry SDK Context Key SUPPRESS_TRACING'
+);
+
+export function suppressTracing(context: Context): Context {
+  return context.setValue(SUPPRESS_TRACING_KEY, true);
+}
+
+export function unsuppressTracing(context: Context): Context {
+  return context.deleteValue(SUPPRESS_TRACING_KEY);
+}
+
+export function isTracingSuppressed(context: Context): boolean {
+  return context.getValue(SUPPRESS_TRACING_KEY) === true;
+}

packages/opentelemetry-core/test/propagation/composite.test.ts

@@ -21,6 +21,8 @@ import {
   SpanContext,
   getSpanContext,
   setSpanContext,
+  TextMapGetter,
+  TextMapSetter,
 } from '@opentelemetry/api';
 import { Context, ROOT_CONTEXT } from '@opentelemetry/api';
 import * as assert from 'assert';
@@ -29,19 +31,27 @@ import {
   HttpTraceContextPropagator,
   RandomIdGenerator,
 } from '../../src';
-import {
-  B3Propagator,
-  B3InjectEncoding,
-  X_B3_SAMPLED,
-  X_B3_SPAN_ID,
-  X_B3_TRACE_ID,
-} from '@opentelemetry/propagator-b3';
 import {
   TRACE_PARENT_HEADER,
   TRACE_STATE_HEADER,
 } from '../../src/trace/HttpTraceContextPropagator';
 import { TraceState } from '../../src/trace/TraceState';
 
+class DummyPropagator implements TextMapPropagator {
+  inject(context: Context, carrier: any, setter: TextMapSetter<any>): void {
+    carrier['dummy'] = getSpanContext(context);
+  }
+  extract(context: Context, carrier: any, getter: TextMapGetter<any>): Context {
+    if (carrier['dummy']) {
+      return setSpanContext(context, carrier['dummy']);
+    }
+    return context;
+  }
+  fields(): string[] {
+    return ['dummy'];
+  }
+}
+
 describe('Composite Propagator', () => {
   let traceId: string;
   let spanId: string;
@@ -70,16 +80,11 @@ describe('Composite Propagator', () => {
 
     it('should inject context using all configured propagators', () => {
       const composite = new CompositePropagator({
-        propagators: [
-          new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER }),
-          new HttpTraceContextPropagator(),
-        ],
+        propagators: [new DummyPropagator(), new HttpTraceContextPropagator()],
       });
       composite.inject(ctxWithSpanContext, carrier, defaultTextMapSetter);
 
-      assert.strictEqual(carrier[X_B3_TRACE_ID], traceId);
-      assert.strictEqual(carrier[X_B3_SPAN_ID], spanId);
-      assert.strictEqual(carrier[X_B3_SAMPLED], '1');
+      assert.strictEqual(carrier['dummy'], spanContext);
       assert.strictEqual(
         carrier[TRACE_PARENT_HEADER],
         `00-${traceId}-${spanId}-01`
@@ -108,20 +113,15 @@ describe('Composite Propagator', () => {
 
     beforeEach(() => {
       carrier = {
-        [X_B3_TRACE_ID]: traceId,
-        [X_B3_SPAN_ID]: spanId,
-        [X_B3_SAMPLED]: 1,
+        ['dummy']: { traceId, spanId },
         [TRACE_PARENT_HEADER]: `00-${traceId}-${spanId}-01`,
         [TRACE_STATE_HEADER]: 'foo=bar',
       };
     });
 
     it('should extract context using all configured propagators', () => {
       const composite = new CompositePropagator({
-        propagators: [
-          new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER }),
-          new HttpTraceContextPropagator(),
-        ],
+        propagators: [new DummyPropagator(), new HttpTraceContextPropagator()],
       });
       const spanContext = getSpanContext(
         composite.extract(ROOT_CONTEXT, carrier, defaultTextMapGetter)

packages/opentelemetry-core/test/trace/HttpTraceContextPropagator.test.ts

@@ -23,7 +23,6 @@ import {
   ROOT_CONTEXT,
   setSpanContext,
   SpanContext,
-  suppressInstrumentation,
   TraceFlags,
 } from '@opentelemetry/api';
 import * as assert from 'assert';
@@ -32,6 +31,7 @@ import {
   TRACE_PARENT_HEADER,
   TRACE_STATE_HEADER,
 } from '../../src/trace/HttpTraceContextPropagator';
+import { suppressTracing } from '../../src/trace/suppress-tracing';
 import { TraceState } from '../../src/trace/TraceState';
 
 describe('HttpTraceContextPropagator', () => {
@@ -90,7 +90,7 @@ describe('HttpTraceContextPropagator', () => {
       };
 
       httpTraceContext.inject(
-        suppressInstrumentation(setSpanContext(ROOT_CONTEXT, spanContext)),
+        suppressTracing(setSpanContext(ROOT_CONTEXT, spanContext)),
         carrier,
         defaultTextMapSetter
       );
@@ -107,7 +107,7 @@ describe('HttpTraceContextPropagator', () => {
       };
 
       httpTraceContext.inject(
-        suppressInstrumentation(setSpanContext(ROOT_CONTEXT, spanContext)),
+        suppressTracing(setSpanContext(ROOT_CONTEXT, spanContext)),
         carrier,
         defaultTextMapSetter
       );

packages/opentelemetry-core/tsconfig.json

@@ -9,9 +9,6 @@
     "test/**/*.ts"
   ],
   "references": [
-    {
-      "path": "../opentelemetry-propagator-b3"
-    },
     {
       "path": "../opentelemetry-semantic-conventions"
     }

packages/opentelemetry-instrumentation-http/package.json

@@ -43,7 +43,6 @@
   "devDependencies": {
     "@opentelemetry/api": "^1.0.0-rc.0",
     "@opentelemetry/context-async-hooks": "0.19.0",
-    "@opentelemetry/core": "0.19.0",
     "@opentelemetry/node": "0.19.0",
     "@opentelemetry/tracing": "0.19.0",
     "@types/got": "9.6.11",
@@ -72,6 +71,7 @@
     "@opentelemetry/api": "^1.0.0-rc.0"
   },
   "dependencies": {
+    "@opentelemetry/core": "0.19.0",
     "@opentelemetry/instrumentation": "0.19.0",
     "@opentelemetry/semantic-conventions": "0.19.0",
     "semver": "^7.1.3"

packages/opentelemetry-instrumentation-http/src/http.ts

@@ -24,10 +24,10 @@ import {
   setSpan,
   ROOT_CONTEXT,
   getSpan,
-  suppressInstrumentation,
   NOOP_TRACER,
   diag,
 } from '@opentelemetry/api';
+import { suppressTracing } from '@opentelemetry/core';
 import type * as http from 'http';
 import type * as https from 'https';
 import { Socket } from 'net';
@@ -388,7 +388,7 @@ export class HttpInstrumentation extends InstrumentationBase<Http> {
           (e: Error) => diag.error('caught ignoreIncomingPaths error: ', e)
         )
       ) {
-        return context.with(suppressInstrumentation(context.active()), () => {
+        return context.with(suppressTracing(context.active()), () => {
           context.bind(request);
           context.bind(response);
           return original.apply(this, [event, ...args]);

packages/opentelemetry-propagator-b3/package.json

@@ -42,6 +42,9 @@
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "@opentelemetry/core": "^0.19.0"
+  },
   "peerDependencies": {
     "@opentelemetry/api": "^1.0.0-rc.0"
   },

packages/opentelemetry-propagator-b3/src/B3MultiPropagator.ts

@@ -17,7 +17,6 @@
 import {
   Context,
   getSpanContext,
-  isInstrumentationSuppressed,
   isSpanContextValid,
   isValidSpanId,
   isValidTraceId,
@@ -27,14 +26,15 @@ import {
   TextMapSetter,
   TraceFlags,
 } from '@opentelemetry/api';
+import { isTracingSuppressed } from '@opentelemetry/core';
+import { B3_DEBUG_FLAG_KEY } from './common';
 import {
-  X_B3_TRACE_ID,
-  X_B3_SPAN_ID,
-  X_B3_SAMPLED,
-  X_B3_PARENT_SPAN_ID,
   X_B3_FLAGS,
+  X_B3_PARENT_SPAN_ID,
+  X_B3_SAMPLED,
+  X_B3_SPAN_ID,
+  X_B3_TRACE_ID,
 } from './constants';
-import { B3_DEBUG_FLAG_KEY } from './common';
 
 const VALID_SAMPLED_VALUES = new Set([true, 'true', 'True', '1', 1]);
 const VALID_UNSAMPLED_VALUES = new Set([false, 'false', 'False', '0', 0]);
@@ -99,7 +99,7 @@ export class B3MultiPropagator implements TextMapPropagator {
     if (
       !spanContext ||
       !isSpanContextValid(spanContext) ||
-      isInstrumentationSuppressed(context)
+      isTracingSuppressed(context)
     )
       return;
 

packages/opentelemetry-propagator-b3/src/B3Propagator.ts

@@ -16,11 +16,11 @@
 
 import {
   Context,
-  isInstrumentationSuppressed,
   TextMapGetter,
   TextMapPropagator,
   TextMapSetter,
 } from '@opentelemetry/api';
+import { isTracingSuppressed } from '@opentelemetry/core';
 import { B3MultiPropagator } from './B3MultiPropagator';
 import { B3SinglePropagator } from './B3SinglePropagator';
 import { B3_CONTEXT_HEADER } from './constants';
@@ -54,7 +54,7 @@ export class B3Propagator implements TextMapPropagator {
   }
 
   inject(context: Context, carrier: unknown, setter: TextMapSetter) {
-    if (isInstrumentationSuppressed(context)) {
+    if (isTracingSuppressed(context)) {
       return;
     }
     this._inject(context, carrier, setter);

packages/opentelemetry-propagator-b3/src/B3SinglePropagator.ts

@@ -17,7 +17,6 @@
 import {
   Context,
   getSpanContext,
-  isInstrumentationSuppressed,
   isSpanContextValid,
   isValidSpanId,
   isValidTraceId,
@@ -27,8 +26,9 @@ import {
   TextMapSetter,
   TraceFlags,
 } from '@opentelemetry/api';
-import { B3_CONTEXT_HEADER } from './constants';
+import { isTracingSuppressed } from '@opentelemetry/core';
 import { B3_DEBUG_FLAG_KEY } from './common';
+import { B3_CONTEXT_HEADER } from './constants';
 
 const B3_CONTEXT_REGEX = /((?:[0-9a-f]{16}){1,2})-([0-9a-f]{16})(?:-([01d](?![0-9a-f])))?(?:-([0-9a-f]{16}))?/;
 const PADDING = '0'.repeat(16);
@@ -56,7 +56,7 @@ export class B3SinglePropagator implements TextMapPropagator {
     if (
       !spanContext ||
       !isSpanContextValid(spanContext) ||
-      isInstrumentationSuppressed(context)
+      isTracingSuppressed(context)
     )
       return;