[Core] - Move core-tracing to @opentelemetry/api 0.20.0 (Azure#15672)

## What - Bump @opentelemetry/api to 0.20.0 in @azure/core-tracing - Move all packages that are on core-http to the next core-tracing version - Remove version collision check from the tracer cache ## Why This is part of our effort to move everyone to OTel 0.20.0 - but we have to stage it due to a transitive dependency and a breaking change in OTel. This PR updates core-tracing to use the latest OTel, fixes any breaking changes, and moves packages that we can move to the latest version of core-tracing. Once core-rest-pipeline 1.1.0 is GA'd we'll be able to move the rest of the packages over to the latest core-tracing as well. Removing the version collision came out of an offline discussion after these changes were reviewed - since it's a common source of pain and hasn't added much benefit (tracer conflicts incompatibility was never a problem) we decided to remove that logic and always grab a unique symbol per OT compatibility. ## Callouts The packages that are already on core-v2 will _not_ be upgraded at this time - we'll coordinate that with the GA of core-rest-pipeline 1.1.0
AzureSDKAutomation · Jun 18, 2021 · d023204 · d023204
1 parent bdff63d
commit d023204
Show file tree

Hide file tree

Showing 91 changed files with 318 additions and 298 deletions.
diff --git a/common/config/rush/common-versions.json b/common/config/rush/common-versions.json
@@ -72,6 +72,8 @@
     "@azure/identity": ["2.0.0-beta.3", "^1.1.0"],
     // Issue #14771 tracks updating to these versions
     "@microsoft/api-extractor": ["7.13.2"],
-    "prettier": ["2.2.1"]
+    "prettier": ["2.2.1"],
+    // All packages should move to 1.0.0-preview.12 once core-rest-pipeline 1.1.0 GAs
+    "@azure/core-tracing": ["1.0.0-preview.11"]
   }
 }
diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml
diff --git a/sdk/anomalydetector/ai-anomaly-detector/package.json b/sdk/anomalydetector/ai-anomaly-detector/package.json
@@ -67,7 +67,7 @@
     "@azure/core-paging": "^1.1.1",
     "@azure/logger": "^1.0.0",
     "tslib": "^2.2.0",
