[Adaptive] Support telemetry client in adaptive dialog

[vishwacsena]

This item tracks work to add support for telemetry client in adaptive dialog

[vishwacsena]

https://github.com/daveta/analytics/blob/master/adaptive/README.md

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

[vishwacsena]

Chatted with @scheyal and here is what we landed with for scoping -

The bullet list below is the suggested instrumentation field name, properties should be configured to be accessible via customdimensions

1. All new recognizers should participate and log recognition result anytime the recognizer is run. This should be similar to how the existing luisrecognizer participates in instrumentation. For all recognizers, log the recognizer configuration itself as well as the actual recognition result on recognition.
   • CrossTrainedRecognizerSet
   • MultiLanguageRecognizer
   • RecognizerSet
   • RegexRecognizer
   • ValueRecognizer
2. For adaptive dialog instrumentation, we should get to parity with waterfall dialogs and instrument the following
   • AdaptiveDialogStart
   • AdaptiveDialogCancel
   • AdaptiveDialogComplete
   • AdaptiveDialogAction
     • Include type of action in properties as kind
     • instance properties are all included in the property bag.
     • log this when an action begins.
     • All inputs are considered actions.
   • AdaptiveDialogTrigger

@tomlm

[cleemullins]

@tomlm, this is a P0 R8 bug. Can you please update the thread?

[garypretty]

Spoke with @vishwacsena and I am happy to pick this up with the other telemetry work. Makes sense to tackle them as a group.

[tomlm]

Cool, a couple of thoughts

1. TelemetryLoggerMiddleware should add IBotTelemetryClient to context.TurnState.Add() so it is available to any component via Context.TurnState.Get()
2. We should consider instrumenting DialogContext.BeginDialog() EndDialg() etc. as that would give us telemetry for all dialogs regardless if they add additional telemetry or not.
3. I don't know if we are going to be able to log all instance properties of a declarative dialog, as they can be complex and also expressions. Thoughts?

[garypretty]

@tomlm Thanks.

1. Sounds sensible - all being well it will be the new abstract class as opposed to IBotTelemetryClient, depending on feedback on my open PR for enabling page views (Update TelemetryClient to enable tracking of dialog ('page') views #3440). We will still need to have the explicit properties on the dialogs for it though, as TelemetryLoggerMiddleware is optional.

2. I think this will make sense for some events. i.e. the new page views event we will have once we figure out the other PR. We probably still need to have tracking code in AdaptiveDialog / WaterfallDialog though as we track specific events for adaptive vs waterfall.

3. I haven't dug into the adaptive bits much yet - so I will comment on that as I get into it tomorrow, although I suspect your assertion is likely correct.

[garypretty]

Closing as P0 functionality has now been merged.