Integration Options for Python SDK
Using Layers
Without Layers
Serverless Framework
AWS SAM
AWS CDK
Docker Image
Bundle all your Python module files and any additional required Python libraries, and then upload it to the AWS Lambda console using the “Upload a.zip file” option for the code entry type. Note that Thundra dependencies are not expected to be in the artifact to be uploaded, as they come with a layer that will be utilized at a later point
Add the API key to the environment variables on the Amazon Lambda console.
Add Thundra layer
Next, add the Thundra layer by clicking on the Layers option in the Designer tab on your Lambda function console. Then select the “Add Layer” button and add the Thundra layer's ARN.
arn:aws:lambda:${region}:269863060030:layer:thundra-lambda-python-layer:${latest-version}
Latest version of the Thundra Python layer
Note that the region of the ARN is dynamic, so you need to change it accordingly to the region where you deploy your function. So let’s say that you deploy your Lambda function to the Oregon (
us-west-2) region. The layer ARN will be:arn:aws:lambda:us-west-2:269863060030:layer:thundra-lambda-python-layer:${layer-version}Configure handler
Set the handler to
thundra.handler.wrapper. Set the thundra_agent_lambda_handler environment variable value to your original handler (e.g., handler.handle).Step 3: Invoke your deployed function by clicking on the Test button on the top right
Clicking on the “Test” button, which is located on the top right side of the AWS console, will result in an invocation of your function (after you have configured test data per the specifications of your function).
Step 4: Monitor your function with Thundra
After generating your first invocation, the “Next” button will appear in the Invocation Monitor bar. Simply click the button to see monitoring data from your invocation.
In the project directory, run the following command:
pip3 install thundra -t .
Bundle all your Python module files and any additional required Python libraries, and then upload it to the AWS Lambda console using the “Upload a.zip file” option for the code entry type.
Add the API key to the environment variables on the Amazon Lambda console.
Configure Handler
Set the handler to thundra.handler.wrapper. Set the thundra_agent_lambda_handler environment variable value to your handler.
Clicking on the “Test” button, which is located on the top right side of the AWS console, will result in an invocation of your function (after you have configured test data per the specifications of your function).
After generating your first invocation, the “Next” button will appear in the Invocation Monitor bar. Simply click the button to see monitoring data from your invocation.
npm install serverless-plugin-thundra
After installing Thundra’s serverless plugin, specify it as a plugin for your serverless environment by adding it under the plugins section of your serverless.yml file.
serverless.yml
plugins:
- serverless-plugin-thundra
Add the
thundra component under custom with apiKey under that, as seen below:serverless.yml
custom:
thundra:
apiKey: <YOUR THUNDRA API KEY>
Step 4: Add the
thundra_apiKey to Environment Variables under the Provider Section in serverless.ymlserverless.yml
provider:
environment:
thundra_apiKey: <YOUR THUNDRA API KEY>
serverless deploy
serverless invoke --function functionName
After generating your first invocation, the “Next” button will appear in the Invocation Monitor bar. Simply click the button to see monitoring data from your invocation.
- Add the
thundra_apiKeyenvironment variable along with your Thundra API key.
Globals:
Function:
...
Environment:
Variables:
thundra_apiKey: <your_api_key>
- Add the Thundra layer to “Layers” in the Globals section. The
ThundraAWSAccountNoandThundraPythonLayerVersionparameters are defined in the Parameters section in the following configuration:
Latest layer version of thundra python layer:
ThundraAWSAccountNo:
Type: Number
Default: 269863060030
ThundraPythonLayerVersion:
Type: Number
Default: 12 # Or use any other version
Globals:
...
Function:
...
Layers:
- !Sub arn:aws:lambda:${AWS::Region}:${ThundraAWSAccountNo}:layer:thundra-lambda-python-layer:${ThundraPythonLayerVersion}
…
- Change the
handlerof functions to be wrapped tothundra.handler.wrapper. Alternatively, if you want to wrap all the functions in your SAM configuration file, you can set the handler in theGlobalssection.
Globals:
Function:
...
Handler: thundra.handler.wrapper
- For each wrapped function, add the
thundra_agent_lambda_handlerenvironment variable with the value set to the handler path of your function.
Resources:
HelloWorldFunction1:
Type: AWS::Serverless::Function
Properties:
Environment:
Variables:
thundra_agent_lambda_handler: hello_world_1.app.lambda_handler
An example configuration:
Parameters:
ThundraAWSAccountNo:
Type: Number
Default: 269863060030
ThundraPythonLayerVersion:
Type: Number
Default: 11 # Or use any other version
Globals:
Function:
Runtime: python3.7
Timeout: 5
Handler: thundra.handler.wrapper
Layers:
- !Sub arn:aws:lambda:${AWS::Region}:${ThundraAWSAccountNo}:layer:thundra-lambda-python-layer:${ThundraPythonLayerVersion}
Environment:
Variables:
thundra_apiKey: <your_api_key>
Resources:
HelloWorldFunction1:
Type: AWS::Serverless::Function
Properties:
Environment:
Variables:
thundra_agent_lambda_handler: hello_world_1.app.lambda_handler
To build and run your functions locally:
sam build && sam local invoke
After generating your first invocation, the “Next” button will appear in the Invocation Monitor bar. Simply click the button to see monitoring data from your invocation.
- Add the
thundra_apiKeyenvironment variable with your Thundra API key.
from aws_cdk import (core,
aws_lambda as lambda_)
class YourConstructClass(core.Construct):
def __init__(self, scope: core.Construct, id: str):
super().__init__(scope, id)
thundraApiKey = <your_api_key>
handler = lambda_.Function(self, "YourHandler",
..., # other function properties
environment=dict(
..., # other environment variables
thundra_apiKey=thundraApiKey)
- Define the Thundra layer and add it to your function properties.
Latest layer version of thundra python layer:
from aws_cdk import (core,
aws_lambda as lambda_)
class YourConstructClass(core.Construct):
def __init__(self, scope: core.Construct, id: str):
super().__init__(scope, id)
thundraApiKey = <your_api_key>
thundraAWSAccountNo = 269863060030
thundraPythonLayerVersion = 31 # or any other version
thundraPythonLayer = lambda_.LayerVersion.from_layer_version_arn(self, "ThundraLayer",
"arn:aws:lambda:{}:{}:layer:thundra-lambda-python-layer:{}".format(
core.Aws.REGION, thundraAWSAccountNo, thundraPythonLayerVersion)),
handler = lambda_.Function(self, "YourHandler",
..., # other function properties
environment=dict(
..., # other environment variables
thundra_apiKey=thundraApiKey),
layers=[
thundraPythonLayer,
... # other layers
]
)
Aws.REGION is a pseudo parameter which is bootstrapped from your stack's environment configuration.
- Change the handler of your function to
thundra.handler.wrapper, and add the environment variablethundra_agent_lambda_handlerwith your handler.
from aws_cdk import (core,
aws_lambda as lambda_)
class YourConstructClass(core.Construct):
def __init__(self, scope: core.Construct, id: str):
super().__init__(scope, id)
thundraApiKey = <your_api_key>
thundraAWSAccountNo = 269863060030
thundraPythonLayerVersion = 31 # or any other version
thundraPythonLayer = lambda_.LayerVersion.from_layer_version_arn(self, "ThundraLayer",
"arn:aws:lambda:{}:{}:layer:thundra-lambda-python-layer:{}".format(
core.Aws.REGION, thundraAWSAccountNo, thundraPythonLayerVersion)),
handler = lambda_.Function(self, "YourHandler",
..., # other function properties
handler=thundra.handler.wrapper
environment=dict(
..., # other environment variables
thundra_apiKey=thundraApiKey,
thundra_agent_lambda_handler=<your_handler>),
layers=[
thundraPythonLayer,
... # other layers
]
)
An example configuration:
from aws_cdk import (core,
aws_lambda as lambda_)
class YourConstructClass(core.Construct):
def __init__(self, scope: core.Construct, id: str):
super().__init__(scope, id)
thundraApiKey = <your_api_key>
thundraAWSAccountNo = 269863060030
thundraPythonLayerVersion = 31
thundraPythonLayer = lambda_.LayerVersion.from_layer_version_arn(self, "ThundraLayer",
"arn:aws:lambda:{}:{}:layer:thundra-lambda-python-layer:{}".format(
core.Aws.REGION, thundraAWSAccountNo,
thundraPythonLayerVersion))
with open("your-lambda-handler.py", encoding="utf8") as fp:
handler_code = fp.read()
handler = lambda_.Function(self, "YourHandler",
runtime=lambda_.Runtime.PYTHON_3_8,
code=lambda_.InlineCode(handler_code),
handler="thundra.handler.wrapper",
environment=dict(
thundra_apiKey2=thundraApiKey,
thundra_agent_lambda_handler="your.handler"),
layers=[
thundraPythonLayer]
)
cdk deploy
Now you can invoke your Lambda function and see the details of your invocation in the Thundra console!
- Add the
thundra_apiKeyenvironment variable with your Thundra API key.
ENV THUNDRA_APIKEY = <your_Thundra_apikey>
- Configure handler
ENV THUNDRA_AGENT_LAMBDA_HANDLER=<your-lambda-handler>
There are two options to install Thundra. One is using the
pip command and another way is adding Thundra to your "requirements.txt".- Installing via
pip
RUN pip install thundra --target ${LAMBDA_TASK_ROOT}
- Adding Thundra to requirements.txt file
COPY requirements.txt ${LAMBDA_TASK_ROOT}
RUN pip3 install -r requirements.txt --target "${LAMBDA_TASK_ROOT}"
${LAMBDA_TASK_ROOT} is "/var/task" where your handler should be located according to AWS documentation. Check the "To create an image from an AWS base image for Lambda" section from the AWS documentation link.- Change your Docker CMD. Please make sure your current
WORKDIRis${LAMBDA_TASK_ROOT}in which both Thundra and your lambda handler are located.
CMD [ "thundra.handler.wrapper" ]
An example DockerFile:
FROM public.ecr.aws/lambda/python:3.8
# Copy function code. Handler is located under "app.py".
COPY app.py ${LAMBDA_TASK_ROOT}
ENV THUNDRA_APIKEY=<your_Thundra_apikey>
ENV THUNDRA_AGENT_LAMBDA_HANDLER="app.handler"
# installing Thundra in which your handler is.
RUN pip3 install thundra --target ${LAMBDA_TASK_ROOT}
# Set the CMD to Thundra handler
CMD [ "thundra.handler.wrapper" ]
docker build -t <image-name>
Step 5: Locally test your container image
- Run your Lambda application locally
docker run -p 9000:8080 <image name>
Invoke your local application
curl -XPOST "http://localhost:9000/2015-03-31/functions/function/invocations" -d '{}'
You should see your function’s expected response as the output of this request. You can also see the invocation logs on the console you run the Docker image.
Step 6: Push the container image to ECR and deploy it to your Lambda function
Last modified 10mo ago