Using AWS X-Ray with Amazon EventBridge
This example application shows how to use AWS X-Ray with Amazon EventBridge, using the AWS Serverless Application Model (AWS SAM).
To learn more about how this sample works, see AWS Compute Blog post: https://aws.amazon.com/blogs/compute/using-aws-x-ray-tracing-with-amazon-eventbridge/
Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the AWS Pricing page for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.
.
├── README.MD <-- This instructions file
├── xray-layer <-- Source code for X-Ray layer
├── webhook <-- Source code for the webhook (event producer)
├── targets-lambda <-- Source code for the Lambda event consumer
├── targets-sfn <-- Source code for the Step Functions event consumerRequirements
- AWS CLI already configured with Administrator permission
- AWS SAM CLI installed - minimum version 0.48.
- NodeJS 16.x installed
Installation Instructions
-
Create an AWS account if you do not already have one and login.
-
Clone the repo onto your local development machine using
git clone. -
Change into the repo's directory.
Deploy the webhook
- Run:
cd ./webhook
sam build
sam deploy --guided
When prompted for parameters, enter:
- Stack Name: eventbridge-xray-webhook
- AWS Region: your preferred AWS Region (e.g. us-east-1)
- Accept all other defaults.
-
Note the API endpoint created by the template.
-
Test the API webhook using curl or Postman. The endpoint accepts a query parameter that is stored in the event before being put on the event bus. The following query parameter options are valid:
- Routes to the Lambda consumer: https://YOUR-API-ID.execute-api.sa-east-1.amazonaws.com/Prod?target=lambda
- Routes to the Step Functions consumer: https://YOUR-API-ID.execute-api.sa-east-1.amazonaws.com/Prod?target=sfn
- Routes to an API Gateway consumer: https://YOUR-API-ID.execute-api.sa-east-1.amazonaws.com/Prod?target=apigw
Deploy and test the Lambda consumer
- Run:
cd ./targets-lambda
sam build
sam deploy --guided
When prompted for parameters, enter:
- Stack Name: eventbridge-xray-target-lambda
- AWS Region: your preferred AWS Region (e.g. us-east-1)
- Accept all other defaults.
- Route an event to the Lambda consumer by using curl or Postman to invoke the webhook:
- Open the X-Ray console, select Traces from the menu, and select the most recent trace to view the the request from webhook through to Lambda.
Deploy and test the Step Functions consumer
- Run:
cd ./targets-sfn
sam build
sam deploy --guided
When prompted for parameters, enter:
- Stack Name: eventbridge-xray-target-step-functions
- AWS Region: your preferred AWS Region (e.g. us-east-1)
- Accept all other defaults.
- Route an event to the Lambda consumer by using curl or Postman to invoke the webhook:
- Open the X-Ray console, select Traces from the menu, and select the most recent trace to view the the request from webhook through to Step Functions.
Create a Lambda layer with the X-Ray SDK
You can create a Lambda layer containing the X-Ray SDK, making it easier to add the SDK to existing Lambda functions:
- Run:
cd ./aws-xray-sdk-layer
npm install
mkdir ./layer/nodejs –p
mv ./node_modules ./layer/nodejs
- Next, deploy the AWS SAM template to create the layer: sam deploy --guided
When prompted for parameters, enter:
- Stack Name: aws-sdk-layer
- AWS Region: your preferred AWS Region (e.g. us-east-1)
- Accept all other defaults.
- After the deployment completes, the new Lambda layer is available to use. Run this command to see the available layers:
aws lambda list-layers
Next steps
The AWS Compute Blog post at the top of this README file contains additional information about the how to use Lambda layers.
If you have any questions, please raise an issue in the GitHub repo.
==============================================
Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: MIT-0