-    "@azure/core-tracing": "1.0.0-preview.11"
+    "@azure/core-tracing": "1.0.0-preview.12"
   },
   "devDependencies": {
     "@azure/dev-tool": "^1.0.0",

diff --git a/sdk/appconfiguration/app-configuration/package.json b/sdk/appconfiguration/app-configuration/package.json
@@ -90,13 +90,13 @@
     "@azure/core-asynciterator-polyfill": "^1.0.0",
     "@azure/core-http": "^1.2.0",
     "@azure/core-paging": "^1.1.1",
-    "@azure/core-tracing": "1.0.0-preview.11",
+    "@azure/core-tracing": "1.0.0-preview.12",
     "tslib": "^2.2.0"
   },
   "devDependencies": {
     "@azure/dev-tool": "^1.0.0",
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
-    "@azure/identity": "2.0.0-beta.3",
+    "@azure/identity": "2.0.0-beta.4",
     "@azure/keyvault-secrets": "^4.2.0",
     "@azure/test-utils-recorder": "^1.0.0",
     "@microsoft/api-extractor": "7.7.11",

diff --git a/sdk/communication/communication-chat/package.json b/sdk/communication/communication-chat/package.json
@@ -69,7 +69,7 @@
     "@azure/communication-signaling": "1.0.0-beta.5",
     "@azure/core-auth": "^1.3.0",
     "@azure/core-http": "^1.2.0",
-    "@azure/core-tracing": "1.0.0-preview.11",
+    "@azure/core-tracing": "1.0.0-preview.12",
     "@azure/logger": "^1.0.0",
     "events": "^3.0.0",
     "tslib": "^2.2.0",

diff --git a/sdk/communication/communication-common/package.json b/sdk/communication/communication-common/package.json
@@ -66,7 +66,7 @@
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-auth": "^1.3.0",
     "@azure/core-http": "^1.2.0",
-    "@azure/core-tracing": "1.0.0-preview.11",
+    "@azure/core-tracing": "1.0.0-preview.12",
     "events": "^3.0.0",
     "jwt-decode": "~2.2.0",
     "tslib": "^2.2.0"

diff --git a/sdk/communication/communication-identity/package.json b/sdk/communication/communication-identity/package.json
@@ -79,7 +79,7 @@
     "@azure/core-http": "^1.2.0",
     "@azure/core-lro": "^1.0.2",
     "@azure/core-paging": "^1.1.1",
-    "@azure/core-tracing": "1.0.0-preview.11",
+    "@azure/core-tracing": "1.0.0-preview.12",
     "@azure/logger": "^1.0.0",
     "events": "^3.0.0",
     "tslib": "^2.2.0"

diff --git a/sdk/communication/communication-network-traversal/package.json b/sdk/communication/communication-network-traversal/package.json
@@ -77,7 +77,7 @@
     "@azure/communication-common": "^1.0.0",
     "@azure/core-auth": "^1.3.0",
     "@azure/core-http": "^1.2.0",
-    "@azure/core-tracing": "1.0.0-preview.11",
+    "@azure/core-tracing": "1.0.0-preview.12",
     "@azure/logger": "^1.0.0",
     "events": "^3.0.0",
     "tslib": "^2.2.0"

diff --git a/sdk/communication/communication-phone-numbers/package.json b/sdk/communication/communication-phone-numbers/package.json
@@ -67,7 +67,7 @@
     "@azure/core-http": "^1.2.0",
     "@azure/core-lro": "^1.0.2",
     "@azure/core-paging": "^1.1.1",
-    "@azure/core-tracing": "1.0.0-preview.11",
+    "@azure/core-tracing": "1.0.0-preview.12",
     "@azure/logger": "^1.0.0",
     "events": "^3.0.0",
     "tslib": "^2.2.0"

diff --git a/sdk/communication/communication-sms/package.json b/sdk/communication/communication-sms/package.json
@@ -69,7 +69,7 @@
     "@azure/communication-common": "^1.0.0",
     "@azure/core-auth": "^1.3.0",
     "@azure/core-http": "^1.2.0",
-    "@azure/core-tracing": "1.0.0-preview.11",
+    "@azure/core-tracing": "1.0.0-preview.12",
     "@azure/logger": "^1.0.0",
     "events": "^3.0.0",
     "tslib": "^2.2.0"

diff --git a/sdk/core/README.md b/sdk/core/README.md
@@ -122,14 +122,14 @@ Client libraries have preliminary support for [OpenTelemetry](https://openteleme
 
 Each client library internally does the work to create a new OpenTelemetry `Span` for each service operation, making sure to end the `Span` after the result is returned back to the consumer. Many clients use a helper method called [createSpan](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/textanalytics/ai-text-analytics/src/tracing.ts) to create the new `Span`.
 
-When `tracingOptions.spanOptions.parent` is set on an operation, a default request policy will automatically create a span for each HTTP request that is issued.
+When `tracingOptions.tracingContext` is set on an operation, a default request policy will automatically create a span for each HTTP request that is issued.
 
-Consumers are expected to pass in the `SpanContext` of the parent `Span` when calling an operation, such as:
+Consumers are expected to pass in the `Context` of the parent `Span` when calling an operation, such as:
 
 ```ts
 const result = await blobClient.download(undefined, undefined, {
   tracingOptions: {
-    spanOptions: { parent: rootSpan.context() },
+    tracingContext: activeContext
   },
 });
 ```

diff --git a/sdk/core/core-http/package.json b/sdk/core/core-http/package.json
@@ -129,7 +129,7 @@
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-asynciterator-polyfill": "^1.0.0",
     "@azure/core-auth": "^1.3.0",
-    "@azure/core-tracing": "1.0.0-preview.11",
+    "@azure/core-tracing": "1.0.0-preview.12",
     "@azure/logger": "^1.0.0",
     "@types/node-fetch": "^2.5.0",
     "@types/tunnel": "^0.0.1",

diff --git a/sdk/core/core-http/src/policies/tracingPolicy.ts b/sdk/core/core-http/src/policies/tracingPolicy.ts
@@ -76,7 +76,7 @@ export class TracingPolicy extends BaseRequestPolicy {
 
     try {
       // set headers
-      const spanContext = span.context();
+      const spanContext = span.spanContext();
       const traceParentHeader = getTraceParentHeader(spanContext);
       if (traceParentHeader) {
         request.headers.set("traceparent", traceParentHeader);

diff --git a/sdk/core/core-http/test/policies/tracingPolicyTests.ts b/sdk/core/core-http/test/policies/tracingPolicyTests.ts
@@ -12,32 +12,49 @@ import {
 import {
   setTracer,
   NoOpTracer,
-  NoOpSpan,
   SpanOptions,
   SpanContext,
   TraceFlags,
   TraceState,
   setSpan,
   context,
   SpanStatusCode,
-  SpanStatus
+  SpanStatus,
+  Span,
+  SpanAttributes,
+  SpanAttributeValue,
+  Tracer
 } from "@azure/core-tracing";
 import { tracingPolicy } from "../../src/policies/tracingPolicy";
 
-class MockSpan extends NoOpSpan {
+class MockSpan implements Span {
   private _endCalled = false;
   private _status: SpanStatus = {
     code: SpanStatusCode.UNSET
   };
-  private _attributes: { [s: string]: unknown } = {};
+  private _attributes: SpanAttributes = {};
 
   constructor(
     private traceId: string,
     private spanId: string,
     private flags: TraceFlags,
     private state: string
-  ) {
-    super();
+  ) {}
+
+  addEvent(): this {
+    throw new Error("Not implemented.");
+  }
+
+  isRecording(): boolean {
+    return true;
+  }
+
+  recordException(): void {
+    throw new Error("Not implemented.");
+  }
+
+  updateName(): this {
+    throw new Error("Not implemented.");
   }
 
   didEnd(): boolean {
@@ -57,7 +74,12 @@ class MockSpan extends NoOpSpan {
     return this;
   }
 
-  setAttribute(key: string, value: unknown) {
+  setAttributes(attributes: SpanAttributes): this {
+    this._attributes = attributes;
+    return this;
+  }
+
+  setAttribute(key: string, value: SpanAttributeValue) {
     this._attributes[key] = value;
     return this;
   }
@@ -66,7 +88,7 @@ class MockSpan extends NoOpSpan {
     return this._attributes[key];
   }
 
-  context(): SpanContext {
+  spanContext(): SpanContext {
     const state = this.state;
 
     const traceState = {
@@ -95,7 +117,7 @@ class MockSpan extends NoOpSpan {
   }
 }
 
-class MockTracer extends NoOpTracer {
+class MockTracer implements Tracer {
   private spans: MockSpan[] = [];
   private _startSpanCalled = false;
 
@@ -104,9 +126,7 @@ class MockTracer extends NoOpTracer {
     private spanId = "",
     private flags = TraceFlags.NONE,
     private state = ""
-  ) {
-    super();
-  }
+  ) {}
 
   getStartedSpans(): MockSpan[] {
     return this.spans;

diff --git a/sdk/core/core-lro/package.json b/sdk/core/core-lro/package.json
@@ -97,7 +97,7 @@
   "dependencies": {
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-http": "^1.2.0",
-    "@azure/core-tracing": "1.0.0-preview.11",
+    "@azure/core-tracing": "1.0.0-preview.12",
     "events": "^3.0.0",
     "tslib": "^2.2.0"
   },

diff --git a/sdk/core/core-rest-pipeline/package.json b/sdk/core/core-rest-pipeline/package.json
@@ -93,7 +93,7 @@
   "dependencies": {
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-auth": "^1.3.0",
-    "@azure/core-tracing": "1.0.0-preview.11",
+    "@azure/core-tracing": "1.0.0-preview.12",
     "@azure/logger": "^1.0.0",
     "form-data": "^3.0.0",
     "tslib": "^2.2.0",

diff --git a/sdk/core/core-rest-pipeline/src/policies/tracingPolicy.ts b/sdk/core/core-rest-pipeline/src/policies/tracingPolicy.ts
@@ -77,7 +77,7 @@ export function tracingPolicy(options: TracingPolicyOptions = {}): PipelinePolic
 
       try {
         // set headers
-        const spanContext = span.context();
+        const spanContext = span.spanContext();
         const traceParentHeader = getTraceParentHeader(spanContext);
         if (traceParentHeader) {
           request.headers.set("traceparent", traceParentHeader);

diff --git a/sdk/core/core-rest-pipeline/test/tracingPolicy.spec.ts b/sdk/core/core-rest-pipeline/test/tracingPolicy.spec.ts
@@ -66,7 +66,7 @@ class MockSpan extends NoOpSpan {
     return this._attributes[key];
   }
 
-  context(): SpanContext {
+  spanContext(): SpanContext {
     const state = this.state;
 
     const traceState = {

diff --git a/sdk/core/core-tracing/package.json b/sdk/core/core-tracing/package.json
@@ -60,7 +60,7 @@
   "homepage": "https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/core/core-tracing/README.md",
   "sideEffects": false,
   "dependencies": {
-    "@opentelemetry/api": "1.0.0-rc.0",
+    "@opentelemetry/api": "0.20.0",
     "tslib": "^2.2.0"
   },
   "devDependencies": {

diff --git a/sdk/core/core-tracing/review/core-tracing.api.md b/sdk/core/core-tracing/review/core-tracing.api.md
@@ -81,25 +81,19 @@ export type HrTime = [number, number];
 // @public
 export interface Link {
     attributes?: SpanAttributes;
-    context: LinkContext;
+    context: SpanContext;
 }
 
-// @public
-export type LinkContext = {
-    traceId: string;
-    spanId: string;
-};
-
 // @public
 export class NoOpSpan implements Span {
     addEvent(_name: string, _attributes?: SpanAttributes): this;
-    context(): SpanContext;
     end(_endTime?: number): void;
     isRecording(): boolean;
     recordException(_exception: Exception, _time?: TimeInput): void;
     setAttribute(_key: string, _value: unknown): this;
     setAttributes(_attributes: SpanAttributes): this;
     setStatus(_status: SpanStatus): this;
+    spanContext(): SpanContext;
     updateName(_name: string): this;
 }
 
@@ -129,13 +123,13 @@ export function setTracer(tracer: Tracer): void;
 // @public
 export interface Span {
     addEvent(name: string, attributesOrStartTime?: SpanAttributes | TimeInput, startTime?: TimeInput): this;
-    context(): SpanContext;
     end(endTime?: TimeInput): void;
     isRecording(): boolean;
     recordException(exception: Exception, time?: TimeInput): void;
     setAttribute(key: string, value: SpanAttributeValue): this;
     setAttributes(attributes: SpanAttributes): this;
     setStatus(status: SpanStatus): this;
+    spanContext(): SpanContext;
     updateName(name: string): this;
 }
 
@@ -200,7 +194,6 @@ export enum SpanStatusCode {
 export class TestSpan extends NoOpSpan {
     constructor(parentTracer: Tracer, name: string, context: SpanContext, kind: SpanKind, parentSpanId?: string, startTime?: TimeInput);
     readonly attributes: SpanAttributes;
-    context(): SpanContext;
     end(_endTime?: number): void;
     endCalled: boolean;
     isRecording(): boolean;
@@ -210,6 +203,7 @@ export class TestSpan extends NoOpSpan {
     setAttribute(key: string, value: SpanAttributeValue): this;
     setAttributes(attributes: SpanAttributes): this;
     setStatus(status: SpanStatus): this;
+    spanContext(): SpanContext;
     readonly startTime: TimeInput;
     status: SpanStatus;
     tracer(): Tracer;

diff --git a/sdk/core/core-tracing/src/index.ts b/sdk/core/core-tracing/src/index.ts
@@ -23,7 +23,6 @@ export {
   getSpanContext,
   HrTime,
   Link,
-  LinkContext,
   OperationTracingOptions,
   setSpan,
   setSpanContext,