[core-tracing] Update to OpenTelemetry 0.6 (#7998)

* Migrate all packages to OpenTelemetry 0.6.1. * Update inter-package dependencies to express the new requirements.
Azure · Apr 23, 2020 · 1b7428d · 1b7428d
1 parent b964568
commit 1b7428d
Show file tree

Hide file tree

Showing 138 changed files with 462 additions and 412 deletions.
diff --git a/common/config/rush/common-versions.json b/common/config/rush/common-versions.json
@@ -42,9 +42,6 @@
    */
   "allowedAlternativeVersions": {
     "@azure/ms-rest-js": ["^2.0.0"],
-    "@azure/core-http": ["^1.1.0"],
-    "@azure/core-auth": ["^1.1.0"],
-    "@azure/core-tracing": ["1.0.0-preview.7"],
     /**
      * For example, allow some projects to use an older TypeScript compiler
      * (in addition to whatever "usual" version is being used by other projects in the repo):

diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml
diff --git a/dataplane.code-workspace b/dataplane.code-workspace
@@ -51,6 +51,10 @@
     {
       "path": "sdk\\eventhub\\event-processor-host"
     },
+    {
+      "path": "sdk\\formrecognizer\\ai-form-recognizer",
+      "name": "form-recognizer"
+    },
     {
       "path": "sdk\\eventhub\\testhub"
     },
@@ -103,6 +107,9 @@
     {
       "name": "eslint plugin",
       "path": "common\\tools\\eslint-plugin-azure-sdk"
+    },
+    {
+      "path": "sdk\\test-utils\\perfstress"
     }
   ],
   "settings": {

diff --git a/sdk/appconfiguration/app-configuration/package.json b/sdk/appconfiguration/app-configuration/package.json
@@ -74,10 +74,10 @@
   },
   "dependencies": {
     "@azure/core-asynciterator-polyfill": "^1.0.0",
-    "@azure/core-http": "^1.0.0",
+    "@azure/core-http": "^1.1.1",
     "@azure/core-paging": "^1.1.0",
     "@azure/core-tracing": "1.0.0-preview.8",
-    "@opentelemetry/types": "^0.2.0",
+    "@opentelemetry/api": "^0.6.1",
     "tslib": "^1.10.0"
   },
   "devDependencies": {

diff --git a/sdk/appconfiguration/app-configuration/src/internal/tracingHelpers.ts b/sdk/appconfiguration/app-configuration/src/internal/tracingHelpers.ts
@@ -2,7 +2,8 @@
 // Licensed under the MIT License.
 
 import { getTracer } from "@azure/core-tracing";
-import { Span, SpanOptions, SpanKind, CanonicalCode } from "@opentelemetry/types";
+import { Span, SpanKind, CanonicalCode } from "@opentelemetry/api";
+import { SpanOptions } from "@azure/core-tracing";
 
 import { RestError } from "@azure/core-http";
 
@@ -90,7 +91,7 @@ export class Spanner<TClient> {
       ...options,
       spanOptions: {
         ...spanOptions,
-        parent: span,
+        parent: span.context(),
         attributes: {
           ...spanOptions.attributes,
           "az.namespace": "Microsoft.AppConfiguration"

diff --git a/sdk/appconfiguration/app-configuration/test/tracingHelpers.spec.ts b/sdk/appconfiguration/app-configuration/test/tracingHelpers.spec.ts
@@ -4,7 +4,9 @@
 import { Spanner } from "../src/internal/tracingHelpers";
 import { RestError } from "@azure/core-http";
 import { getTracer } from "@azure/core-tracing";
-import { SpanOptions, SpanKind, CanonicalCode } from "@opentelemetry/types";
+import { SpanKind, CanonicalCode } from "@opentelemetry/api";
+import { SpanOptions } from "@azure/core-tracing";
+
 import * as assert from "assert";
 
 interface FakeOptions {
@@ -17,7 +19,6 @@ describe("tracingHelpers", () => {
     const fakeOptions: FakeOptions = {
       name: "fakeName",
       spanOptions: {
-        kind: SpanKind.PRODUCER,
         attributes: {
           testAttribute: "testAttributeValue"
         }
@@ -31,8 +32,7 @@ describe("tracingHelpers", () => {
     const newOptions = Spanner["addParentToOptions"](fakeOptions, parentSpan);
 
     assert.equal("fakeName", newOptions.name);
-    assert.equal(parentSpan, newOptions.spanOptions.parent);
-    assert.equal(SpanKind.PRODUCER, newOptions.spanOptions.kind);
+    assert.deepEqual(parentSpan.context(), newOptions.spanOptions.parent);
     assert.ok(newOptions.spanOptions.attributes, "Should have attributes set");
     if (newOptions.spanOptions.attributes) {
       assert.equal("Microsoft.AppConfiguration", newOptions.spanOptions.attributes["az.namespace"]);

diff --git a/sdk/core/core-arm/package.json b/sdk/core/core-arm/package.json
@@ -99,7 +99,7 @@
     ]
   },
   "dependencies": {
-    "@azure/core-http": "^1.0.0",
+    "@azure/core-http": "^1.1.1",
     "tslib": "^1.10.0"
   },
   "devDependencies": {

diff --git a/sdk/core/core-auth/package.json b/sdk/core/core-auth/package.json
@@ -66,7 +66,7 @@
   "dependencies": {
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-tracing": "1.0.0-preview.8",
-    "@opentelemetry/types": "^0.2.0",
+    "@opentelemetry/api": "^0.6.1",
     "tslib": "^1.10.0"
   },
   "devDependencies": {

diff --git a/sdk/core/core-auth/review/core-auth.api.md b/sdk/core/core-auth/review/core-auth.api.md
@@ -5,7 +5,7 @@
 ```ts
 
 import { AbortSignalLike } from '@azure/abort-controller';
-import { SpanOptions } from '@opentelemetry/types';
+import { SpanOptions } from '@azure/core-tracing';
 
 // @public
 export interface AccessToken {

diff --git a/sdk/core/core-auth/src/tokenCredential.ts b/sdk/core/core-auth/src/tokenCredential.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import { AbortSignalLike } from "@azure/abort-controller";
-import { SpanOptions } from "@opentelemetry/types";
+import { SpanOptions } from "@azure/core-tracing";
 
 /**
  * Represents a credential capable of providing an authentication token.

diff --git a/sdk/core/core-http/package.json b/sdk/core/core-http/package.json
@@ -130,7 +130,7 @@
     "@azure/core-auth": "^1.1.2",
     "@azure/core-tracing": "1.0.0-preview.8",
     "@azure/logger": "^1.0.0",
-    "@opentelemetry/types": "^0.2.0",
+    "@opentelemetry/api": "^0.6.1",
     "@types/node-fetch": "^2.5.0",
     "@types/tunnel": "^0.0.1",
     "cross-env": "^6.0.3",

diff --git a/sdk/core/core-http/rollup.base.config.js b/sdk/core/core-http/rollup.base.config.js
@@ -87,7 +87,7 @@ export function browserConfig(test = false, production = false) {
         namedExports: {
           chai: ["assert", "AssertionError", "should", "expect"],
           events: ["EventEmitter"],
-          "@opentelemetry/types": ["CanonicalCode", "SpanKind", "TraceFlags"]
+          "@opentelemetry/api": ["CanonicalCode", "SpanKind", "TraceFlags"]
         }
       }),
       viz({ filename: "dist-browser/browser-stats.html", sourcemap: false })

diff --git a/sdk/core/core-http/src/policies/tracingPolicy.ts b/sdk/core/core-http/src/policies/tracingPolicy.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import { getTracer, getTraceParentHeader } from "@azure/core-tracing";
-import { SpanOptions, SpanKind } from "@opentelemetry/types";
+import { SpanOptions, SpanKind } from "@opentelemetry/api";
 import {
   RequestPolicyFactory,
   RequestPolicy,

diff --git a/sdk/core/core-http/src/webResource.ts b/sdk/core/core-http/src/webResource.ts
@@ -9,7 +9,7 @@ import { HttpOperationResponse } from "./httpOperationResponse";
 import { OperationResponse } from "./operationResponse";
 import { ProxySettings } from "./serviceClient";
 import { AbortSignalLike } from "@azure/abort-controller";
-import { SpanOptions } from "@opentelemetry/types";
+import { SpanOptions } from "@azure/core-tracing";
 
 export type HttpMethods =
   | "GET"

diff --git a/sdk/core/core-http/test/policies/tracingPolicyTests.ts b/sdk/core/core-http/test/policies/tracingPolicyTests.ts
@@ -9,7 +9,7 @@ import {
   HttpHeaders,
   RequestPolicyOptions
 } from "../../src/coreHttp";
-import { SpanOptions, SpanContext, TraceFlags } from "@opentelemetry/types";
+import { SpanOptions, SpanContext, TraceFlags } from "@opentelemetry/api";
 import { setTracer, NoOpTracer, NoOpSpan } from "@azure/core-tracing";
 import { tracingPolicy } from "../../src/policies/tracingPolicy";
 
@@ -60,7 +60,7 @@ class MockTracer extends NoOpTracer {
   constructor(
     private traceId = "",
     private spanId = "",
-    private flags = TraceFlags.UNSAMPLED,
+    private flags = TraceFlags.NONE,
     private state = ""
   ) {
     super();
@@ -114,7 +114,7 @@ describe("tracingPolicy", function() {
     setTracer(mockTracer);
     const request = new WebResource();
     request.spanOptions = {
-      parent: ROOT_SPAN
+      parent: ROOT_SPAN.context()
     };
     const policy = tracingPolicy().create(mockPolicy, new RequestPolicyOptions());
     await policy.sendRequest(request);
@@ -141,7 +141,7 @@ describe("tracingPolicy", function() {
     setTracer(mockTracer);
     const request = new WebResource();
     request.spanOptions = {
-      parent: ROOT_SPAN
+      parent: ROOT_SPAN.context()
     };
     const policy = tracingPolicy().create(mockPolicy, new RequestPolicyOptions());
     await policy.sendRequest(request);
@@ -168,7 +168,7 @@ describe("tracingPolicy", function() {
     setTracer(mockTracer);
     const request = new WebResource();
     request.spanOptions = {
-      parent: ROOT_SPAN
+      parent: ROOT_SPAN.context()
     };
     const policy = tracingPolicy().create(mockPolicy, new RequestPolicyOptions());
     await policy.sendRequest(request);
@@ -195,7 +195,7 @@ describe("tracingPolicy", function() {
     setTracer(mockTracer);
     const request = new WebResource();
     request.spanOptions = {
-      parent: ROOT_SPAN
+      parent: ROOT_SPAN.context()
     };
     const policy = tracingPolicy().create(
       {
@@ -233,7 +233,7 @@ describe("tracingPolicy", function() {
     setTracer(new NoOpTracer());
     const request = new WebResource();
     request.spanOptions = {
-      parent: ROOT_SPAN
+      parent: ROOT_SPAN.context()
     };
     const policy = tracingPolicy().create(mockPolicy, new RequestPolicyOptions());
     await policy.sendRequest(request);

diff --git a/sdk/core/core-lro/package.json b/sdk/core/core-lro/package.json
@@ -95,12 +95,12 @@
   "sideEffects": false,
   "dependencies": {
     "@azure/abort-controller": "^1.0.0",
-    "@azure/core-http": "^1.0.0",
+    "@azure/core-http": "^1.1.1",
     "events": "^3.0.0",
     "tslib": "^1.10.0"
   },
   "devDependencies": {
-    "@opentelemetry/types": "^0.2.0",
+    "@opentelemetry/api": "^0.6.1",
     "@microsoft/api-extractor": "7.7.11",
     "@rollup/plugin-commonjs": "^11.0.1",
     "@rollup/plugin-multi-entry": "^3.0.0",

diff --git a/sdk/core/core-lro/rollup.base.config.js b/sdk/core/core-lro/rollup.base.config.js
@@ -119,7 +119,7 @@ export function browserConfig(test = false) {
       cjs({
         namedExports: {
           assert: ["ok", "equal", "strictEqual"],
-          "@opentelemetry/types": ["CanonicalCode", "SpanKind", "TraceFlags"]
+          "@opentelemetry/api": ["CanonicalCode", "SpanKind", "TraceFlags"]
         }
       })
     ]

diff --git a/sdk/core/core-tracing/CHANGELOG.md b/sdk/core/core-tracing/CHANGELOG.md
@@ -3,6 +3,11 @@
 ## 1.0.0-preview.8 (Unreleased)
 
 - Update `TestSpan` to allow setting span attributes [PR link](https://github.com/Azure/azure-sdk-for-js/pull/6565).
+- [BREAKING] Migrate to OpenTelemetry 0.6 using the new `@opentelemetry/api` package. There were a few breaking changes:
+  - `SpanContext` now requires traceFlags to be set.
+  - `Tracer` has removed `recordSpanData`, `getBinaryFormat`, and `getHttpTextFormat`.
+  - `Tracer.getCurrentSpan` returns `undefined` instead of `null` when unset.
+  - `Link` objects renamed `spanContext` property to `context`.
 
 ## 1.0.0-preview.7 (2019-12-03)
 

diff --git a/sdk/core/core-tracing/package.json b/sdk/core/core-tracing/package.json
@@ -59,7 +59,7 @@
   "sideEffects": false,
   "dependencies": {
     "@opencensus/web-types": "0.0.7",
-    "@opentelemetry/types": "^0.2.0",
+    "@opentelemetry/api": "^0.6.1",
     "tslib": "^1.10.0"
   },
   "devDependencies": {