feat: implment awk-sdk v2 dynamodb instrumentation

[astorm]

Implements #1953

This PR add instrumentations (and tests for same) for the DynamoDB APIs provided by the v2 of the AWS SDK.

(sorting out some jenkins issues, but 99% sure the problems are not related to the code in the PR)

Checklist

• Implement code
• Add tests
• Update documentation
• Add CHANGELOG.asciidoc entry
• Commit message follows commit guidelines

[apmmachine]

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

• Build Cause: astorm commented: jenkins run the tests please

• Start Time: 2021-07-01T16:32:36.007+0000

• Duration: 18 min 1 sec

• Commit: c8b3ecc

Test stats 🧪

Test	Results
Failed	0
Passed	19040
Skipped	0
Total	19040

Trends 🧪

[astorm]

Jenkins run the tests please

[astorm]

jenkins run the tests please

[trentm]

A first pass with non-substantive feedback. I'll start playing with it tomorrow for real to give feedback on the actual DynamoDB-bits.

[trentm]

For the record here is an example generated span for a "client.query()" call:

    {
        "span": {
            "name": "DynamoDB Query trentm-play-music1",
            "type": "db",
            "id": "f856792e537b92f1",
            "transaction_id": "90875b81b15592de",
            "parent_id": "f6db83a9d68c20d0",
            "trace_id": "1d119f65efe37bd607b366739402abd8",
            "subtype": "dynamodb",
            "action": "query",
            "timestamp": 1625089047718089,
            "duration": 43.402,
            "context": {
                "db": {
                    "instance": "us-east-2",
                    "statement": "Genre = :genre",
                    "type": "dynamodb"
                },
                "destination": {
                    "address": "localhost:4566",
                    "port": 4566,
                    "service": {
                        "name": "dynamodb",
                        "type": "db",
                        "resource": "dynamodb"
                    },
                    "cloud": {
                        "region": "us-east-2"
                    }
                }
            },
            "sync": false,
            "outcome": "success",
            "sample_rate": 1
        }
    }

[trentm]

Here is an example captured error event for a failed conditional PutItem:

    {
        "error": {
            "id": "90894a94779679a8f616be4d9375ab2e",
            "timestamp": 1625092950223000,
            "parent_id": "7445b213ec2b12d8",
            "trace_id": "b8eb787611b104ac14826fb0b6677384",
            "transaction_id": "c955fc327db61502",
            "transaction": {
                "type": null,
                "sampled": true
            },
            "context": {
                "user": {},
                "tags": {},
                "custom": {}
            },
            "exception": {
                "message": "The conditional request failed",
                "type": "ConditionalCheckFailedException",
                "handled": true,
                "code": "ConditionalCheckFailedException",
                "attributes": {
                    "message": "The conditional request failed",
                    "time": "2021-06-30T22:42:30.223Z",
                    "requestId": "b70f4a22-c2b9-4264-a310-20138ac67c30",
                    "statusCode": 400,
                    "retryable": false,
                    "retryDelay": 20.310348847722526
                },
                "module": "aws-sdk",
                "stacktrace": [
                    {
                        "filename": "node_modules/aws-sdk/lib/protocol/json.js",
                        "lineno": 52,
                        "function": "extractError",
                        "library_frame": true,
                        "abs_path": "/Users/trentm/el/apm-agent-nodejs12/node_modules/aws-sdk/lib/protocol/json.js",
                        "pre_context": [
                            "  }",
                            ""
                        ],
                        "context_line": "  resp.error = util.error(new Error(), error);",
                        "post_context": [
                            "}",
                            ""
                        ]
                    },
                    {
                        "filename": "node_modules/aws-sdk/lib/sequential_executor.js",
                        "lineno": 106,
                        "function": "callListeners",
                        "library_frame": true,
                        "abs_path": "/Users/trentm/el/apm-agent-nodejs12/node_modules/aws-sdk/lib/sequential_executor.js",
                        "pre_context": [
                            "      } else { // synchronous listener",
                            "        try {"
                        ],
                        "context_line": "          listener.apply(self, args);",
                        "post_context": [
                            "        } catch (err) {",
                            "          error = AWS.util.error(error || new Error(), err);"
                        ]
                    },
                    {
                        "filename": "node_modules/aws-sdk/lib/sequential_executor.js",
                        "lineno": 78,
                        "function": "emit",
                        "library_frame": true,
                        "abs_path": "/Users/trentm/el/apm-agent-nodejs12/node_modules/aws-sdk/lib/sequential_executor.js",
                        "pre_context": [
                            "    var listeners = this.listeners(eventName);",
                            "    var count = listeners.length;"
                        ],
                        "context_line": "    this.callListeners(listeners, eventArgs, doneCallback);",
                        "post_context": [
                            "    return count > 0;",
                            "  },"
                        ]
                    },
                    {
                        "filename": "node_modules/aws-sdk/lib/request.js",
                        "lineno": 688,
                        "function": "emit",
                        "library_frame": true,
                        "abs_path": "/Users/trentm/el/apm-agent-nodejs12/node_modules/aws-sdk/lib/request.js",
                        "pre_context": [
                            "",
                            "    var origEmit = AWS.SequentialExecutor.prototype.emit;"
                        ],
                        "context_line": "    origEmit.call(this, eventName, args, function (err) {",
                        "post_context": [
                            "      if (err) this.response.error = err;",
                            "      done.call(this, err);"
                        ]
                    }
                ]
            },
            "culprit": "extractError (node_modules/aws-sdk/lib/protocol/json.js)"
        }
    }

That's from this PutItem:

        var params = {
          TableName: TABLE_NAME,
          Item: putItemItemFromObject(
            {
              Artist: 'No One You Know',
              SongTitle: 'Somewhere Down The Road',
              AlbumTitle: 'Somewhat Famous',
              Genre: 'Country',
              Year: 1984
            }
          ),
          ConditionExpression: 'attribute_not_exists(SongTitle)'
        }
        ddbClient.putItem(params, function (err, data) {
          log.info({params, err, data}, 'putItem conditional')
          next(err ? null : new Error('expected conditional PutItem to fail, but it did not'))
        })

[trentm]

Here is a play-dynamodb.js script (and sample output against localstack): https://gist.github.com/trentm/5f9caf59fff246bc99088cf458e29ae9

[trentm]

Here is a play-dynamodb.js script

That ran fine against real-AWS as well, and generated spans that I expect. 👍

[trentm]

Assuming tests pass.

[astorm]

jenkins run the tests please