Skip to content

debugging.md

Latest commit

 

History

History
37 lines (25 loc) · 1.3 KB

debugging.md

File metadata and controls

37 lines (25 loc) · 1.3 KB

Debugging

This document describes methods to debug the binaries in various environments.

Note: This document assumes you are using the devcontainer.

Debug Locally

The skaffold tool comes with a debug command which automatically relaunches the containers with the appropriate debug tool. Docs

  • Run: make debug-local.
    • Make sure to stop any existing local servers first.
  • Click the Run and debug icon on the left side of IDE.
    • You may need to click a "Run and debug button" initially.
  • Select the service you want to debug.
    • You can debug different services at the same time.
  • Place your breakpoints and exercise those paths
  • Ensure to click the disconnect button when finished

VS Code Productivity Tips

Unit Test Debugging

The most productive way to iterate on Go logic is using the VS Code Testing Panel:

  1. Open the Testing icon in the sidebar (the lab flask icon).
  2. Find your specific test case in the tree.
  3. Click the Debug icon next to the test to set breakpoints directly in the Go code.

ANTLR Grammar Visualizer

If you are modifying the search grammar:

  1. Open antlr/FeatureSearch.g4.
  2. Install the "ANTLR4" extension.
  3. Run the "Debug FeatureSearch grammar" launch configuration to visualize and walk the parse tree.