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 Adapter. In this sample you can find that being done in app.py.
More details are available here
- Clone the repository
git clone https://github.com/Microsoft/botbuilder-samples.git- Bring up a terminal, navigate to
botbuilder-samples\samples\python\47.inspectionfolder - Activate your desired virtual environment
- In the terminal, type
pip install -r requirements.txt - Run your bot with
python app.py
Microsoft 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 Bot Framework Emulator version 4.5.0 or greater from here
- Launch Bot Framework Emulator
- File -> Open Bot
- Enter a Bot URL of
http://localhost:3978/api/messages
- In the emulator, select Debug -> Start Debugging.
- Enter the endpoint url (http://localhost:8080)/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.
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.