Bot Framework Service 遙測所產生的事件Events generated by the Bot Framework Service telemetry

適用于： SDK v4APPLIES TO: SDK v4

通道服務事件Channel service events

除了 WaterfallDialog (已於遙測主題討論過，而且會從聊天機器人的程式碼產生事件)，Bot Framework Channel 服務也會記錄事件。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. 這可協助您診斷通道或整體 Bot 失敗的問題。This helps you diagnose issues with Channels or overall bot failures.

CustomEvent："Activity"CustomEvent: "Activity"

記錄來源： 通道服務 在收到訊息時由通道服務記錄。Logged From: Channel Service Logged by the Channel Service when a message received.

例外狀況：「Bot 錯誤」Exception: "Bot Errors"

記錄來源： 通道服務 在 Bot 呼叫傳回非 2XX Http 回應時由通道記錄。Logged From: Channel Service Logged by the channel when a call to the Bot returns a non-2XX Http Response.

CustomEvent："WaterfallStart"CustomEvent: "WaterfallStart"

當 WaterfallDialog 開始時，就會記錄 WaterfallStart 事件。When a WaterfallDialog begins, a WaterfallStart event is logged.

CustomEvent："WaterfallStep"CustomEvent: "WaterfallStep"

記錄瀑布式對話中的個別步驟。Logs individual steps from a Waterfall Dialog.

CustomEvent："WaterfallDialogComplete"CustomEvent: "WaterfallDialogComplete"

記錄於瀑布式對話完成時。Logs when a Waterfall Dialog completes.

CustomEvent："WaterfallDialogCancel"CustomEvent: "WaterfallDialogCancel"

記錄於瀑布式對話取消時。Logs when a Waterfall Dialog is canceled.

CustomEvent：BotMessageReceivedCustomEvent: BotMessageReceived

記錄於 Bot 從使用者收到新訊息時。Logged when bot receives new message from a user.

