Debug a bot

APPLIES TO: yesSDK v4 no SDK v3

This article describes how to debug your bot using an integrated development environment (IDE) such as Visual Studio or Visual Studio Code and the Bot Framework Emulator. While you can use these methods to debug any bot locally, this article uses a C#, Javascript, or Python bot created in the quickstart.

Note

In this article, we use the Bot Framework Emulator to send and receive messages from the bot during debugging. If you are looking for other ways to debug your bot using the Bot Framework Emulator, please read the Debug with the Bot Framework Emulator article.

Prerequisites

To set breakpoints in Visual Studio Code

In Visual Studio Code, you can set breakpoints and run the bot in debug mode to step through your code. To set breakpoints in VS Code, do the following:

  1. Launch VS Code and open your bot project folder.

  2. Set breakpoints as necessary. You can set breakpoints by hovering your mouse over the column to the left of the line numbers. A small red dot will appear. If you click on the dot, the breakpoint is set. If you click the dot again, the breakpoint is removed.

  3. From the menu bar, click Run and then click Start Debugging. Your bot will start running in debugging mode from the Terminal in Visual Studio Code.

    Set breakpoint in VS Code

  4. Start the Bot Framework Emulator and connect to your bot as described in the Debug with the Bot Framework Emulator article.

  5. From the emulator, send your bot a message (for example, send the message "Hi"). Execution will stop at the line where you place the breakpoint.

    Debug in VS

To set breakpoints in Visual Studio

In Visual Studio (VS), you can set breakpoints and run the bot in debug mode to step through your code. To set breakpoints in VS, do the following:

  1. Navigate to your bot folder and open the .sln file. This will open the solution in VS.

  2. From the menu bar, click Build and click Build Solution.

  3. In the Solution Explorer, click the .cs file and set breakpoints as necessary. This file defines your main bot logic. In VS, you can set breakpoints by hovering your mouse over the column to the left of the line numbers. A small red dot will appear. If you click on the dot the breakpoint is set. If you click the dot again the breakpoint is removed.

  4. From the menu, click Debug and click Start Debugging. At this point, the bot is running locally.

    Set breakpoint in VS

  1. Start the Bot Framework Emulator and connect to your bot as described in the section above.

  2. From the emulator, send your bot a message (e.g.: send the message "Hi"). Execution will stop at the line where you place the breakpoint.

    Debug in VS

Additional resources

Next steps