Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 3.63 KB

README.md

File metadata and controls

63 lines (43 loc) · 3.63 KB
Raw

Inspection Bot

Bot Framework v4 Inspection Middleware sample.

This bot demonstrates a feature called Inspection. This feature allows the Bot Framework Emulator to debug traffic into and out of the bot in addition to looking at the current state of the bot. This is done by having this data sent to the emulator using trace messages.

This bot has been created using Bot Framework, it shows how to create a simple bot that accepts input from the user and echoes it back. Included in this sample are two counters maintained in User and Conversation state to demonstrate the ability to look at state.

This runtime behavior is achieved by simply adding a middleware to the bot. In this sample you can find that being done in the AdapterWithInspection class.

More details are available here

This sample is a Spring Boot app and uses the Azure CLI and azure-webapp Maven plugin to deploy to Azure.

Prerequisites

  • Java 1.8+
  • Install Maven
  • An account on Azure if you want to deploy to Azure.

To try this sample

  • From the root of this project folder:
    • Build the sample using mvn package
    • Run it by using java -jar .\target\bot-inspection-sample.jar

Testing the bot using Bot Framework Emulator

Bot Framework Emulator is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.

  • Install the latest Bot Framework Emulator from here

Connect to the bot using Bot Framework Emulator

  • Launch Bot Framework Emulator
  • File -> Open Bot
  • Enter a Bot URL of http://localhost:3978/api/messages

Special Instructions for Running Inspection

  • In the emulator, select Debug -> Start Debugging.
  • Enter the endpoint url (http://localhost:3978)/api/messages, and select Connect.
  • The result is a trace activity which contains a statement that looks like /INSPECT attach < identifier >
  • Right click and copy that response.
  • In the original Live Chat session paste the value.
  • Now all the traffic will be replicated (as trace activities) to the Emulator Debug tab.

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading