Skip to content

Commit

Permalink
[DO NOT MERGE] Enterprise Template TelemetryClient/AppInsights conver…
Browse files Browse the repository at this point in the history 
…sation analytics capabilities (microsoft#425)

* Introduced all 4.2 telemetry changes
Pointing to daily build 78

* Removed .pbit and updated README to point to AI/solutions/analytics directory where this will be hosted now.

* Fixed formatting

* Fixed typo in telemetryclient variable.

* Addressed PR comments

* Updated to version 4.2.0

* fix for teams auth (microsoft#410)

* fix for teams auth

* removed dev exception page

* updated teams auth middleware

* fixed

* Update readme.md

* Introduced all 4.2 telemetry changes
Pointing to daily build 78

* Removed .pbit and updated README to point to AI/solutions/analytics directory where this will be hosted now.

* Fixed formatting

* Fixed typo in telemetryclient variable.

* Addressed PR comments

* Updated to version 4.2.0
  • Loading branch information
@ryanisgrig
ryanisgrig authored Dec 13, 2018
1 parent e8a67af commit c633739
Show file tree
Hide file tree
Showing 16 changed files with 212 additions and 114 deletions.
88 changes: 73 additions & 15 deletions templates/Enterprise-Template/src/csharp/EnterpriseBotTemplate/Bot Framework/BotServices.cs
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

using System;
using System.Collections.Generic;
using $safeprojectname$.Middleware.Telemetry;
using Microsoft.ApplicationInsights;
using Microsoft.ApplicationInsights.Extensibility;
using Microsoft.Bot.Builder.AI.Luis;
using Microsoft.Bot.Builder.AI.QnA;
using Microsoft.Bot.Configuration;
Expand All @@ -30,30 +32,86 @@ public BotServices(BotConfiguration botConfiguration)
{
switch (service.Type)
{
case ServiceTypes.AppInsights:
case ServiceTypes.AppInsights:
{
var appInsights = (AppInsightsService)service;
if (appInsights == null)
{
var appInsights = service as AppInsightsService;
TelemetryClient = new TelemetryClient();
break;
throw new InvalidOperationException("The Application Insights is not configured correctly in your '.bot' file.");
}

case ServiceTypes.Dispatch:
if (string.IsNullOrWhiteSpace(appInsights.InstrumentationKey))
{
var dispatch = service as DispatchService;
var dispatchApp = new LuisApplication(dispatch.AppId, dispatch.SubscriptionKey, dispatch.GetEndpoint());
DispatchRecognizer = new TelemetryLuisRecognizer(dispatchApp);
break;
throw new InvalidOperationException("The Application Insights Instrumentation Key ('instrumentationKey') is required to run this sample. Please update your '.bot' file.");
}

case ServiceTypes.Luis:
var telemetryConfig = new TelemetryConfiguration(appInsights.InstrumentationKey);
TelemetryClient = new TelemetryClient(telemetryConfig)
{
var luis = service as LuisService;
var luisApp = new LuisApplication(luis.AppId, luis.SubscriptionKey, luis.GetEndpoint());
LuisServices.Add(service.Id, new TelemetryLuisRecognizer(luisApp));
break;
InstrumentationKey = appInsights.InstrumentationKey,
};

break;
}

case ServiceTypes.Dispatch:
{
var dispatch = service as DispatchService;
if (dispatch == null)
{
throw new InvalidOperationException("The Dispatch service is not configured correctly in your '.bot' file.");
}

case ServiceTypes.QnA:
if (string.IsNullOrWhiteSpace(dispatch.AppId))
{
throw new InvalidOperationException("The Dispatch Luis Model Application Id ('appId') is required to run this sample. Please update your '.bot' file.");
}

if (string.IsNullOrWhiteSpace(dispatch.SubscriptionKey))
{
throw new InvalidOperationException("The Subscription Key ('subscriptionKey') is required to run this sample. Please update your '.bot' file.");
}

var dispatchApp = new LuisApplication(dispatch.AppId, dispatch.SubscriptionKey, dispatch.GetEndpoint());
DispatchRecognizer = new TelemetryLuisRecognizer(dispatchApp);
break;
}

case ServiceTypes.Luis:
{
var luis = service as LuisService;
if (luis == null)
{
throw new InvalidOperationException("The Luis service is not configured correctly in your '.bot' file.");
}

if (string.IsNullOrWhiteSpace(luis.AppId))
{
throw new InvalidOperationException("The Luis Model Application Id ('appId') is required to run this sample. Please update your '.bot' file.");
}

if (string.IsNullOrWhiteSpace(luis.AuthoringKey))
{
throw new InvalidOperationException("The Luis Authoring Key ('authoringKey') is required to run this sample. Please update your '.bot' file.");
}

if (string.IsNullOrWhiteSpace(luis.SubscriptionKey))
{
throw new InvalidOperationException("The Subscription Key ('subscriptionKey') is required to run this sample. Please update your '.bot' file.");
}

if (string.IsNullOrWhiteSpace(luis.Region))
{
throw new InvalidOperationException("The Region ('region') is required to run this sample. Please update your '.bot' file.");
}

var luisApp = new LuisApplication(luis.AppId, luis.SubscriptionKey, luis.GetEndpoint());
var recognizer = new TelemetryLuisRecognizer(luisApp);
LuisServices.Add(service.Id, recognizer);
break;
}

case ServiceTypes.QnA:
{
var qna = service as QnAMakerService;
var qnaEndpoint = new QnAMakerEndpoint()
Expand Down
10 changes: 6 additions & 4 deletions ...rprise-Template/src/csharp/EnterpriseBotTemplate/Bot Framework/Dialogs/Main/MainDialog.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
using $safeprojectname$.Dialogs.Onboarding;
using $safeprojectname$.Dialogs.Shared;
using Luis;
using Microsoft.ApplicationInsights;
using Microsoft.Bot.Builder;
using Microsoft.Bot.Builder.Dialogs;

Expand All @@ -21,14 +22,15 @@ public class MainDialog : RouterDialog
private ConversationState _conversationState;
private MainResponses _responder = new MainResponses();

public MainDialog(BotServices services, ConversationState conversationState, UserState userState)
public MainDialog(BotServices services, ConversationState conversationState, UserState userState, IBotTelemetryClient telemetryClient)
: base(nameof(MainDialog))
{
_services = services ?? throw new ArgumentNullException(nameof(services));
_conversationState = conversationState;
_userState = userState;
TelemetryClient = telemetryClient;

AddDialog(new OnboardingDialog(_services, _userState.CreateProperty<OnboardingState>(nameof(OnboardingState))));
AddDialog(new OnboardingDialog(_services, _userState.CreateProperty<OnboardingState>(nameof(OnboardingState)), telemetryClient));
AddDialog(new EscalateDialog(_services));
}

Expand All @@ -41,7 +43,7 @@ public MainDialog(BotServices services, ConversationState conversationState, Use
protected override async Task RouteAsync(DialogContext dc, CancellationToken cancellationToken = default(CancellationToken))
{
// Check dispatch result
var dispatchResult = await _services.DispatchRecognizer.RecognizeAsync<Dispatch>(dc.Context, true, CancellationToken.None);
var dispatchResult = await _services.DispatchRecognizer.RecognizeAsync<Dispatch>(dc, true, CancellationToken.None);
var intent = dispatchResult.TopIntent().intent;

if (intent == Dispatch.Intent.l_General)
Expand All @@ -55,7 +57,7 @@ public MainDialog(BotServices services, ConversationState conversationState, Use
}
else
{
var result = await luisService.RecognizeAsync<General>(dc.Context, true, CancellationToken.None);
var result = await luisService.RecognizeAsync<General>(dc, true, CancellationToken.None);

var generalIntent = result?.TopIntent().intent;

Expand Down
8 changes: 6 additions & 2 deletions ...ate/src/csharp/EnterpriseBotTemplate/Bot Framework/Dialogs/Onboarding/OnboardingDialog.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
using System.Threading;
using System.Threading.Tasks;
using $safeprojectname$.Dialogs.Shared;
using Microsoft.ApplicationInsights;
using Microsoft.Bot.Builder;
using Microsoft.Bot.Builder.Dialogs;

Expand All @@ -15,7 +16,7 @@ public class OnboardingDialog : EnterpriseDialog
private IStatePropertyAccessor<OnboardingState> _accessor;
private OnboardingState _state;

public OnboardingDialog(BotServices botServices, IStatePropertyAccessor<OnboardingState> accessor)
public OnboardingDialog(BotServices botServices, IStatePropertyAccessor<OnboardingState> accessor, IBotTelemetryClient telemetryClient)
: base(botServices, nameof(OnboardingDialog))
{
_accessor = accessor;
Expand All @@ -29,7 +30,10 @@ public OnboardingDialog(BotServices botServices, IStatePropertyAccessor<Onboardi
FinishOnboardingDialog,
};

AddDialog(new WaterfallDialog(InitialDialogId, onboarding));
// To capture built-in waterfall dialog telemetry, set the telemetry client
// to the new waterfall dialog and add it to the component dialog
TelemetryClient = telemetryClient;
AddDialog(new WaterfallDialog(InitialDialogId, onboarding) { TelemetryClient = telemetryClient });
AddDialog(new TextPrompt(DialogIds.NamePrompt));
AddDialog(new TextPrompt(DialogIds.EmailPrompt));
AddDialog(new TextPrompt(DialogIds.LocationPrompt));
Expand Down
6 changes: 4 additions & 2 deletions ...lates/Enterprise-Template/src/csharp/EnterpriseBotTemplate/Bot Framework/EnterpriseBot.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ public class $safeprojectname$ : IBot
private readonly BotServices _services;
private readonly ConversationState _conversationState;
private readonly UserState _userState;
private readonly IBotTelemetryClient _telemetryClient;
private DialogSet _dialogs;

/// <summary>
Expand All @@ -27,14 +28,15 @@ public class $safeprojectname$ : IBot
/// <param name="botServices">Bot services.</param>
/// <param name="conversationState">Bot conversation state.</param>
/// <param name="userState">Bot user state.</param>
public $safeprojectname$(BotServices botServices, ConversationState conversationState, UserState userState)
public $safeprojectname$(BotServices botServices, ConversationState conversationState, UserState userState, IBotTelemetryClient telemetryClient)
{
_conversationState = conversationState ?? throw new ArgumentNullException(nameof(conversationState));
_userState = userState ?? throw new ArgumentNullException(nameof(userState));
_services = botServices ?? throw new ArgumentNullException(nameof(botServices));
_telemetryClient = telemetryClient ?? throw new ArgumentNullException(nameof(telemetryClient));

_dialogs = new DialogSet(_conversationState.CreateProperty<DialogState>(nameof($safeprojectname$)));
_dialogs.Add(new MainDialog(_services, _conversationState, _userState));
_dialogs.Add(new MainDialog(_services, _conversationState, _userState, _telemetryClient));
}

/// <summary>
Expand Down
30 changes: 16 additions & 14 deletions ...s/Enterprise-Template/src/csharp/EnterpriseBotTemplate/Bot Framework/EnterpriseBot.csproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,27 @@

<ItemGroup>
<PackageReference Include="AdaptiveCards" Version="1.1.0" />
<PackageReference Include="Microsoft.ApplicationInsights" Version="2.8.0" />
<PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.5.0" />
<PackageReference Include="Microsoft.ApplicationInsights.DependencyCollector" Version="2.8.0" />
<PackageReference Include="Microsoft.ApplicationInsights" Version="2.8.1" />
<PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.5.1" />
<PackageReference Include="Microsoft.ApplicationInsights.DependencyCollector" Version="2.8.1" />
<PackageReference Include="Microsoft.AspNetCore.All" Version="2.1.5" />
<PackageReference Include="Microsoft.Azure.CognitiveServices.ContentModerator" Version="1.0.0" />
<PackageReference Include="Microsoft.Azure.CognitiveServices.Language" Version="1.0.1-preview" />
<PackageReference Include="Microsoft.Bot.Builder" Version="4.1.5" />
<PackageReference Include="Microsoft.Bot.Builder.AI.Luis" Version="4.1.5" />
<PackageReference Include="Microsoft.Bot.Builder.AI.QnA" Version="4.1.5" />
<PackageReference Include="Microsoft.Bot.Builder.Azure" Version="4.1.5" />
<PackageReference Include="Microsoft.Bot.Builder.Dialogs" Version="4.1.5" />
<PackageReference Include="Microsoft.Bot.Builder.Integration.AspNet.Core" Version="4.1.5" />
<PackageReference Include="Microsoft.Bot.Builder.TemplateManager" Version="4.1.5" />
<PackageReference Include="Microsoft.Bot.Configuration" Version="4.1.5" />
<PackageReference Include="Microsoft.Bot.Connector" Version="4.1.5" />
<PackageReference Include="Microsoft.Bot.Schema" Version="4.1.5" />
<PackageReference Include="Microsoft.Bot.Builder" Version="4.2.0" />
<PackageReference Include="Microsoft.Bot.Builder.AI.Luis" Version="4.2.0" />
<PackageReference Include="Microsoft.Bot.Builder.AI.QnA" Version="4.2.0" />
<PackageReference Include="Microsoft.Bot.Builder.ApplicationInsights" Version="4.2.0" />
<PackageReference Include="Microsoft.Bot.Builder.Azure" Version="4.2.0" />
<PackageReference Include="Microsoft.Bot.Builder.Dialogs" Version="4.2.0" />
<PackageReference Include="Microsoft.Bot.Builder.Integration.ApplicationInsights.Core" Version="4.2.0" />
<PackageReference Include="Microsoft.Bot.Builder.Integration.AspNet.Core" Version="4.2.0" />
<PackageReference Include="Microsoft.Bot.Builder.TemplateManager" Version="4.2.0" />
<PackageReference Include="Microsoft.Bot.Configuration" Version="4.2.0" />
<PackageReference Include="Microsoft.Bot.Connector" Version="4.2.0" />
<PackageReference Include="Microsoft.Bot.Schema" Version="4.2.0" />
<PackageReference Include="Microsoft.Extensions.Logging" Version="2.1.1" />
<PackageReference Include="Microsoft.Extensions.Options" Version="2.1.1" />
<PackageReference Include="Microsoft.Graph" Version="1.10.0" />
<PackageReference Include="Microsoft.Graph" Version="1.12.0" />
</ItemGroup>

<ItemGroup>
Expand Down
Binary file removed .../EnterpriseBotTemplate/Bot Framework/Middleware/Telemetry/Example Power BI Dashboard.pbit
View file
Binary file not shown.
17 changes: 9 additions & 8 deletions ...csharp/EnterpriseBotTemplate/Bot Framework/Middleware/Telemetry/LuisTelemetryConstants.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ namespace $safeprojectname$.Middleware.Telemetry
/// </summary>
public static class LuisTelemetryConstants
{
public const string IntentPrefix = "LuisIntent"; // Application Insights Custom Event name (with Intent)
public const string IntentProperty = "Intent";
public const string IntentScoreProperty = "IntentScore";
public const string ConversationIdProperty = "ConversationId";
public const string QuestionProperty = "Question";
public const string ActivityIdProperty = "ActivityId";
public const string SentimentLabelProperty = "SentimentLabel";
public const string SentimentScoreProperty = "SentimentScore";
public const string IntentPrefix = "luisIntent"; // Application Insights Custom Event name (with Intent)
public const string IntentProperty = "intent";
public const string IntentScoreProperty = "intentScore";
public const string ConversationIdProperty = "conversationId";
public const string QuestionProperty = "question";
public const string ActivityIdProperty = "activityId";
public const string SentimentLabelProperty = "sentimentLabel";
public const string SentimentScoreProperty = "sentimentScore";
public const string DialogId = "dialogId";
}
}
17 changes: 9 additions & 8 deletions .../csharp/EnterpriseBotTemplate/Bot Framework/Middleware/Telemetry/QnATelemetryConstants.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ namespace $safeprojectname$.Middleware.Telemetry
/// </summary>
public static class QnATelemetryConstants
{
public const string ActivityIdProperty = "ActivityId";
public const string UsernameProperty = "Username";
public const string ConversationIdProperty = "ConversationId";
public const string OriginalQuestionProperty = "OriginalQuestion";
public const string QuestionProperty = "Question";
public const string AnswerProperty = "Answer";
public const string ScoreProperty = "Score";
public const string ArticleFoundProperty = "QnAItemFound";
public const string ActivityIdProperty = "activityId";
public const string AnswerProperty = "answer";
public const string ArticleFoundProperty = "articleFound";
public const string ChannelIdProperty = "channelId";
public const string ConversationIdProperty = "conversationId";
public const string OriginalQuestionProperty = "originalQuestion";
public const string QuestionProperty = "question";
public const string ScoreProperty = "score";
public const string UsernameProperty = "username";
}
}
23 changes: 12 additions & 11 deletions ...src/csharp/EnterpriseBotTemplate/Bot Framework/Middleware/Telemetry/TelemetryConstants.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,17 @@ namespace $safeprojectname$.Middleware.Telemetry
{
public static class TelemetryConstants
{
public const string ActivityIDProperty = "ActivityId";
public const string ReplyActivityIDProperty = "ReplyActivityId";
public const string ChannelProperty = "Channel";
public const string FromIdProperty = "FromId";
public const string FromNameProperty = "FromName";
public const string RecipientIdProperty = "RecipientId";
public const string RecipientNameProperty = "RecipientName";
public const string ConversationIdProperty = "ConversationId";
public const string ConversationNameProperty = "ConversationName";
public const string TextProperty = "Text";
public const string LocaleProperty = "Locale";
public const string ActivityIDProperty = "activityId";
public const string ReplyActivityIDProperty = "replyActivityId";
public const string ChannelIdProperty = "channelId";
public const string FromIdProperty = "fromId";
public const string FromNameProperty = "fromName";
public const string RecipientIdProperty = "recipientId";
public const string RecipientNameProperty = "recipientName";
public const string ConversationIdProperty = "conversationId";
public const string ConversationNameProperty = "conversationName";
public const string TextProperty = "text";
public const string LocaleProperty = "locale";
public const string SpeakProperty = "speak";
}
}
Loading

0 comments on commit c633739

Please sign in to comment.