[Schema Registry] Use tracing (Azure#21256)

* [Schema Registry] Use tracing

* address feedback

* address feedback

Author: deyaaeldeen

sdk/schemaregistry/schema-registry/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 1.0.2 (Unreleased)
 
 ### Features Added
+- Added support for distributed tracing using OpenTelemetry - please refer to the [@azure/opentelemetry-instrumentation-azure-sdk](https://www.npmjs.com/package/@azure/opentelemetry-instrumentation-azure-sdk) package for instructions.
 
 ### Breaking Changes
 

sdk/schemaregistry/schema-registry/package.json

@@ -48,6 +48,10 @@
       {
         "path": "swagger/README.md",
         "prefix": "package-version"
+      },
+      {
+        "path": "src/constants.ts",
+        "prefix": "SDK_VERSION"
       }
     ]
   },
@@ -83,7 +87,7 @@
     "@azure/core-rest-pipeline": "^1.1.0",
     "@azure/core-client": "^1.0.0",
     "@azure/core-auth": "^1.3.0",
-    "@azure/core-tracing": "1.0.0-preview.13",
+    "@azure/core-tracing": "^1.0.0",
     "@azure/logger": "^1.0.0",
     "tslib": "^2.2.0"
   },

sdk/schemaregistry/schema-registry/src/constants.ts

@@ -1,4 +1,12 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
+/**
+ * @internal
+ */
 export const DEFAULT_SCOPE = "https://eventhubs.azure.net/.default";
+
+/**
+ * @internal
+ */
+export const SDK_VERSION = "1.0.2";

sdk/schemaregistry/schema-registry/src/schemaRegistryClient.ts

@@ -3,6 +3,7 @@
 
 import { GeneratedSchemaRegistryClient } from "./generated/generatedSchemaRegistryClient";
 import { TokenCredential } from "@azure/core-auth";
+import { createTracingClient, TracingClient } from "@azure/core-tracing";
 import {
   bearerTokenAuthenticationPolicy,
   InternalPipelineOptions,
@@ -19,7 +20,7 @@ import {
   SchemaProperties,
   Schema,
 } from "./models";
-import { DEFAULT_SCOPE } from "./constants";
+import { DEFAULT_SCOPE, SDK_VERSION } from "./constants";
 import { logger } from "./logger";
 
 /**
@@ -30,7 +31,10 @@ export class SchemaRegistryClient implements SchemaRegistry {
   readonly fullyQualifiedNamespace: string;
 
   /** Underlying autorest generated client. */
-  private readonly client: GeneratedSchemaRegistryClient;
+  private readonly _client: GeneratedSchemaRegistryClient;
+
+  /** The tracing client */
+  private readonly _tracing: TracingClient;
 
   /**
    * Creates a new client for Azure Schema Registry service.
@@ -56,14 +60,20 @@ export class SchemaRegistryClient implements SchemaRegistry {
       },
     };
 
-    this.client = new GeneratedSchemaRegistryClient(this.fullyQualifiedNamespace, {
+    this._client = new GeneratedSchemaRegistryClient(this.fullyQualifiedNamespace, {
       endpoint: this.fullyQualifiedNamespace,
       apiVersion: options.apiVersion,
       ...internalPipelineOptions,
     });
 
+    this._tracing = createTracingClient({
+      namespace: "Microsoft.EventHub",
+      packageName: "@azure/schema-registry",
+      packageVersion: SDK_VERSION,
+    });
+
     const authPolicy = bearerTokenAuthenticationPolicy({ credential, scopes: DEFAULT_SCOPE });
-    this.client.pipeline.addPolicy(authPolicy);
+    this._client.pipeline.addPolicy(authPolicy);
   }
 
   /**
@@ -76,20 +86,25 @@ export class SchemaRegistryClient implements SchemaRegistry {
    * @param schema - Schema to register.
    * @returns Registered schema's ID.
    */
-  async registerSchema(
+  registerSchema(
     schema: SchemaDescription,
-    options?: RegisterSchemaOptions
+    options: RegisterSchemaOptions = {}
   ): Promise<SchemaProperties> {
     const { groupName, name: schemaName, definition: schemaContent, format } = schema;
-    return this.client.schema
-      .register(
-        groupName,
-        schemaName,
-        `application/json; serialization=${format}`,
-        schemaContent,
-        options
-      )
-      .then(convertSchemaIdResponse(format));
+    return this._tracing.withSpan(
+      "SchemaRegistryClient.registerSchema",
+      options,
+      (updatedOptions) =>
+        this._client.schema
+          .register(
+            groupName,
+            schemaName,
+            `application/json; serialization=${format}`,
+            schemaContent,
+            updatedOptions
+          )
+          .then(convertSchemaIdResponse(format))
+    );
   }
 
   /**
@@ -99,20 +114,25 @@ export class SchemaRegistryClient implements SchemaRegistry {
    * @param schema - Schema to match.
    * @returns Matched schema's ID.
    */
-  async getSchemaProperties(
+  getSchemaProperties(
     schema: SchemaDescription,
-    options?: GetSchemaPropertiesOptions
+    options: GetSchemaPropertiesOptions = {}
   ): Promise<SchemaProperties> {
     const { groupName, name: schemaName, definition: schemaContent, format } = schema;
-    return this.client.schema
-      .queryIdByContent(
-        groupName,
-        schemaName,
-        `application/json; serialization=${format}`,
-        schemaContent,
-        options
-      )
-      .then(convertSchemaIdResponse(format));
+    return this._tracing.withSpan(
+      "SchemaRegistryClient.getSchemaProperties",
+      options,
+      (updatedOptions) =>
+        this._client.schema
+          .queryIdByContent(
+            groupName,
+            schemaName,
+            `application/json; serialization=${format}`,
+            schemaContent,
+            updatedOptions
+          )
+          .then(convertSchemaIdResponse(format))
+    );
   }
 
   /**
@@ -132,7 +152,9 @@ export class SchemaRegistryClient implements SchemaRegistry {
    * @param schemaId - Unique schema ID.
    * @returns Schema with given ID.
    */
-  async getSchema(schemaId: string, options?: GetSchemaOptions): Promise<Schema> {
-    return this.client.schema.getById(schemaId, options).then(convertSchemaResponse);
+  getSchema(schemaId: string, options: GetSchemaOptions = {}): Promise<Schema> {
+    return this._tracing.withSpan("SchemaRegistryClient.getSchema", options, (updatedOptions) =>
+      this._client.schema.getById(schemaId, updatedOptions).then(convertSchemaResponse)
+    );
   }
 }