[telemetry] Centralize (as much as is practical) the creation of spans to ease upgrades

sdk/anomalydetector/ai-anomaly-detector/package.json

@@ -67,7 +67,7 @@
     "@azure/logger": "^1.0.0",
     "@opentelemetry/api": "^0.10.2",
     "tslib": "^2.0.0",
-    "@azure/core-tracing": "1.0.0-preview.9"
+    "@azure/core-tracing": "1.0.0-beta.1"
   },
   "devDependencies": {
     "@azure/dev-tool": "^1.0.0",

sdk/anomalydetector/ai-anomaly-detector/src/tracing.ts

@@ -1,58 +1,13 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { getTracer, OperationTracingOptions } from "@azure/core-tracing";
-import { Span, SpanOptions, SpanKind } from "@opentelemetry/api";
-import { OperationOptions } from "@azure/core-http";
+import { createSpanFunction } from "@azure/core-tracing";
 
 /**
  * Creates a span using the global tracer.
  * @internal
- * @param name - The name of the operation being performed.
- * @param tracingOptions - The options for the underlying http request.
  */
-export function createSpan<T extends OperationOptions>(
-  operationName: string,
-  operationOptions: T
-): { span: Span; updatedOptions: T } {
-  const tracer = getTracer();
-  const tracingOptions = operationOptions.tracingOptions || {};
-  const spanOptions: SpanOptions = {
-    ...tracingOptions.spanOptions,
-    kind: SpanKind.INTERNAL
-  };
-
-  const span = tracer.startSpan(
-    `Azure.CognitiveServices.AnomalyDetector.${operationName}`,
-    spanOptions
-  );
-
-  span.setAttribute("az.namespace", "Microsoft.CognitiveServices");
-
-  let newSpanOptions = tracingOptions.spanOptions || {};
-  if (span.isRecording()) {
-    newSpanOptions = {
-      ...tracingOptions.spanOptions,
-      parent: span.context(),
-      attributes: {
-        ...spanOptions.attributes,
-        "az.namespace": "Microsoft.CognitiveServices"
-      }
-    };
-  }
-
-  const newTracingOptions: OperationTracingOptions = {
-    ...tracingOptions,
-    spanOptions: newSpanOptions
-  };
-
-  const newOperationOptions: T = {
-    ...operationOptions,
-    tracingOptions: newTracingOptions
-  };
-
-  return {
-    span,
-    updatedOptions: newOperationOptions
-  };
-}
+export const createSpan = createSpanFunction({
+  packagePrefix: "Azure.CognitiveServices.AnomalyDetector",
+  namespace: "Microsoft.CognitiveServices"
+});

sdk/appconfiguration/app-configuration/package.json

@@ -89,7 +89,7 @@
     "@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.9",
+    "@azure/core-tracing": "1.0.0-beta.1",
     "@opentelemetry/api": "^0.10.2",
     "tslib": "^2.0.0"
   },

sdk/communication/communication-administration/package.json

@@ -73,7 +73,7 @@
     "@azure/core-lro": "^1.0.2",
     "@azure/core-paging": "^1.1.1",
     "@azure/logger": "^1.0.0",
-    "@azure/core-tracing": "1.0.0-preview.9",
+    "@azure/core-tracing": "1.0.0-beta.1",
     "@opentelemetry/api": "^0.10.2",
     "events": "^3.0.0",
     "tslib": "^2.0.0"

sdk/communication/communication-administration/src/common/tracing.ts

@@ -1,57 +1,13 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { OperationOptions } from "@azure/core-http";
-import { getTracer } from "@azure/core-tracing";
-import { Span, SpanOptions, SpanKind } from "@opentelemetry/api";
-
-type OperationTracingOptions = OperationOptions["tracingOptions"];
+import { createSpanFunction } from "@azure/core-tracing";
 
 /**
  * Creates a span using the global tracer.
  * @internal
- * @param name - The name of the operation being performed.
- * @param tracingOptions - The options for the underlying http request.
  */
