[TypeScript][BotBuilder-Solutions] Update telemetry integration (#1322)

* Update telemetry integration

* Update telemetry implementation in sample-assistant

* Update telemetry implementation in sample-skill

* Update version of botbuilder-libs

* Update VA template

* Update skill template

Author: enzocano

lib/typescript/botbuilder-skills/package.json

@@ -1,6 +1,6 @@
 {
     "name": "botbuilder-skills",
-    "version": "4.4.3",
+    "version": "4.4.5",
     "description": "Shared library for building Conversational AI Skills.",
     "author": "Microsoft",
     "license": "MIT",
@@ -20,7 +20,7 @@
         "botbuilder-azure": "^4.4.0",
         "botbuilder-core": "^4.4.0",
         "botbuilder-dialogs": "^4.4.0",
-        "botbuilder-solutions": "^4.4.3",
+        "botbuilder-solutions": "^4.4.5",
         "botframework-config": "^4.4.0",
         "botframework-connector": "^4.4.0",
         "botframework-schema": "^4.4.0",

lib/typescript/botbuilder-skills/src/http/skillHttpAdapter.ts

@@ -1,6 +1,5 @@
 import { BotFrameworkAdapter, BotFrameworkAdapterSettings, BotTelemetryClient, InvokeResponse,
     Severity, TurnContext, WebRequest, WebResponse } from 'botbuilder';
-import { TelemetryExtensions } from 'botbuilder-solutions';
 import { Activity } from 'botframework-schema';
 import { IActivityHandler } from '../activityHandler';
 import { IAuthenticationProvider } from '../auth';
@@ -52,7 +51,10 @@ export class SkillHttpAdapter extends BotFrameworkAdapter {
 
         if (this.telemetryClient) {
             const message: string = `SkillHttpAdapter: Processing incoming activity. Activity id: ${activity.id}`;
-            TelemetryExtensions.trackTraceEx(this.telemetryClient, message, Severity.Information, activity);
+            this.telemetryClient.trackTrace({
+                message: message,
+                severityLevel: Severity.Information
+            });
         }
 
         // process the inbound activity with the bot

lib/typescript/botbuilder-skills/src/http/skillHttpBotAdapter.ts

@@ -1,5 +1,5 @@
 import { BotAdapter, BotTelemetryClient, InvokeResponse, Severity, TurnContext } from 'botbuilder';
-import { ActivityExtensions, IRemoteUserTokenProvider, TelemetryExtensions } from 'botbuilder-solutions';
+import { ActivityExtensions, IRemoteUserTokenProvider } from 'botbuilder-solutions';
 import { Activity, ActivityTypes, ConversationReference, ResourceResponse } from 'botframework-schema';
 import { v4 as uuid } from 'uuid';
 import { BotCallbackHandler, IActivityHandler } from '../activityHandler';
@@ -62,15 +62,21 @@ export class SkillHttpBotAdapter extends BotAdapter implements IActivityHandler,
 
     public async processActivity(activity: Activity, callback: BotCallbackHandler): Promise<InvokeResponse> {
         const messageIn: string = `SkillHttpBotAdapter: Received an incoming activity. Activity id: ${activity.id}`;
-        TelemetryExtensions.trackTraceEx(this.telemetryClient, messageIn, Severity.Information, activity);
+        this.telemetryClient.trackTrace({
+            message: messageIn,
+            severityLevel: Severity.Information
+        });
 
         // Process the Activity through the Middleware and the Bot, this will generate Activities which we need to send back.
         const context: TurnContext = new TurnContext(this, activity);
 
         await this.runMiddleware(context, callback);
 
         const messageOut: string = `SkillHttpBotAdapter: Batching activities in the response. ReplyToId: ${activity.id}`;
-        TelemetryExtensions.trackTraceEx(this.telemetryClient, messageOut, Severity.Information, activity);
+        this.telemetryClient.trackTrace({
+            message: messageOut,
+            severityLevel: Severity.Information
+        });
 
         // Any Activity responses are now available (via SendActivitiesAsync) so we need to pass back for the response
         return {

lib/typescript/botbuilder-skills/src/websocket/skillWebSocketBotAdapter.ts

@@ -1,6 +1,6 @@
 import { BotAdapter, BotTelemetryClient, InvokeResponse, Middleware, NullTelemetryClient,
     ResourceResponse, Severity, TurnContext } from 'botbuilder';
-import { ActivityExtensions, IRemoteUserTokenProvider, TelemetryExtensions, TokenEvents } from 'botbuilder-solutions';
+import { ActivityExtensions, IRemoteUserTokenProvider, TokenEvents } from 'botbuilder-solutions';
 import { Activity, ActivityTypes, ConversationReference } from 'botframework-schema';
 import { CancellationToken, ContentStream, ReceiveResponse, Request } from 'microsoft-bot-protocol';
 import { Server } from 'microsoft-bot-protocol-websocket';
@@ -33,7 +33,10 @@ export class SkillWebSocketBotAdapter extends BotAdapter implements IActivityHan
      */
     public async processActivity(activity: Activity, callback: BotCallbackHandler): Promise<InvokeResponse> {
         const message: string = `Received an incoming activity. ActivityId: ${activity.id}`;
-        TelemetryExtensions.trackTraceEx(this.telemetryClient, message, Severity.Information, activity);
+        this.telemetryClient.trackTrace({
+            message: message,
+            severityLevel: Severity.Information
+        });
 
         const context: TurnContext = new TurnContext(this, activity);
         await this.runMiddleware(context, callback);
@@ -79,7 +82,10 @@ export class SkillWebSocketBotAdapter extends BotAdapter implements IActivityHan
                 request.setBody(activity);
 
                 const message: string = `Sending activity. ReplyToId: ${activity.replyToId}`;
-                TelemetryExtensions.trackTraceEx(this.telemetryClient, message, Severity.Information, activity);
+                this.telemetryClient.trackTrace({
+                    message: message,
+                    severityLevel: Severity.Information
+                });
 
                 const begin: [number, number] = process.hrtime();
                 response = await this.sendRequest<ResourceResponse>(request);
@@ -88,7 +94,10 @@ export class SkillWebSocketBotAdapter extends BotAdapter implements IActivityHan
                 const latency: { latency: number } = { latency: toMilliseconds(end) };
 
                 const event: string = 'SkillWebSocketSendActivityLatency';
-                TelemetryExtensions.trackEventEx(this.telemetryClient, event, activity, undefined, undefined, latency);
+                this.telemetryClient.trackEvent({
+                    name: event,
+                    metrics: latency
+                });
 
                 // If No response is set, then default to a "simple" response. This can't really be done
                 // above, as there are cases where the ReplyTo/SendTo methods will also return null
@@ -111,7 +120,10 @@ export class SkillWebSocketBotAdapter extends BotAdapter implements IActivityHan
         request.setBody(activity);
 
         const message: string = `Updating activity. activity id: ${activity.replyToId}`;
-        TelemetryExtensions.trackTraceEx(this.telemetryClient, message, Severity.Information, activity);
+        this.telemetryClient.trackTrace({
+            message: message,
+            severityLevel: Severity.Information
+        });
 
         const begin: [number, number] = process.hrtime();
         await this.sendRequest<ResourceResponse>(request);
@@ -120,23 +132,33 @@ export class SkillWebSocketBotAdapter extends BotAdapter implements IActivityHan
         const latency: { latency: number } = { latency: toMilliseconds(end) };
 
         const event: string = 'SkillWebSocketUpdateActivityLatency';
-        TelemetryExtensions.trackEventEx(this.telemetryClient, event, activity, undefined, undefined, latency);
+        this.telemetryClient.trackEvent({
+            name: event,
+            metrics: latency
+        });
     }
 
     public async deleteActivity(context: TurnContext, reference: Partial<ConversationReference>): Promise<void> {
         const requestPath: string = `/activities/${reference.activityId}`;
         const request: Request = Request.create('DELETE', requestPath);
 
         const message: string = `Deleting activity. activity id: ${reference.activityId}`;
-        TelemetryExtensions.trackTraceEx(this.telemetryClient, message, Severity.Information, {});
+        this.telemetryClient.trackTrace({
+            message: message,
+            severityLevel: Severity.Information
+        });
 
         const begin: [number, number] = process.hrtime();
         await this.sendRequest<ResourceResponse>(request);
         const end: [number, number] = process.hrtime(begin);
 
         const latency: { latency: number } = { latency: toMilliseconds(end) };
 
-        TelemetryExtensions.trackEventEx(this.telemetryClient, 'SkillWebSocketDeleteActivityLatency', {}, undefined, undefined, latency);
+        const event: string = 'SkillWebSocketDeleteActivityLatency';
+        this.telemetryClient.trackEvent({
+            name: event,
+            metrics: latency
+        });
     }
 
     public async continueConversation(reference: Partial<ConversationReference>, logic: BotCallbackHandler): Promise<void> {
@@ -167,7 +189,10 @@ export class SkillWebSocketBotAdapter extends BotAdapter implements IActivityHan
                 return JSON.parse(body);
             }
         } catch (error) {
-            TelemetryExtensions.trackExceptionEx(this.telemetryClient, error, {});
+            this.telemetryClient.trackException({
+                exception: error,
+                handledAt: SkillWebSocketBotAdapter.name
+            });
 
             throw error;
         }

lib/typescript/botbuilder-skills/src/websocket/skillWebSocketRequestHandler.ts

@@ -4,7 +4,6 @@
  */
 
 import { BotTelemetryClient, InvokeResponse } from 'botbuilder';
-import { TelemetryExtensions } from 'botbuilder-solutions';
 import { Activity } from 'botframework-schema';
 import { ContentStream, ReceiveRequest, RequestHandler, Response } from 'microsoft-bot-protocol';
 import { BotCallbackHandler, IActivityHandler } from '../activityHandler';
@@ -50,7 +49,10 @@ export class SkillWebSocketRequestHandler extends RequestHandler {
             const latency: { latency: number } = { latency: toMilliseconds(end) };
 
             const event: string = 'SkillWebSocketProcessRequestLatency';
-            TelemetryExtensions.trackEventEx(this.telemetryClient, event, activity, undefined, undefined, latency);
+            this.telemetryClient.trackEvent({
+                name: event,
+                metrics: latency
+            });
 
             if (!invokeResponse) {
                 response.statusCode = 200;
@@ -61,7 +63,7 @@ export class SkillWebSocketRequestHandler extends RequestHandler {
                 }
             }
         } catch (error) {
-            TelemetryExtensions.trackExceptionEx(this.telemetryClient, error, {});
+            this.telemetryClient.trackException({ exception: error });
             response.statusCode = 500;
         }
 

lib/typescript/botbuilder-solutions/package.json

@@ -1,6 +1,6 @@
 {
     "name": "botbuilder-solutions",
-    "version": "4.4.3",
+    "version": "4.4.5",
     "description": "Shared library for Conversational AI Virtual Assistants and Skills.",
     "author": "Microsoft",
     "license": "MIT",

lib/typescript/botbuilder-solutions/src/cognitiveModelSet.ts

@@ -3,10 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { ITelemetryLuisRecognizer, ITelemetryQnAMaker } from './telemetry';
+import { LuisRecognizerTelemetryClient, QnAMakerTelemetryClient } from 'botbuilder-ai';
 
 export interface ICognitiveModelSet {
-    dispatchService: ITelemetryLuisRecognizer;
-    luisServices: Map<string, ITelemetryLuisRecognizer>;
-    qnaServices: Map<string, ITelemetryQnAMaker>;
+    dispatchService: LuisRecognizerTelemetryClient;
+    luisServices: Map<string, LuisRecognizerTelemetryClient>;
+    qnaServices: Map<string, QnAMakerTelemetryClient>;
 }

lib/typescript/botbuilder-solutions/src/index.ts

@@ -15,7 +15,6 @@ export * from './resources';
 export * from './responses';
 export * from './skills';
 export * from './taskExtensions';
-export * from './telemetry';
 export * from './util';
 export * from './botSettings';
 export * from './cognitiveModelSet';