@azure/digital-twins-core 1.1.0-alpha.20220406.1 → 1.1.0-alpha.20220516.1

package/CHANGELOG.md

@@ -12,6 +12,12 @@
 
 ### Key Bugs Fixed
 
+### Other Changes
+
+- Updated our `@azure/core-tracing` dependency to the latest version (1.0.0).
+  - Notable changes include Removal of `@opentelemetry/api` as a transitive dependency and ensuring that the active context is properly propagated.
+  - Customers who would like to continue using OpenTelemetry driven tracing should visit our [OpenTelemetry Instrumentation](https://www.npmjs.com/package/@azure/opentelemetry-instrumentation-azure-sdk) package for instructions.
+
 ## 1.0.3 (2021-01-15)
 
 - Bug Fix: include the types definition file in the shipped package

package/dist/index.js

@@ -1919,14 +1919,19 @@ class AzureDigitalTwinsAPI extends AzureDigitalTwinsAPIContext {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+const SDK_VERSION = "1.1.0";
+
 // Copyright (c) Microsoft Corporation.
 /**
- * Creates a span using the global tracer.
+ * Creates a tracing client to manage tracing spans.
  * @internal
  */
-const createSpan = coreTracing.createSpanFunction({
-    packagePrefix: "DigitalTwinsClient",
+const tracingClient = coreTracing.createTracingClient({
     namespace: "Microsoft.DigitalTwins",
+    packageName: "@azure/digital-twins-core",
+    packageVersion: SDK_VERSION,
 });
 
 // Copyright (c) Microsoft Corporation.
@@ -1936,7 +1941,6 @@ const createSpan = coreTracing.createSpanFunction({
 const logger = logger$1.createClientLogger("azure-digitaltwins-core");
 
 // Copyright (c) Microsoft Corporation.
-const SDK_VERSION = "1.1.0";
 const DEFAULT_DIGITALTWINS_SCOPE = "https://digitaltwins.azure.net/.default";
 /**
  * Client for Azure IoT DigitalTwins API.
@@ -1992,20 +1996,9 @@ class DigitalTwinsClient {
      * @returns The application/json digital twin and the http response.
      */
     getDigitalTwin(digitalTwinId, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-getDigitalTwin", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.getDigitalTwin", options, async (updatedOptions) => {
             return this.client.digitalTwins.getById(digitalTwinId, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Create or update a digital twin
@@ -2017,21 +2010,10 @@ class DigitalTwinsClient {
      * @returns The created application/json digital twin and the http response.
      */
     upsertDigitalTwin(digitalTwinId, digitalTwinJson, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-upsertDigitalTwin", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.upsertDigitalTwin", options, async (updatedOptions) => {
             const payload = JSON.parse(digitalTwinJson);
             return this.client.digitalTwins.add(digitalTwinId, payload, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Update a digital twin using a json patch.
@@ -2047,20 +2029,9 @@ class DigitalTwinsClient {
     updateDigitalTwin(digitalTwinId, 
     // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types -- changing the type any would be a breaking change
     jsonPatch, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-updateDigitalTwin", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.updateDigitalTwin", options, async (updatedOptions) => {
             return this.client.digitalTwins.update(digitalTwinId, jsonPatch, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Delete a digital twin
@@ -2071,20 +2042,9 @@ class DigitalTwinsClient {
      * @returns The http response.
      */
     deleteDigitalTwin(digitalTwinId, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-deleteDigitalTwin", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.deleteDigitalTwin", options, async (updatedOptions) => {
             return this.client.digitalTwins.delete(digitalTwinId, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Get a component on a digital twin.
@@ -2095,20 +2055,9 @@ class DigitalTwinsClient {
      * @returns Json string representation of the component corresponding to the provided componentName and the HTTP response.
      */
     getComponent(digitalTwinId, componentName, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-getComponent", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.getComponent", options, async (updatedOptions) => {
             return this.client.digitalTwins.getComponent(digitalTwinId, componentName, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Update properties of a component on a digital twin using a JSON patch.
@@ -2122,20 +2071,9 @@ class DigitalTwinsClient {
      * @returns The http response.
      */
     updateComponent(digitalTwinId, componentName, jsonPatch, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-updateComponent", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.updateComponent", options, async (updatedOptions) => {
             return this.client.digitalTwins.updateComponent(digitalTwinId, componentName, jsonPatch, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Get a relationship on a digital twin.
@@ -2146,20 +2084,9 @@ class DigitalTwinsClient {
      * @returns The pageable list of application/json relationships belonging to the specified digital twin and the http response.
      */
     getRelationship(digitalTwinId, relationshipId, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-getRelationship", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.getRelationship", options, async (updatedOptions) => {
             return this.client.digitalTwins.getRelationshipById(digitalTwinId, relationshipId, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Create or update a relationship on a digital twin.
@@ -2173,20 +2100,9 @@ class DigitalTwinsClient {
     upsertRelationship(digitalTwinId, relationshipId, 
     // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types -- changing the type any would be a breaking change
     relationship, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-upsertRelationship", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.upsertRelationship", options, async (updatedOptions) => {
             return this.client.digitalTwins.addRelationship(digitalTwinId, relationshipId, relationship, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Updates the properties of a relationship on a digital twin using a JSON patch.
@@ -2198,20 +2114,9 @@ class DigitalTwinsClient {
      *   ifMatch: Only perform the operation if the entity's etag matches one of the etags provided or * is provided.
      */
     updateRelationship(digitalTwinId, relationshipId, jsonPatch, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-updateRelationship", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.updateRelationship", options, async (updatedOptions) => {
             return this.client.digitalTwins.updateRelationship(digitalTwinId, relationshipId, jsonPatch, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Delete a relationship on a digital twin.
@@ -2223,20 +2128,9 @@ class DigitalTwinsClient {
      * @returns The http response.
      */
     deleteRelationship(digitalTwinId, relationshipId, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-deleteRelationship", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.deleteRelationship", options, async (updatedOptions) => {
             return this.client.digitalTwins.deleteRelationship(digitalTwinId, relationshipId, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Deals with the pagination of {@link listRelationships}.
@@ -2292,29 +2186,16 @@ class DigitalTwinsClient {
      * @param digitalTwinId - The Id of the digital twin.
      */
     listRelationships(digitalTwinId, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-listRelationships", options);
-        try {
-            const iter = this.listRelationshipsAll(digitalTwinId, updatedOptions);
-            return {
-                next() {
-                    return iter.next();
-                },
-                [Symbol.asyncIterator]() {
-                    return this;
-                },
-                byPage: (settings = {}) => this.listRelationshipsPage(digitalTwinId, updatedOptions, settings),
-            };
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        const iter = this.listRelationshipsAll(digitalTwinId, options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: (settings = {}) => this.listRelationshipsPage(digitalTwinId, options, settings),
+        };
     }
     /**
      * Deals with the pagination of {@link listIncomingRelationships}.
@@ -2369,29 +2250,16 @@ class DigitalTwinsClient {
      * @param digitalTwinId - The Id of the digital twin.
      */
     listIncomingRelationships(digitalTwinId, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-listIncomingRelationships", options);
-        try {
-            const iter = this.listIncomingRelationshipsAll(digitalTwinId, updatedOptions);
-            return {
-                next() {
-                    return iter.next();
-                },
-                [Symbol.asyncIterator]() {
-                    return this;
-                },
-                byPage: (settings = {}) => this.listIncomingRelationshipsPage(digitalTwinId, updatedOptions, settings),
-            };
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        const iter = this.listIncomingRelationshipsAll(digitalTwinId, options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: (settings = {}) => this.listIncomingRelationshipsPage(digitalTwinId, options, settings),
+        };
     }
     /**
      * Publish telemetry from a digital twin, which is then consumed by one or many destination endpoints (subscribers) defined under.
@@ -2410,20 +2278,9 @@ class DigitalTwinsClient {
         if (!messageId) {
             messageId = coreHttp.generateUuid();
         }
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-publishTelemetry", digitalTwinsSendTelemetryOptionalParams);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.publishTelemetry", digitalTwinsSendTelemetryOptionalParams, async (updatedOptions) => {
             return this.client.digitalTwins.sendTelemetry(digitalTwinId, messageId, payload, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Publish telemetry from a digital twin's component, which is then consumed by one or many destination endpoints (subscribers) defined under.
@@ -2441,20 +2298,9 @@ class DigitalTwinsClient {
         if (!messageId) {
             messageId = coreHttp.generateUuid();
         }
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-publishComponentTelemetry", digitalTwinsSendComponentTelemetryOptionalParams);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.publishComponentTelemetry", digitalTwinsSendComponentTelemetryOptionalParams, async (updatedOptions) => {
             return this.client.digitalTwins.sendComponentTelemetry(digitalTwinId, componentName, payload, messageId, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Get a model, including the model metadata and the model definition.
@@ -2467,20 +2313,9 @@ class DigitalTwinsClient {
     getModel(modelId, includeModelDefinition = false, options = {}) {
         const digitalTwinModelsGetByIdOptionalParams = options;
         digitalTwinModelsGetByIdOptionalParams.includeModelDefinition = includeModelDefinition;
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-getModel", digitalTwinModelsGetByIdOptionalParams);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.getModel", digitalTwinModelsGetByIdOptionalParams, async (updatedOptions) => {
             return this.client.digitalTwinModels.getById(modelId, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Deals with the pagination of {@link list}.
@@ -2546,29 +2381,16 @@ class DigitalTwinsClient {
             dependenciesFor: dependeciesFor,
             includeModelDefinition: includeModelDefinition,
         };
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-listModels", digitalTwinModelsListOptionalParams);
-        try {
-            const iter = this.getModelsAll(updatedOptions);
-            return {
-                next() {
-                    return iter.next();
-                },
-                [Symbol.asyncIterator]() {
-                    return this;
-                },
-                byPage: (settings = {}) => this.getModelsPage(digitalTwinModelsListOptionalParams, settings),
-            };
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        const iter = this.getModelsAll(digitalTwinModelsListOptionalParams);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: (settings = {}) => this.getModelsPage(digitalTwinModelsListOptionalParams, settings),
+        };
     }
     /**
      * Create one or many
@@ -2580,20 +2402,9 @@ class DigitalTwinsClient {
     createModels(dtdlModels, options = {}) {
         const digitalTwinModelsAddOptionalParams = options;
         digitalTwinModelsAddOptionalParams.models = dtdlModels;
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-createModels", digitalTwinModelsAddOptionalParams);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.createModels", digitalTwinModelsAddOptionalParams, async (updatedOptions) => {
             return this.client.digitalTwinModels.add(updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Decommission a model using a json patch.
@@ -2609,20 +2420,9 @@ class DigitalTwinsClient {
      */
     decommissionModel(modelId, options = {}) {
         const jsonPatch = [{ op: "replace", path: "/decommissioned", value: true }];
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-decommissionModel", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.decommissionModel", options, async (updatedOptions) => {
             return this.client.digitalTwinModels.update(modelId, jsonPatch, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Delete a model.
@@ -2632,20 +2432,9 @@ class DigitalTwinsClient {
      * @returns The http response.
      */
     deleteModel(modelId, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-deleteModel", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.deleteModel", options, async (updatedOptions) => {
             return this.client.digitalTwinModels.delete(modelId, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Get an event route.
@@ -2655,20 +2444,9 @@ class DigitalTwinsClient {
      * @returns The application/json event route and the http response.
      */
     getEventRoute(eventRouteId, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-getEventRoute", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.getEventRoute", options, async (updatedOptions) => {
             return this.client.eventRoutes.getById(eventRouteId, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Deals with the pagination of {@link list}.
@@ -2731,29 +2509,16 @@ class DigitalTwinsClient {
         eventRoutesListOptionalParams = {
             maxItemsPerPage: resultsPerPage,
         };
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-listEventRoutes", eventRoutesListOptionalParams);
-        try {
-            const iter = this.getEventRoutesAll(updatedOptions);
-            return {
-                next() {
-                    return iter.next();
-                },
-                [Symbol.asyncIterator]() {
-                    return this;
-                },
-                byPage: (settings = {}) => this.getEventRoutesPage(eventRoutesListOptionalParams, settings),
-            };
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        const iter = this.getEventRoutesAll(eventRoutesListOptionalParams);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: (settings = {}) => this.getEventRoutesPage(eventRoutesListOptionalParams, settings),
+        };
     }
     /**
      * Create or update an event route.
@@ -2771,20 +2536,9 @@ class DigitalTwinsClient {
             filter: filter,
         };
         eventRoutesAddOptionalParams.eventRoute = eventRoute;
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-upsertEventRoute", eventRoutesAddOptionalParams);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.upsertEventRoute", eventRoutesAddOptionalParams, async (updatedOptions) => {
             return this.client.eventRoutes.add(eventRouteId, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Delete an event route.
@@ -2794,20 +2548,9 @@ class DigitalTwinsClient {
      * @returns The http response.
      */
     deleteEventRoute(eventRouteId, options = {}) {
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-deleteEventRoute", options);
-        try {
+        return tracingClient.withSpan("DigitalTwinsClient.deleteEventRoute", options, async (updatedOptions) => {
             return this.client.eventRoutes.delete(eventRouteId, updatedOptions);
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        });
     }
     /**
      * Deals with the pagination of {@link query}.
@@ -2879,29 +2622,16 @@ class DigitalTwinsClient {
         queryQueryTwinsOptionalParams = {
             maxItemsPerPage: resultsPerPage,
         };
-        const { span, updatedOptions } = createSpan("DigitalTwinsClient-queryTwins", queryQueryTwinsOptionalParams);
-        try {
-            const iter = this.queryTwinsAll(query, updatedOptions);
-            return {
-                next() {
-                    return iter.next();
-                },
-                [Symbol.asyncIterator]() {
-                    return this;
-                },
-                byPage: (settings = {}) => this.queryTwinsPage(query, queryQueryTwinsOptionalParams, settings),
-            };
-        }
-        catch (e) {
-            span.setStatus({
-                code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message,
-            });
-            throw e;
-        }
-        finally {
-            span.end();
-        }
+        const iter = this.queryTwinsAll(query, queryQueryTwinsOptionalParams);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: (settings = {}) => this.queryTwinsPage(query, queryQueryTwinsOptionalParams, settings),
+        };
     }
 }