Skip to content

Latest commit

 

History

History
 
 

47.inspection

README.md

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

Prerequisites

  • .NET Core SDK version 3.1

    # determine dotnet version
dotnet --version

To try this sample

  • Clone the repository

    git clone https://github.com/Microsoft/botbuilder-samples.git

  • Run the bot from a terminal or from Visual Studio:

    A) From a terminal, navigate to samples/csharp_dotnetcore/47.inspection

    # run the bot
dotnet run

    B) Or from Visual Studio

    • Launch Visual Studio
    • File -> Open -> Project/Solution
    • Navigate to samples/csharp_dotnetcore/47.inspection folder
    • Select Inspection.csproj file
    • Press F5 to run the project

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

(Note the follow applies if you are using two emulators. More recent builds of the Bot Framework Emulator hide the need to type /INSPECT open.)

  • Launch a second Emulator - this will act as the debugger
  • In this second Emulator type /INSPECT open
  • The result is a trace activity which contains a statement that looks like /INSPECT attach < identifier >
  • In the chat session that you want to inspect type this command exact as it is (you can use cut and paste)
  • Now all the traffic will be replicated (as trace activities) to the Emulator that sent the /INSPECT open command

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