Using `captureAWSClient` over directly referenced dynamodb client fails

[nolde]

The following code does not work:

const DynamoDB = require('aws-sdk/clients/dynamodb')
const xray = require('aws-xray-sdk-core')
const ddb = xray.captureAWSClient(new DynamoDB())

In theory, it should be just the same as encapsulating new AWS.DynamoDB() coming straight from aws-sdk, but it does not work.

This is specially problematic in AWS Lambda environment, where loading more than you need makes you use more memory and more time.

[awssandra]

Hi nolde,

I haven't been able to reproduce your issue.
Here is the code I used to test.

var xray = require('aws-xray-sdk-core');   // v1.2.0

const DynamoDB = require('aws-sdk/clients/dynamodb') // aws-sdk v2.193.0
const dynamodb = xray.captureAWSClient(new DynamoDB())

exports.handler = (event, context, callback) => {
  // params = { params here };

  dynamodb.batchGetItem(params, function (err, data) {
    if (err) console.log(err, err.stack); // an error occurred
    else     console.log(data);           // successful response
  });

  callback(null, 'Hello from Lambda');
};

And the resultant trace:

    "Duration": 0.054,
    "Id": "xxxxxxxxxxxx",
    "Segments": [
        {
            "Document": {
                "id": "5fb2ad3a78c0c7a8",
                "name": "myDynamoTest",
                "start_time": 1518547704.129,
                "end_time": 1518547704.176,
                "parent_id": "5adfc1d316a9ed6d",
                "aws": {
                    "function_arn": "arn:aws:xxxxxxxx",
                    "resource_names": [
                        "myDynamoTest"
                    ],
                    "account_id": "243559052476"
                },
                "trace_id": "xxxxxxxx",
                "origin": "AWS::Lambda::Function",
                "subsegments": [
                    {
                        "id": "ba73dac2d7ac91ee",
                        "name": "DynamoDB",
                        "start_time": 1518547704.155,
                        "end_time": 1518547704.156,
                        ...
                        "http": {
                            "response": {}
                        },
                        "aws": {
                            "operation": "BatchGetItem",
                            "region": "us-east-1",
                            "request_id": "",
                            "retries": 0
                        },
                        "namespace": "aws"
                    }
                ]
            },
            "Id": "5fb2ad3a78c0c7a8"
        }
...

Can you post a code snippet to reproduce the issue? Are there any errors in the logs?

Thanks,
Sandra

[nolde]

After reviewing the issue, I found out that it was actually my mistake.

Thanks for the quick reply, though.

[nolde]

And should the usage below work?

var xray = require('aws-xray-sdk-core')

const AWS = require('aws-sdk')
const docclient = xray.captureAWSClient(new AWS.DynamoDB.DocumentClient())

[awssandra]

The forums post here covers this: https://forums.aws.amazon.com/thread.jspa?messageID=821049&#821049

The DocumentClient constructor is not captured in the same way the base level clients are - this is a special case of the AWS SDK not conforming to the same initialization code path that the other AWS Clients utilize and the hook they provide to us does not properly set up tracing.

We are currently investigating a work around for this issue.

Hope this helps,
Sandra

[nolde]

Ok!
Thanks for the quick answers!

[serverlesspolska]

Is this issue resolved now?

[leonardovillela]

Any progress?

[haotianw465]

Re-open due to popular requests. We need to work with AWS SDK team so there is a proper public interface to plugin the X-Ray intercepter on the Document client. This is on our backlog and we already brought this issue to AWS SDK team's attention.

We will post an update as soon as we have further information. Please stay tuned and thank you for your patience.