feat(aws-sdk): support for aws-sdk v3 (#91)

BREAKING CHANGE: remove `component` attribute from aws-sdk spans

BREAKING CHANGE: change hooks function signature in aws-sdk

Author: Amir Blum

package.json

@@ -2,6 +2,7 @@
     "name": "root",
     "private": true,
     "scripts": {
+        "watch": "lerna run watch --parallel",
         "test": "lerna run test",
         "test:ci": "lerna run test:ci --since origin/master",
         "build": "lerna run build",

packages/instrumentation-aws-sdk/.tav.yml

@@ -0,0 +1,16 @@
+'aws-sdk':
+  # there are so many version to test, it can take forever.
+  # we will just sample few of them
+  versions: ">=2.880.0 || 2.706.0 || 2.608.0 || 2.518.0 || 2.422.0 || 2.315.0 || 2.224.1 || 2.122.0 || 2.59.0"
+  commands:
+    - yarn test
+
+'@aws-sdk/client-s3':
+  versions: ">=3.0.0"
+  commands:
+    - yarn test
+
+'@aws-sdk/client-sqs':
+  versions: ">=3.0.0"
+  commands:
+    - yarn test

packages/instrumentation-aws-sdk/README.md

@@ -1,7 +1,7 @@
 # OpenTelemetry aws-sdk Instrumentation for Node.js
 [![NPM version](https://img.shields.io/npm/v/opentelemetry-instrumentation-aws-sdk.svg)](https://www.npmjs.com/package/opentelemetry-instrumentation-aws-sdk)
 
-This module provides automatic instrumentation for [`aws-sdk`](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/).
+This module provides automatic instrumentation for [`aws-sdk` v2](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/) and [`@aws-sdk` v3](https://github.com/aws/aws-sdk-js-v3)
 
 ## Installation
 
@@ -49,32 +49,36 @@ aws-sdk instrumentation has few options available to choose from. You can set th
 
 
 ## Span Attributes
-This instrumentation patch the internal `Request` object, which means that each sdk operation will create a single span with attributes from 3 sources:
+Both V2 and V3 instrumentations are collecting the following attributes:
+| Attribute Name | Type | Description | Example |
+| -------------- | ---- | ----------- | ------- |
+| `rpc.system` | string | Always equals "aws-api" | 
+| `rpc.method` | string | The name of the operation corresponding to the request, normalized to camelCase | `putObject` |
+| `rpc.service` | string | The name of the service to which a request is made, as returned by the AWS SDK, normalized to lower case | `s3` | 
+| `aws.region` | string | Region name for the request | "eu-west-1" |
 
-### Default attributes
-Each span will have the following attributes:
+### V2 attributes
+In addition to the above attributes, the instrumentation also collect the following for V2 ONLY:
 | Attribute Name | Type | Description | Example |
 | -------------- | ---- | ----------- | ------- |
-| `component` | string | Always equals "aws-sdk" | "aws-sdk" |
 | `aws.operation` | string | The method name for the request. | for `SQS.sendMessage(...)` the operation is "sendMessage" |
 | `aws.signature.version` | string | AWS version of authentication signature on the request. | "v4" |
-| `aws.region` | string | Region name for the request | "eu-west-1" |
 | `aws.service.api` | string | The sdk class name for the service | "SQS" |
 | `aws.service.identifier` | string | Identifier for the service in the sdk | "sqs" |
 | `aws.service.name` | string | Abbreviation name for the service | "Amazon SQS" |
 | `aws.request.id` | uuid | Request unique id, as returned from aws on response | "01234567-89ab-cdef-0123-456789abcdef" |
 | `aws.error` | string | information about a service or networking error, as returned from AWS | "UriParameterError: Expected uri parameter to have length >= 1, but found "" for params.Bucket" |
 
 ### Custom User Attributes
-The instrumentation user can configure a `preRequestHook` function which will be called before each request, with the request object and the corresponding span.  
+The instrumentation user can configure a `preRequestHook` function which will be called before each request, with a normalized request object (across v2 and v3) and the corresponding span.  
 This hook can be used to add custom attributes to the span with any logic.  
 For example, user can add interesting attributes from the `request.params`, and write custom logic based on the service and operation.
 Usage example:
 ```js
 awsInstrumentationConfig = {
   preRequestHook: (span, request) => {
-    if (span.attributes["aws.service.api"] === 's3') {
-      span.setAttribute("s3.bucket.name", request.params["Bucket"]);
+    if (span.serviceName === 's3') {
+      span.setAttribute("s3.bucket.name", request.commandInput["Bucket"]);
     }
   }
 };
@@ -85,6 +89,7 @@ AWS contains dozens of services accessible with the JS SDK. For many services, t
 
 Specific service logic currently implemented for:
 * [SQS](./docs/sqs.md)
+* DynamoDb
 
 ---
 

packages/instrumentation-aws-sdk/package.json

@@ -24,10 +24,11 @@
         "build": "tsc",
         "prepare": "yarn run build",
         "test": "mocha",
-        "test:ci": "yarn test",
+        "test:ci": "yarn test-all-versions",
         "watch": "tsc -w",
         "version:update": "node ../../scripts/version-update.js",
-        "version": "yarn run version:update"
+        "version": "yarn run version:update",
+        "test-all-versions": "tav"
     },
     "bugs": {
         "url": "https://github.com/aspecto-io/opentelemetry-ext-js/issues"
@@ -39,13 +40,18 @@
         "opentelemetry-propagation-utils": "^0.5.0"
     },
     "devDependencies": {
+        "@aws-sdk/client-s3": "^3.8.1",
+        "@aws-sdk/client-sqs": "^3.8.1",
+        "@aws-sdk/types": "^3.6.1",
         "@opentelemetry/api": "^0.18.0",
         "@opentelemetry/node": "^0.18.0",
         "@opentelemetry/tracing": "^0.18.0",
         "@types/mocha": "^8.2.0",
         "aws-sdk": "^2.780.0",
         "expect": "^26.6.2",
         "mocha": "^8.3.0",
+        "nock": "^13.0.11",
+        "test-all-versions": "^5.0.1",
         "ts-node": "^9.1.1",
         "typescript": "^4.0.5"
     },