Events generated by the Bot Framework Service telemetry

Channel service events

In addition to WaterfallDialog, which was discussed in the telemetry topic and which generates events from your bot code, the Bot Framework Channel service also logs events. This helps you diagnose issues with Channels or overall bot failures.

CustomEvent: "Activity"

Logged From: Channel Service Logged by the Channel Service when a message received.

Exception: "Bot Errors"

Logged From: Channel Service Logged by the channel when a call to the Bot returns a non-2XX Http Response.

CustomEvent: "WaterfallStart"

When a WaterfallDialog begins, a WaterfallStart event is logged.

CustomEvent: "WaterfallStep"

Logs individual steps from a Waterfall Dialog.

CustomEvent: "WaterfallDialogComplete"

Logs when a Waterfall Dialog completes.

CustomEvent: "WaterfallDialogCancel"

Logs when a Waterfall Dialog is canceled.

CustomEvent: BotMessageReceived

Logged when bot receives new message from a user.

When not overridden, this event is logged from Microsoft.Bot.Builder.TelemetryLoggerMiddleware using the Microsoft.Bot.Builder.IBotTelemetry.TrackEvent() method.

  • Session Identifier

    • When using Application Insights, this is logged from the TelemetryBotIdInitializer as the session identifier (Temeletry.Context.Session.Id) used within Application Insights.
    • Corresponds to the Conversation ID as defined by Bot Framework protocol..
    • The property name logged is session_id.
  • User Identifier

    • When using Application Insights, this is logged from the TelemetryBotIdInitializer as the user identifier (Telemetry.Context.User.Id) used within Application Insights.
    • The value of this property is a combination of the Channel Identifier and the User ID (concatenated together) properties as defined by the Bot Framework protocol.
    • The property name logged is user_id.
  • ActivityID

    • When using Application Insights, this is logged from the TelemetryBotIdInitializer as a Property to the event.
    • Corresponds to the Activity ID as defined by Bot Framework protocol..
    • The property name is activityId.
  • Channel Identifier

    • When using Application Insights, this is logged from the TelemetryBotIdInitializer as a Property to the event.
    • Corresponds to the Channel Identifier of the Bot Framework protocol.
    • The property name logged is channelId.
  • ActivityType

    • When using Application Insights, this is logged from the TelemetryBotIdInitializer as a Property to the event.
    • Corresponds to the Activity Type of the Bot Framework protocol.
    • The property name logged is activityType.
  • Text

    • Optionally logged when the logPersonalInformation property is set to true.
    • Corresponds to the Activity Text field of the Bot Framework protocol.
    • The property name logged is text.
  • Speak

    • Optionally logged when the logPersonalInformation property is set to true.

    • Corresponds to the Activity Speak field of the Bot Framework protocol.

    • The property name logged is speak.

  • FromId

    • Corresponds to the From Identifier field of the Bot Framework protocol.
    • The property name logged is fromId.
  • FromName

    • Optionally logged when the logPersonalInformation property is set to true.
    • Corresponds to the From Name field of the Bot Framework protocol.
    • The property name logged is fromName.
  • RecipientId

    • Corresponds to the From Name field of the Bot Framework protocol.
    • The property name logged is fromName.
  • RecipientName

    • Corresponds to the From Name field of the Bot Framework protocol.
    • The property name logged is fromName.
  • ConversationId

    • Corresponds to the From Name field of the Bot Framework protocol.
    • The property name logged is fromName.
  • ConversationName

    • Corresponds to the From Name field of the Bot Framework protocol.
    • The property name logged is fromName.
  • Locale

    • Corresponds to the From Name field of the Bot Framework protocol.
    • The property name logged is fromName.

CustomEvent: BotMessageSend

Logged From: TelemetryLoggerMiddleware

Logged when bot sends a message.

CustomEvent: BotMessageUpdate

Logged From: TelemetryLoggerMiddleware Logged when a message is updated by the bot (rare case)

CustomEvent: BotMessageDelete

Logged From: TelemetryLoggerMiddleware Logged when a message is deleted by the bot (rare case)

CustomEvent: LuisEvent

Logged From: LuisRecognizer

Logs results from LUIS service.

CustomEvent: QnAMessage

Logged From: QnAMaker

Logs results from QnA Maker service.