-export function createSpan<T extends OperationOptions>(
-  operationName: string,
-  operationOptions: T
-): { span: Span; updatedOptions: T } {
-  const tracer = getTracer();
-  const tracingOptions = operationOptions.tracingOptions || {};
-  const spanOptions: SpanOptions = {
-    ...tracingOptions.spanOptions,
-    kind: SpanKind.INTERNAL
-  };
-
-  const span = tracer.startSpan(`Azure.Communication.${operationName}`, spanOptions);
-
-  span.setAttribute("az.namespace", "Microsoft.Communication");
-
-  let newSpanOptions = tracingOptions.spanOptions || {};
-  if (span.isRecording()) {
-    newSpanOptions = {
-      ...tracingOptions.spanOptions,
-      parent: span.context(),
-      attributes: {
-        ...spanOptions.attributes,
-        "az.namespace": "Microsoft.Communication"
-      }
-    };
-  }
-
-  const newTracingOptions: OperationTracingOptions = {
-    ...tracingOptions,
-    spanOptions: newSpanOptions
-  };
-
-  const newOperationOptions: T = {
-    ...operationOptions,
-    tracingOptions: newTracingOptions
-  };
-
-  return {
-    span,
-    updatedOptions: newOperationOptions
-  };
-}
+export const createSpan = createSpanFunction({
+  packagePrefix: "Azure.Communication",
+  namespace: "Microsoft.Communication"
+});

sdk/communication/communication-chat/package.json

@@ -69,7 +69,7 @@
     "@azure/communication-signaling": "1.0.0-beta.2",
     "@azure/core-auth": "^1.2.0",
     "@azure/core-http": "^1.2.0",
-    "@azure/core-tracing": "1.0.0-preview.9",
+    "@azure/core-tracing": "1.0.0-beta.1",
     "@azure/logger": "^1.0.0",
     "@opentelemetry/api": "^0.10.2",
     "events": "^3.0.0",

sdk/communication/communication-chat/src/tracing.ts

@@ -1,57 +1,13 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { getTracer } from "@azure/core-tracing";
-import { Span, SpanOptions, SpanKind } from "@opentelemetry/api";
-import { OperationOptions } from "@azure/core-http";
-
-type OperationTracingOptions = OperationOptions["tracingOptions"];
+import { createSpanFunction } from "@azure/core-tracing";
 
 /**
  * Creates a span using the global tracer.
  * @internal
- * @param name - The name of the operation being performed.
- * @param tracingOptions - The options for the underlying http request.
  */
-export function createSpan<T extends OperationOptions>(
-  operationName: string,
-  operationOptions: T
-): { span: Span; updatedOptions: T } {
-  const tracer = getTracer();
-  const tracingOptions = operationOptions.tracingOptions || {};
-  const spanOptions: SpanOptions = {
-    ...tracingOptions.spanOptions,
-    kind: SpanKind.INTERNAL
-  };
-
-  const span = tracer.startSpan(`Azure.Communication.${operationName}`, spanOptions);
-
-  span.setAttribute("az.namespace", "Microsoft.Communication");
-
-  let newSpanOptions = tracingOptions.spanOptions || {};
-  if (span.isRecording()) {
-    newSpanOptions = {
-      ...tracingOptions.spanOptions,
-      parent: span.context(),
-      attributes: {
-        ...spanOptions.attributes,
-        "az.namespace": "Microsoft.Communication"
-      }
-    };
-  }
-
-  const newTracingOptions: OperationTracingOptions = {
-    ...tracingOptions,
-    spanOptions: newSpanOptions
-  };
-
-  const newOperationOptions: T = {
-    ...operationOptions,
-    tracingOptions: newTracingOptions
-  };
-
-  return {
-    span,
-    updatedOptions: newOperationOptions
-  };
-}
+export const createSpan = createSpanFunction({
+  packagePrefix: "Azure.Communication",
+  namespace: "Microsoft.Communication"
+});

sdk/communication/communication-identity/package.json

@@ -72,7 +72,7 @@
     "@azure/core-lro": "^1.0.2",
     "@azure/core-paging": "^1.1.1",
     "@azure/logger": "^1.0.0",
-    "@azure/core-tracing": "1.0.0-preview.9",
+    "@azure/core-tracing": "1.0.0-beta.1",
     "@opentelemetry/api": "^0.10.2",
     "events": "^3.0.0",
     "tslib": "^2.0.0"

sdk/communication/communication-identity/src/common/tracing.ts

@@ -1,57 +1,13 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { OperationOptions } from "@azure/core-http";
-import { getTracer } from "@azure/core-tracing";
-import { Span, SpanOptions, SpanKind } from "@opentelemetry/api";
-
-type OperationTracingOptions = OperationOptions["tracingOptions"];
+import { createSpanFunction } from "@azure/core-tracing";
 
 /**
  * Creates a span using the global tracer.
  * @internal
- * @param name - The name of the operation being performed.
- * @param tracingOptions - The options for the underlying http request.
  */
