-
Notifications
You must be signed in to change notification settings - Fork 275
/
telemetryLoggerMiddleware.ts
412 lines (357 loc) · 16.6 KB
/
telemetryLoggerMiddleware.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License
import { BotTelemetryClient, NullTelemetryClient } from './botTelemetryClient';
import { Middleware } from './middlewareSet';
import { TelemetryConstants } from './telemetryConstants';
import { TurnContext } from './turnContext';
import {
Activity,
ActivityTypes,
ConversationReference,
ResourceResponse,
TeamsChannelData,
} from 'botframework-schema';
// Internal helper duplicated from
// https://github.com/microsoft/botbuilder-js/commit/9277f901701ef270cf5af089e37e7aa7ab2579e1
function isTeamsChannelData(channelData: unknown): channelData is TeamsChannelData {
return typeof channelData === 'object';
}
/**
* Middleware for logging incoming, outgoing, updated or deleted Activity messages.
* Uses the botTelemetryClient interface.
*/
export class TelemetryLoggerMiddleware implements Middleware {
/**
* The name of the event when when new message is received from the user.
*/
static readonly botMsgReceiveEvent: string = 'BotMessageReceived';
/**
* The name of the event when a message is updated by the bot.
*/
static readonly botMsgSendEvent: string = 'BotMessageSend';
/**
* The name of the event when a message is updated by the bot.
*/
static readonly botMsgUpdateEvent: string = 'BotMessageUpdate';
/**
* The name of the event when a message is deleted by the bot.
*/
static readonly botMsgDeleteEvent: string = 'BotMessageDelete';
private readonly _telemetryClient: BotTelemetryClient;
private readonly _logPersonalInformation: boolean;
/**
* Initializes a new instance of the TelemetryLoggerMiddleware class.
*
* @param telemetryClient The BotTelemetryClient used for logging.
* @param logPersonalInformation (Optional) Enable/Disable logging original message name within Application Insights.
*/
constructor(telemetryClient: BotTelemetryClient, logPersonalInformation = false) {
this._telemetryClient = telemetryClient || new NullTelemetryClient();
this._logPersonalInformation = logPersonalInformation;
}
/**
* Gets a value indicating whether to log personal information that came from the user.
*
* @returns A value indicating whether to log personal information or not.
*/
get logPersonalInformation(): boolean {
return this._logPersonalInformation;
}
/**
* Gets the currently configured botTelemetryClient that logs the events.
*
* @returns The currently configured [BotTelemetryClient](xref:botbuilder-core.BotTelemetryClient) that logs the events.
*/
get telemetryClient(): BotTelemetryClient {
return this._telemetryClient;
}
/**
* Logs events based on incoming and outgoing activities using the botTelemetryClient class.
*
* @param context The context object for this turn.
* @param next The delegate to call to continue the bot middleware pipeline
*/
async onTurn(context: TurnContext, next: () => Promise<void>): Promise<void> {
if (context === null) {
throw new Error('context is null');
}
context.turnState.set('telemetryClient', this.telemetryClient);
// log incoming activity at beginning of turn
if (context.activity !== null) {
const activity: Activity = context.activity;
// Log Bot Message Received
await this.onReceiveActivity(activity);
}
// hook up onSend pipeline
context.onSendActivities(
async (
ctx: TurnContext,
activities: Partial<Activity>[],
nextSend: () => Promise<ResourceResponse[]>
): Promise<ResourceResponse[]> => {
// run full pipeline
const responses: ResourceResponse[] = await nextSend();
activities.forEach(async (act: Partial<Activity>) => {
await this.onSendActivity(<Activity>act);
});
return responses;
}
);
// hook up update activity pipeline
context.onUpdateActivity(
async (ctx: TurnContext, activity: Partial<Activity>, nextUpdate: () => Promise<void>) => {
// run full pipeline
const response: void = await nextUpdate();
await this.onUpdateActivity(<Activity>activity);
return response;
}
);
// hook up delete activity pipeline
context.onDeleteActivity(
async (ctx: TurnContext, reference: Partial<ConversationReference>, nextDelete: () => Promise<void>) => {
// run full pipeline
await nextDelete();
const deletedActivity: Partial<Activity> = TurnContext.applyConversationReference(
{
type: ActivityTypes.MessageDelete,
id: reference.activityId,
},
reference,
false
);
await this.onDeleteActivity(<Activity>deletedActivity);
}
);
if (next !== null) {
await next();
}
}
/**
* Invoked when a message is received from the user.
* Performs logging of telemetry data using the IBotTelemetryClient.TrackEvent() method.
* The event name logged is "BotMessageReceived".
*
* @param activity Current activity sent from user.
*/
protected async onReceiveActivity(activity: Activity): Promise<void> {
this.telemetryClient.trackEvent({
name: TelemetryLoggerMiddleware.botMsgReceiveEvent,
properties: await this.fillReceiveEventProperties(activity),
});
}
/**
* Invoked when the bot sends a message to the user.
* Performs logging of telemetry data using the botTelemetryClient.trackEvent() method.
* The event name logged is "BotMessageSend".
*
* @param activity Last activity sent from user.
*/
protected async onSendActivity(activity: Activity): Promise<void> {
this.telemetryClient.trackEvent({
name: TelemetryLoggerMiddleware.botMsgSendEvent,
properties: await this.fillSendEventProperties(<Activity>activity),
});
}
/**
* Invoked when the bot updates a message.
* Performs logging of telemetry data using the botTelemetryClient.trackEvent() method.
* The event name used is "BotMessageUpdate".
*
* @param activity Current activity sent from user.
*/
protected async onUpdateActivity(activity: Activity): Promise<void> {
this.telemetryClient.trackEvent({
name: TelemetryLoggerMiddleware.botMsgUpdateEvent,
properties: await this.fillUpdateEventProperties(<Activity>activity),
});
}
/**
* Invoked when the bot deletes a message.
* Performs logging of telemetry data using the botTelemetryClient.trackEvent() method.
* The event name used is "BotMessageDelete".
*
* @param activity Current activity sent from user.
*/
protected async onDeleteActivity(activity: Activity): Promise<void> {
this.telemetryClient.trackEvent({
name: TelemetryLoggerMiddleware.botMsgDeleteEvent,
properties: await this.fillDeleteEventProperties(<Activity>activity),
});
}
/**
* Fills the Application Insights Custom Event properties for BotMessageReceived.
* These properties are logged in the custom event when a new message is received from the user.
*
* @param activity Last activity sent from user.
* @param telemetryProperties Additional properties to add to the event.
* @returns A dictionary that is sent as "Properties" to botTelemetryClient.trackEvent method.
*/
protected async fillReceiveEventProperties(
activity: Activity,
telemetryProperties?: Record<string, string>
): Promise<Record<string, string>> {
const properties: Record<string, string> = {};
if (activity) {
properties[TelemetryConstants.fromIdProperty] = activity.from?.id ?? '';
properties[TelemetryConstants.conversationIdProperty] = activity.conversation?.id ?? '';
properties[TelemetryConstants.conversationNameProperty] = activity.conversation?.name ?? '';
properties[TelemetryConstants.localeProperty] = activity.locale ?? '';
properties[TelemetryConstants.recipientIdProperty] = activity.recipient?.id ?? '';
properties[TelemetryConstants.recipientNameProperty] = activity.recipient?.name ?? '';
properties[TelemetryConstants.activityTypeProperty] = activity.type ?? '';
properties[TelemetryConstants.activityIdProperty] = activity.id ?? '';
// Use the LogPersonalInformation flag to toggle logging PII data, text and user name are common examples
if (this.logPersonalInformation) {
const fromName = activity.from?.name?.trim();
if (fromName) {
properties[TelemetryConstants.fromNameProperty] = fromName;
}
const activityText = activity.text?.trim();
if (activityText) {
properties[TelemetryConstants.textProperty] = activityText;
}
const activitySpeak = activity.speak?.trim();
if (activitySpeak) {
properties[TelemetryConstants.speakProperty] = activitySpeak;
}
}
// Additional Properties can override "stock" properties.
if (telemetryProperties) {
return Object.assign({}, properties, telemetryProperties);
}
}
this.populateAdditionalChannelProperties(activity, properties);
// Additional Properties can override "stock" properties.
if (telemetryProperties) {
return Object.assign({}, properties, telemetryProperties);
}
return properties;
}
/**
* Fills the Application Insights Custom Event properties for BotMessageSend.
* These properties are logged in the custom event when a response message is sent by the Bot to the user.
*
* @param activity - Last activity sent from user.
* @param telemetryProperties Additional properties to add to the event.
* @returns A dictionary that is sent as "Properties" to botTelemetryClient.trackEvent method.
*/
protected async fillSendEventProperties(
activity: Activity,
telemetryProperties?: Record<string, string>
): Promise<Record<string, string>> {
const properties: Record<string, string> = {};
if (activity) {
properties[TelemetryConstants.replyActivityIdProperty] = activity.replyToId ?? '';
properties[TelemetryConstants.recipientIdProperty] = activity.recipient?.id ?? '';
properties[TelemetryConstants.conversationIdProperty] = activity.conversation?.id ?? '';
properties[TelemetryConstants.conversationNameProperty] = activity.conversation?.name ?? '';
properties[TelemetryConstants.localeProperty] = activity.locale ?? '';
properties[TelemetryConstants.activityTypeProperty] = activity.type ?? '';
properties[TelemetryConstants.activityIdProperty] = activity.id ?? '';
// Use the LogPersonalInformation flag to toggle logging PII data, text and user name are common examples
if (this.logPersonalInformation) {
const recipientName = activity.recipient?.name?.trim();
if (recipientName) {
properties[TelemetryConstants.recipientNameProperty] = recipientName;
}
const activityText = activity.text?.trim();
if (activityText) {
properties[TelemetryConstants.textProperty] = activityText;
}
const activitySpeak = activity.speak?.trim();
if (activitySpeak) {
properties[TelemetryConstants.speakProperty] = activitySpeak;
}
if (activity.attachments?.length) {
properties[TelemetryConstants.attachmentsProperty] = JSON.stringify(activity.attachments);
}
}
// Additional Properties can override "stock" properties.
if (telemetryProperties) {
return Object.assign({}, properties, telemetryProperties);
}
}
return properties;
}
/**
* Fills the event properties for BotMessageUpdate.
* These properties are logged when an activity message is updated by the Bot.
* For example, if a card is interacted with by the use, and the card needs to be updated to reflect
* some interaction.
*
* @param activity - Last activity sent from user.
* @param telemetryProperties Additional properties to add to the event.
* @returns A dictionary that is sent as "Properties" to botTelemetryClient.trackEvent method.
*/
protected async fillUpdateEventProperties(
activity: Activity,
telemetryProperties?: Record<string, string>
): Promise<Record<string, string>> {
const properties: Record<string, string> = {};
if (activity) {
properties[TelemetryConstants.recipientIdProperty] = activity.recipient?.id ?? '';
properties[TelemetryConstants.conversationIdProperty] = activity.conversation?.id ?? '';
properties[TelemetryConstants.conversationNameProperty] = activity.conversation?.name ?? '';
properties[TelemetryConstants.localeProperty] = activity.locale ?? '';
properties[TelemetryConstants.activityTypeProperty] = activity.type ?? '';
properties[TelemetryConstants.activityIdProperty] = activity.id ?? '';
// Use the LogPersonalInformation flag to toggle logging PII data, text is a common example
if (this.logPersonalInformation) {
const activityText = activity.text?.trim();
if (activityText) {
properties[TelemetryConstants.textProperty] = activityText;
}
}
// Additional Properties can override "stock" properties.
if (telemetryProperties) {
return Object.assign({}, properties, telemetryProperties);
}
}
return properties;
}
/**
* Fills the Application Insights Custom Event properties for BotMessageDelete.
* These properties are logged in the custom event when an activity message is deleted by the Bot. This is a relatively rare case.
*
* @param activity - Last activity sent from user.
* @param telemetryProperties Additional properties to add to the event.
* @returns A dictionary that is sent as "Properties" to botTelemetryClient.trackEvent method.
*/
protected async fillDeleteEventProperties(
activity: Activity,
telemetryProperties?: Record<string, string>
): Promise<Record<string, string>> {
const properties: Record<string, string> = {};
if (activity) {
properties[TelemetryConstants.channelIdProperty] = activity.channelId ?? '';
properties[TelemetryConstants.recipientIdProperty] = activity.recipient?.id ?? '';
properties[TelemetryConstants.conversationIdProperty] = activity.conversation?.id ?? '';
properties[TelemetryConstants.conversationNameProperty] = activity.conversation?.name ?? '';
properties[TelemetryConstants.activityTypeProperty] = activity.type ?? '';
properties[TelemetryConstants.activityIdProperty] = activity.id ?? '';
// Additional Properties can override "stock" properties.
if (telemetryProperties) {
return Object.assign({}, properties, telemetryProperties);
}
}
return properties;
}
private populateAdditionalChannelProperties(activity: Activity, properties?: Record<string, string>): void {
if (activity) {
const channelData = activity.channelData;
switch (activity.channelId) {
case 'msteams':
properties.TeamsUserAadObjectId = activity.from?.aadObjectId ?? '';
if (isTeamsChannelData(channelData)) {
properties.TeamsTenantId = channelData.tenant?.id ?? '';
if (channelData.team) {
properties.TeamsTeamInfo = JSON.stringify(channelData.team);
}
}
break;
default:
break;
}
}
}
}