若未加以覆寫，則會使用 Microsoft.Bot.Builder.IBotTelemetry.TrackEvent() 方法從 Microsoft.Bot.Builder.TelemetryLoggerMiddleware 記錄此事件。When not overridden, this event is logged from Microsoft.Bot.Builder.TelemetryLoggerMiddleware using the Microsoft.Bot.Builder.IBotTelemetry.TrackEvent() method.

  • 工作階段識別碼Session Identifier

    • 使用 Application Insights 時，會從 TelemetryBotIdInitializer 將此屬性記錄為 Application Insights 中所使用的工作階段識別碼 (Temeletry.Context.Session.Id )。When using Application Insights, this is logged from the TelemetryBotIdInitializer as the session identifier (Temeletry.Context.Session.Id) used within Application Insights.
    • 對應至 Bot Framework 通訊協定所定義的對話識別碼。Corresponds to the Conversation ID as defined by Bot Framework protocol..
    • 所記錄的屬性名稱是 session_id。The property name logged is session_id.

  • 使用者識別碼User Identifier

    • 使用 Application Insights 時，會從 TelemetryBotIdInitializer 將此屬性記錄為 Application Insights 中所使用的使用者識別碼 (Telemetry.Context.User.Id )。When using Application Insights, this is logged from the TelemetryBotIdInitializer as the user identifier (Telemetry.Context.User.Id) used within Application Insights.
    • 此屬性的值結合了 Bot Framework 通訊協定所定義的通道識別碼和使用者識別碼 (串連在一起) 屬性。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.
    • 所記錄的屬性名稱是 user_id。The property name logged is user_id.

  • ActivityIDActivityID

    • 使用 Application Insights 時，會從 TelemetryBotIdInitializer 將此屬性記錄為事件的屬性。When using Application Insights, this is logged from the TelemetryBotIdInitializer as a Property to the event.
    • 對應至 Bot Framework 通訊協定所定義的活動識別碼。Corresponds to the Activity ID as defined by Bot Framework protocol..
    • 屬性名稱是 activityId。The property name is activityId.

  • 通道識別碼Channel Identifier

    • 使用 Application Insights 時，會從 TelemetryBotIdInitializer 將此屬性記錄為事件的屬性。When using Application Insights, this is logged from the TelemetryBotIdInitializer as a Property to the event.
    • 對應至 Bot Framework 通訊協定的通道識別碼。Corresponds to the Channel Identifier of the Bot Framework protocol.
    • 所記錄的屬性名稱是 channelId。The property name logged is channelId.

  • ActivityTypeActivityType

    • 使用 Application Insights 時，會從 TelemetryBotIdInitializer 將此屬性記錄為事件的屬性。When using Application Insights, this is logged from the TelemetryBotIdInitializer as a Property to the event.
    • 對應至 Bot Framework 通訊協定的活動類型。Corresponds to the Activity Type of the Bot Framework protocol.
    • 所記錄的屬性名稱是 activityType。The property name logged is activityType.

  • TextText

    • 會在 logPersonalInformation 屬性設定為 true 時選擇性地記錄。Optionally logged when the logPersonalInformation property is set to true.
    • 對應至 Bot Framework 通訊協定的活動文字欄位。Corresponds to the Activity Text field of the Bot Framework protocol.
    • 所記錄的屬性名稱是 text。The property name logged is text.

  • SpeakSpeak

    • 會在 logPersonalInformation 屬性設定為 true 時選擇性地記錄。Optionally logged when the logPersonalInformation property is set to true.

    • 對應至 Bot Framework 通訊協定的活動語音欄位。Corresponds to the Activity Speak field of the Bot Framework protocol.

    • 所記錄的屬性名稱是 speak。The property name logged is speak.

  • FromIdFromId

    • 對應至 Bot Framework 通訊協定的來源識別碼欄位。Corresponds to the From Identifier field of the Bot Framework protocol.
    • 所記錄的屬性名稱是 fromId。The property name logged is fromId.

  • FromNameFromName

    • 會在 logPersonalInformation 屬性設定為 true 時選擇性地記錄。Optionally logged when the logPersonalInformation property is set to true.
    • 對應至 Bot Framework 通訊協定的來源名稱欄位。Corresponds to the From Name field of the Bot Framework protocol.
    • 所記錄的屬性名稱是 fromName。The property name logged is fromName.

  • RecipientIdRecipientId

    • 對應至 Bot Framework 通訊協定的來源名稱欄位。Corresponds to the From Name field of the Bot Framework protocol.
    • 所記錄的屬性名稱是 fromName。The property name logged is fromName.

  • RecipientNameRecipientName

    • 對應至 Bot Framework 通訊協定的來源名稱欄位。Corresponds to the From Name field of the Bot Framework protocol.
    • 所記錄的屬性名稱是 fromName。The property name logged is fromName.

  • ConversationIdConversationId

    • 對應至 Bot Framework 通訊協定的來源名稱欄位。Corresponds to the From Name field of the Bot Framework protocol.
    • 所記錄的屬性名稱是 fromName。The property name logged is fromName.

  • ConversationNameConversationName

    • 對應至 Bot Framework 通訊協定的來源名稱欄位。Corresponds to the From Name field of the Bot Framework protocol.
    • 所記錄的屬性名稱是 fromName。The property name logged is fromName.

  • LocaleLocale

    • 對應至 Bot Framework 通訊協定的來源名稱欄位。Corresponds to the From Name field of the Bot Framework protocol.
    • 所記錄的屬性名稱是 fromName。The property name logged is fromName.

CustomEvent：BotMessageSendCustomEvent: BotMessageSend

記錄來源： TelemetryLoggerMiddlewareLogged From: TelemetryLoggerMiddleware

記錄於 Bot 傳送訊息時。Logged when bot sends a message.

CustomEvent：BotMessageUpdateCustomEvent: BotMessageUpdate

記錄來源： TelemetryLoggerMiddleware 記錄於 Bot 更新訊息時 (罕見案例)Logged From: TelemetryLoggerMiddleware Logged when a message is updated by the bot (rare case)

CustomEvent：BotMessageDeleteCustomEvent: BotMessageDelete

記錄來源： TelemetryLoggerMiddleware 記錄於 Bot 刪除訊息時 (罕見案例)Logged From: TelemetryLoggerMiddleware Logged when a message is deleted by the bot (rare case)

CustomEvent：LuisEventCustomEvent: LuisEvent

記錄來源： LuisRecognizerLogged From: LuisRecognizer

記錄 LUIS 服務的結果。Logs results from LUIS service.

CustomEvent：QnAMessageCustomEvent: QnAMessage

記錄來源： QnAMakerLogged From: QnAMaker

記錄 QnA Maker 服務的結果。Logs results from QnA Maker service.