-export function createSpan<T extends OperationOptions>(
-  operationName: string,
-  operationOptions: T
-): { span: Span; updatedOptions: T } {
-  const tracer = getTracer();
-  const tracingOptions = operationOptions.tracingOptions || {};
-  const spanOptions: SpanOptions = {
-    ...tracingOptions.spanOptions,
-    kind: SpanKind.INTERNAL
-  };
-
-  const span = tracer.startSpan(`Azure.Communication.${operationName}`, spanOptions);
-
-  span.setAttribute("az.namespace", "Microsoft.Communication");
-
-  let newSpanOptions = tracingOptions.spanOptions || {};
-  if (span.isRecording()) {
-    newSpanOptions = {
-      ...tracingOptions.spanOptions,
-      parent: span.context(),
-      attributes: {
-        ...spanOptions.attributes,
-        "az.namespace": "Microsoft.Communication"
-      }
-    };
-  }
-
-  const newTracingOptions: OperationTracingOptions = {
-    ...tracingOptions,
-    spanOptions: newSpanOptions
-  };
-
-  const newOperationOptions: T = {
-    ...operationOptions,
-    tracingOptions: newTracingOptions
-  };
-
-  return {
-    span,
-    updatedOptions: newOperationOptions
-  };
-}
+export const createSpan = createSpanFunction({
+  packagePrefix: "Azure.Communication",
+  namespace: "Microsoft.Communication"
+});

sdk/communication/communication-sms/package.json

@@ -71,7 +71,7 @@
     "@azure/communication-common": "1.0.0-beta.6",
     "@azure/core-auth": "^1.2.0",
     "@azure/core-http": "^1.2.0",
-    "@azure/core-tracing": "1.0.0-preview.9",
+    "@azure/core-tracing": "1.0.0-beta.1",
     "@azure/logger": "^1.0.0",
     "@opentelemetry/api": "^0.10.2",
     "events": "^3.0.0",

sdk/communication/communication-sms/src/tracing.ts

@@ -1,57 +1,13 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { OperationOptions } from "@azure/core-http";
-import { getTracer } from "@azure/core-tracing";
-import { Span, SpanOptions, SpanKind } from "@opentelemetry/api";
-
-type OperationTracingOptions = OperationOptions["tracingOptions"];
+import { createSpanFunction } from "@azure/core-tracing";
 
 /**
  * Creates a span using the global tracer.
  * @internal
- * @param name - The name of the operation being performed.
- * @param tracingOptions - The options for the underlying http request.
  */
-export function createSpan<T extends OperationOptions>(
-  operationName: string,
-  operationOptions: T
-): { span: Span; updatedOptions: T } {
-  const tracer = getTracer();
-  const tracingOptions = operationOptions.tracingOptions || {};
-  const spanOptions: SpanOptions = {
-    ...tracingOptions.spanOptions,
-    kind: SpanKind.INTERNAL
-  };
-
-  const span = tracer.startSpan(`Azure.Communication.${operationName}`, spanOptions);
-
-  span.setAttribute("az.namespace", "Microsoft.Communication");
-
-  let newSpanOptions = tracingOptions.spanOptions || {};
-  if (span.isRecording()) {
-    newSpanOptions = {
-      ...tracingOptions.spanOptions,
-      parent: span.context(),
-      attributes: {
-        ...spanOptions.attributes,
-        "az.namespace": "Microsoft.Communication"
-      }
-    };
-  }
-
-  const newTracingOptions: OperationTracingOptions = {
-    ...tracingOptions,
-    spanOptions: newSpanOptions
-  };
-
-  const newOperationOptions: T = {
-    ...operationOptions,
-    tracingOptions: newTracingOptions
-  };
-
-  return {
-    span,
-    updatedOptions: newOperationOptions
-  };
-}
+export const createSpan = createSpanFunction({
+  packagePrefix: "Azure.Communication",
+  namespace: "Microsoft.Communication"
+});

sdk/core/core-client/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## 1.0.0-beta.2 (Unreleased)
 
+- [Breaking] Removed `createSpanFunction` and `SpanConfig`. These have been moved into
+  `@azure/core-tracing`.
+
 ## 1.0.0-beta.1 (2021-02-04)
 
 - First release of package, see README.md for details.

sdk/core/core-client/package.json

@@ -79,7 +79,7 @@
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-auth": "^1.2.0",
     "@azure/core-https": "1.0.0-beta.2",
-    "@azure/core-tracing": "1.0.0-preview.9",
+    "@azure/core-tracing": "1.0.0-beta.1",
     "@opentelemetry/api": "^0.10.2",
     "tslib": "^2.0.0"
   },