chore!: remove legacy otel support

Author: feywind

src/index.ts

@@ -184,8 +184,3 @@ if (process.env.DEBUG_GRPC) {
 }
 import * as protos from '../protos/protos';
 export {protos};
-
-// Deprecated; please see the updated OpenTelemetry sample
-// for an example of how to use telemetry in this library.
-import {legacyExports} from './telemetry-tracing';
-export {legacyExports as openTelemetry};

src/publisher/index.ts

@@ -336,7 +336,7 @@ export class Publisher {
    * @param {PubsubMessage} message The message to create a span for
    */
   getParentSpan(message: PubsubMessage, caller: string): Span | undefined {
-    const enabled = tracing.isEnabled(this.settings);
+    const enabled = tracing.isEnabled();
     if (!enabled) {
       return undefined;
     }
@@ -353,7 +353,7 @@ export class Publisher {
 
     // If the span's context is valid we should inject the propagation trace context.
     if (span && isSpanContextValid(span.spanContext())) {
-      tracing.injectSpan(span, message, enabled);
+      tracing.injectSpan(span, message);
     }
 
     return span;

src/subscriber.ts

@@ -578,10 +578,6 @@ export interface SubscriberOptions {
   flowControl?: FlowControlOptions;
   useLegacyFlowControl?: boolean;
   streamingOptions?: MessageStreamOptions;
-
-  /** @deprecated Unset this and instantiate a tracer; support will be
-   *    enabled automatically. */
-  enableOpenTelemetryTracing?: boolean;
 }
 
 const minAckDeadlineForExactlyOnceDelivery = Duration.from({seconds: 60});
@@ -604,7 +600,6 @@ export class Subscriber extends EventEmitter {
   private _acks!: AckQueue;
   private _histogram: Histogram;
   private _inventory!: LeaseManager;
-  private _useLegacyOpenTelemetry: boolean;
   private _latencies: Histogram;
   private _modAcks!: ModAckQueue;
   private _name!: string;
@@ -622,7 +617,6 @@ export class Subscriber extends EventEmitter {
     this.maxBytes = defaultOptions.subscription.maxOutstandingBytes;
     this.useLegacyFlowControl = false;
     this.isOpen = false;
-    this._useLegacyOpenTelemetry = false;
     this._histogram = new Histogram({min: 10, max: 600});
     this._latencies = new Histogram();
     this._subscription = subscription;
@@ -966,8 +960,6 @@ export class Subscriber extends EventEmitter {
   setOptions(options: SubscriberOptions): void {
     this._options = options;
 
-    this._useLegacyOpenTelemetry = options.enableOpenTelemetryTracing || false;
-
     // The user-set ackDeadline value basically pegs the extension time.
     // We'll emulate it by overwriting min/max.
     const passedAckDeadline = options.ackDeadline;
@@ -1015,11 +1007,9 @@ export class Subscriber extends EventEmitter {
    * @private
    */
   private createParentSpan(message: Message): void {
-    const enabled = tracing.isEnabled({
-      enableOpenTelemetryTracing: this._useLegacyOpenTelemetry,
-    });
+    const enabled = tracing.isEnabled();
     if (enabled) {
-      tracing.extractSpan(message, this.name, enabled);
+      tracing.extractSpan(message, this.name);
     }
   }
 

src/telemetry-tracing.ts

@@ -28,7 +28,6 @@ import {
   Link,
 } from '@opentelemetry/api';
 import {Attributes, PubsubMessage} from './publisher/pubsub-message';
-import {PublishOptions} from './publisher/index';
 import {Duration} from './temporal';
 
 export {Span};
@@ -65,13 +64,6 @@ export enum OpenTelemetryLevel {
    */
   None = 0,
 
-  /**
-   * Legacy: We found a trace provider, but the user also specified the old
-   * manual enable flag; this will trigger the legacy attribute being included.
-   * The modern propagation attribute will _also_ be included.
-   */
-  Legacy = 1,
-
   /**
    * Modern: We will only inject/extract the modern propagation attribute.
    */
@@ -96,26 +88,11 @@ export function setGloballyEnabled(enabled: boolean) {
  * Tries to divine what sort of OpenTelemetry we're supporting. See the enum
  * for the meaning of the values, and other notes.
  *
- * Legacy OTel is no longer officially supported, but we don't want to
- * break anyone at a non-major.
- *
  * @private
  * @internal
  */
-export function isEnabled(
-  publishSettings?: PublishOptions,
-): OpenTelemetryLevel {
-  // If we're not enabled, skip everything.
-  if (!globallyEnabled) {
-    return OpenTelemetryLevel.None;
-  }
-
-  if (publishSettings?.enableOpenTelemetryTracing) {
-    return OpenTelemetryLevel.Legacy;
-  }
-
-  // Enable modern support.
-  return OpenTelemetryLevel.Modern;
+export function isEnabled(): OpenTelemetryLevel {
+  return globallyEnabled ? OpenTelemetryLevel.Modern : OpenTelemetryLevel.None;
 }
 
 /**
@@ -242,14 +219,6 @@ export function spanContextToContext(
  */
 export const modernAttributeName = 'googclient_traceparent';
 
-/**
- * The old legacy attribute name.
- *
- * @private
- * @internal
- */
-export const legacyAttributeName = 'googclient_OpenTelemetrySpanContext';
-
 export interface AttributeParams {
   // Fully qualified.
   topicName?: string;
@@ -762,11 +731,7 @@ export class PubsubEvents {
  * @private
  * @internal
  */
-export function injectSpan(
-  span: Span,
-  message: MessageWithAttributes,
-  enabled: OpenTelemetryLevel,
-): void {
+export function injectSpan(span: Span, message: MessageWithAttributes): void {
   if (!globallyEnabled) {
     return;
   }
@@ -783,18 +748,6 @@ export function injectSpan(
     delete message.attributes[modernAttributeName];
   }
 
-  // If we're in legacy mode, add that header as well.
-  if (enabled === OpenTelemetryLevel.Legacy) {
-    if (message.attributes[legacyAttributeName]) {
-      console.warn(
-        `${legacyAttributeName} key set as message attribute, but will be overridden.`,
-      );
-    }
-    message.attributes[legacyAttributeName] = JSON.stringify(
-      span.spanContext(),
-    );
-  }
-
   // Always do propagation injection with the trace context.
   const context = trace.setSpanContext(ROOT_CONTEXT, span.spanContext());
   propagation.inject(context, message, pubsubSetter);
@@ -820,9 +773,7 @@ export function containsSpanContext(message: MessageWithAttributes): boolean {
   }
 
   const keys = Object.getOwnPropertyNames(message.attributes);
-  return !!keys.find(
-    n => n === legacyAttributeName || n === modernAttributeName,
-  );
+  return !!keys.find(n => n === modernAttributeName);
 }
 
 /**
@@ -838,7 +789,6 @@ export function containsSpanContext(message: MessageWithAttributes): boolean {
 export function extractSpan(
   message: MessageWithAttributes,
   subName: string,
-  enabled: OpenTelemetryLevel,
 ): Span | undefined {
   if (!globallyEnabled) {
     return undefined;
@@ -852,26 +802,8 @@ export function extractSpan(
 
   let context: Context | undefined;
 
-  if (enabled === OpenTelemetryLevel.Legacy) {
-    // Only prefer the legacy attributes to no trace context attribute.
-    if (
-      keys.includes(legacyAttributeName) &&
-      !keys.includes(modernAttributeName)
-    ) {
-      const legacyValue = message.attributes?.[legacyAttributeName];
-      if (legacyValue) {
-        const parentSpanContext: SpanContext | undefined = legacyValue
-          ? JSON.parse(legacyValue)
-          : undefined;
-        if (parentSpanContext) {
-          context = spanContextToContext(parentSpanContext);
-        }
-      }
-    }
-  } else {
-    if (keys.includes(modernAttributeName)) {
-      context = propagation.extract(ROOT_CONTEXT, message, pubsubGetter);
-    }
+  if (keys.includes(modernAttributeName)) {
+    context = propagation.extract(ROOT_CONTEXT, message, pubsubGetter);
   }
 
   const span = PubsubSpans.createReceiveSpan(
@@ -883,33 +815,3 @@ export function extractSpan(
   message.parentSpan = span;
   return span;
 }
-
-// Since these were exported on the main Pub/Sub index in the previous
-// version, we have to export them until the next major.
-export const legacyExports = {
-  /**
-   * @deprecated
-   * Use the new telemetry functionality instead; see the updated OpenTelemetry
-   * sample for an example.
-   */
-  createSpan: function (
-    spanName: string,
-    kind: SpanKind,
-    attributes?: SpanAttributes,
-    parent?: SpanContext,
-  ): Span {
-    if (!globallyEnabled) {
-      // This isn't great, but it's the fact of the situation.
-      return undefined as unknown as Span;
-    } else {
-      return getTracer().startSpan(
-        spanName,
-        {
-          kind,
-          attributes,
-        },
-        parent ? trace.setSpanContext(context.active(), parent) : undefined,
-      );
-    }
-  },
-};

test/publisher/index.ts

@@ -375,22 +375,6 @@ describe('Publisher', () => {
           done();
         });
       });
-
-      it('should issue a warning if OpenTelemetry span context key is set', () => {
-        tracing.setGloballyEnabled(true);
-
-        const warnSpy = sinon.spy(console, 'warn');
-        const attributes = {
-          [tracing.legacyAttributeName]: 'foobar',
-        };
-        const fakeMessageWithOTKey = {data, attributes};
-        const publisherTracing = new Publisher(topic, {
-          enableOpenTelemetryTracing: true,
-        });
-        publisherTracing.publishMessage(fakeMessageWithOTKey, warnSpy);
-        assert.ok(warnSpy.called);
-        warnSpy.restore();
-      });
     });
   });
 

test/pubsub.ts

@@ -356,6 +356,34 @@ describe('PubSub', () => {
     it('should set isEmulator to false by default', () => {
       assert.strictEqual(pubsub.isEmulator, false);
     });
+
+    describe('tracing', () => {
+      beforeEach(() => {
+        tracing.setGloballyEnabled(false);
+      });
+      afterEach(() => {
+        tracing.setGloballyEnabled(false);
+      });
+      it('should not enable OTel when tracing is disabled', () => {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const _pubsub = new PubSub({});
+        assert.strictEqual(
+          tracing.isEnabled(),
+          tracing.OpenTelemetryLevel.None,
+        );
+      });
+
+      it('should enable OTel when tracing is enabled through constructor', () => {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const _pubsub = new PubSub({
+          enableOpenTelemetryTracing: true,
+        });
+        assert.strictEqual(
+          tracing.isEnabled(),
+          tracing.OpenTelemetryLevel.Modern,
+        );
+      });
+    });
   });
 
   describe('createSubscription', () => {