lucashuy
commented
7 months ago Hi, to attach a debugger manually to the container, you'll have to provide the debugging arguments yourself.
Using the hello world Python 3.8 template, I added debugpy to the existing requirements file. Then after sam build, I ran sam local start-api -d 9999 --debug --debug-args "-m debugpy --listen 0.0.0.0:9999" to start the API.
- Argument
-m debugpy, invokes thedebugpyas a Python module - Argument
--listen 0.0.0.0:9999, tellsdebugpyto look at port9999for connections
After waiting for the API to start, I ran curl localhost:3000/hello and the API waited for me to attach a debugger. Using the following VSCode configuration:
{
"name": "Python: Remote Attach",
"type": "python",
"request": "attach",
"connect": {
"host": "localhost",
"port": 9999
},
"pathMappings": [
{
"localRoot": "${workspaceFolder}/hello_world",
"remoteRoot": "/var/task"
}
],
"justMyCode": false
},I was able to set a break point and debug the function.
The AWS Toolkit extension abstracts away all this setup as you've shown. Let me know if you aren't able to get the debugger working, or if it still refuses to wait for you to attach a debugging session.
antoineaws
bettlebrox
skurihara-cw
jpangburn
Description:
Team, The SAM cli -
sam local start-api --debug-port 5858doesn't allow developers to debug their code (pause at breakpoints), even if--debug-function HelloWorldFunctionis specified.If you inspect the container that gets launched, note 2 things:
We have the args between python3.11 and bootstrap.py. THe below image is what the args are when using vscode - launch.json - direct invoke. It also seems that the files needed for debugging e.g.
debugpy.The libraries needed for python debugging are also not copied e.g. debugpy etc. Below is what is copied with aws-sam direct invoke which is the correct files needed to debug:
On the other hand, in the same project, that same command works great with NodeJS.
The expected behavior is to have the SAM lambda container wait on port --debug-port to allow IDE / VSCode to attach to it for debugging. Constantly having to launch direct-invoke tanks the developer experience and sam local start-api is a perfect tool for auto-reload and debugging.
Same with CDK:
Note, the same behavior happens with a CDK project where the command is run against the CDK synth template :
sam local start-api -d 5858 -t ./cdk.out/template.yamlSteps to reproduce:
sam initObserved result:
Expected result:
Expected that the sam lambda container will wait using debugpy for the IDE attach to it and then allow a developer to debug.
Additional environment details (Ex: Windows, Mac, Amazon Linux etc)
sam --version: 1.106.0Feel free if you need more info. Thanks!