Thundra APM
Search…
Thundra Web Console
Node.js
Python
Java
Go
.Net
IDE Integrations
Observability
Performance
Deployment Integrations
AWS Lambda Debugging for Serverless Node.js
Using the AWS Lambda Debugging with Node.js Lambda Functions
- 1.Integrate Thundra’s Node.js agent with your Lambda function using one of the available integration options.
- 2.​Enable the AWS Lamda debugging by adding the
thundra_agent_lambda_debugger_auth_tokenenvironment variable. - 3.​Specify a session name if needed (as long as you don't have multiple concurrent debugging sessions, you can use the default value and not specify a session name).
- 4.Start the debug session in your IDE and invoke your function. Thundra Debugger will establish the connection between the IDE and your Lambda function using your authentication token and the session name.
- 5.
For longer debugging sessions, you will need to make sure to increase your function's timeout value when you enable AWS Lambda Debugging.
To use the AWS Lambda Debugging debugging feature, you need to use version 2.9.1 of Thundra’s Node.js agent along with layer version 42 or higher.
Using the AWS Lambda Debugging Debugging with TypeScript
A small configuration is needed in order to work with TypeScript files.
Before starting a session with our VSCode plugin, select
Thundra: Change local root command in the menu and point to your build folder where you keep your .js and .js.map files. Another thing to make sure of is that to match your local build folder structure to the remote. Unfortunately, it's hard to make assumptions about the user's folder structure. So, it's best to make this manually at the moment. Putting
"rootDir": "." in your .tsconfig file should compile your files to match the folder structure. For example, if your code is in
src/api/hello.ts file, AWS Lambda will put the compiled code under src/api/hello.js and specifying the root directory in your .tsconfig will compile your code under, let's say build/src/api/hello.js . By changing the local root of our plugin to
./build, you are ready to start debugging your function.If you use any module bundler solutions like Webpack, AWS Lambda Debugging debugging features for both JavaScript and TypeScript will not work properly with bundled files.
You need to set
keepOutputDirectory: true to upload your source files to the remote and match your local setup with it to start debugging.Enabling the AWS Lambda Debugging Debugging
The fastest way to enable the Thundra Debugger for a Lambda function is to set the
thundra_agent_lambda_debugger_auth_token environment variable to the authentication token that you receive from the Thundra console. By doing this, Thundra will start your function in debug mode and you will be able to connect your function from your IDE to start the debugging session.Disabling the AWS Lambda Debugging Debugging
The AWS Lambda Debugging feature is disabled by default. However, if you want to manually disable it, you can set the
thundra_agent_lambda_debugger_enable environment variable to false. This ensures that even if you have thundra_agent_lambda_debugger_auth_token, AWS Lambda Debugging will still be disabled.Specifying a session name
In order to match the two ends of an AWS Lambda Debugging session (your Lambda function invocation and your local IDE), Thundra uses session names. When you enable online debugging in your Lambda function, the session name is set to the predefined value
default. If you want to use another session name, you can specify it using the thundra_agent_lambda_debugger_session_name environment variable.Broker Host Selection
Thundra’s broker establishes communication between your Lambda function and your IDE debugger by receiving data from the Lambda function and then forwarding it to your IDE. To reduce overhead during this transmission process, you need to select a debugger that provides the shortest pathway between your Lambda and IDE. Similarly, the broker host needs to be close to your Lambda function or your IDE location.
Thundra provides a broker host in Oregon by default, but we also support different broker hosts (listed below). You can select a broker host and set it to the
thundra_agent_lambda_debugger_broker_host environment variable to reduce latency during a debugging session.Concurrent Session Limit
The number of debugging sessions an account can perform is limited for now. Currently, you can start two concurrent debugging sessions at a time. Contact us at [email protected] if you want to increase your concurrent session limits.
Environment variables to configure AWS Lambda Debugging
Environment Variable
Description
thundra_agent_lambda_debugger_auth_token​
The authentication token you receive from the Thundra console. This field is required and there is no default value.
thundra_agent_lambda_debugger_session_nameThe unique session name that identifies a current debugging session from other concurrent debugging sessions. The default value is "default."
thundra_agent_lambda_debugger_broker_hostThe broker host address to which Thundra connects to start a debugging session with your IDE. The default value is
debug.thundra.io.thundra_agent_lambda_debugger_broker_hostThe broker port that Thundra uses to connect the broker. The default value is 444.
thundra_agent_lambda_debugger_wait_maxThe maximum amount of time in milliseconds that your function should wait until a debugging session request comes from the IDE. The default value is 60000.
thundra_agent_lambda_debugger_logs_enableThe Boolean value that enables Thundra debugger logs. The default value is false.
thundra_agent_lambda_debugger_enable
The Boolean value that enables/disables the Thundra debugger. It can be set to true to enable the debugger (the authentication token environment variable should also be set), and it can be set to false to disable the Thundra debugger.