How to use remote debugging with Deep. This example builds on the local example, for questions about the general setup, please refer to its readme file.
Although it is possible to debug Deep with dlv debug,
this approach also has disadvantages in scenarios where it is desirable to run Deep inside a container.
This example demonstrates how to debug Deep running in docker-compose.
The make target docker-deep-debug compiles deep without optimizations and creates a docker
image that runs Deep using dlv exec.
- Build the deep debug image:
make docker-deep-debugTo distinguish the debug image from the conventional Deep image its is tagged with intergral/deep-debug.
-
Take a look at deep service in the docker-compose.yaml. The environment variable
DEBUG_BLOCKcontrols whether delve halts the execution of Deep until a debugger is connected. Setting this option to1is helpful to debug errors during the start-up phase. -
Now start up the stack.
docker compose up -dAt this point, the following containers should be running.
docker compose ps Name Command State Ports
---------------------------------------------------------------------------------------------------------------------
debug_grafana_1 /run.sh Up 0.0.0.0:3000->3000/tcp,:::3000->3000/tcp
debug_test_app_1 python src/simple-a... Up
debug_prometheus_1 /bin/prometheus --config.f ... Up 0.0.0.0:9090->9090/tcp,:::9090->9090/tcp
debug_deep_1 /entrypoint-debug.sh -conf ... Up 0.0.0.0:43315->43315/tcp,:::43315->43315/tcp
0.0.0.0:2345->2345/tcp,:::2345->2345/tcp
0.0.0.0:3300->3300/tcp,:::3300->3300/tcp
- The deep container exposes delves debugging server at port
2345and it is now possible to connect to it and debug the program. If you prefer to operate delve from the command line you can connect to it via:
dlv connect localhost:2345Goland users can connect with the Go Remote run configuration:
- To stop the setup use.
docker-compose down -v