fix(opentelemetry-instrumentation-aws-sdk): error when ReturnConsume…

…dCapacity is set to None (#899) * DynamoDB metrics for BatchGetItem fails when ReturnConsumedCapacity is set to NONE * fix(unit): add unit test and change if * fix(formatting): wrong formatting * fix(formatting): formatting Co-authored-by: Amir Blum <amir@aspecto.io>
open-telemetry · Feb 28, 2022 · e7ab4d0 · e7ab4d0
1 parent f436601
commit e7ab4d0
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 1 deletion.
diff --git a/plugins/node/opentelemetry-instrumentation-aws-sdk/src/services/dynamodb.ts b/plugins/node/opentelemetry-instrumentation-aws-sdk/src/services/dynamodb.ts
@@ -64,7 +64,7 @@ export class DynamodbServiceExtension implements ServiceExtension {
     const operation = response.request.commandName;
 
     if (operation === 'BatchGetItem') {
-      if ('ConsumedCapacity' in response.data) {
+      if (Array.isArray(response.data?.ConsumedCapacity)) {
         span.setAttribute(
           SemanticAttributes.AWS_DYNAMODB_CONSUMED_CAPACITY,
           response.data.ConsumedCapacity.map(

diff --git a/plugins/node/opentelemetry-instrumentation-aws-sdk/test/dynamodb.test.ts b/plugins/node/opentelemetry-instrumentation-aws-sdk/test/dynamodb.test.ts
@@ -196,5 +196,50 @@ describe('DynamoDB', () => {
         }
       );
     });
+
+    it('should populate BatchGetIem when consumedCapacity is undefined', done => {
+      mockV2AwsSend(responseMockSuccess, {
+        Responses: { 'test-table': [{ key1: { S: 'val1' } }] },
+        UnprocessedKeys: {},
+        ConsumedCapacity: undefined,
+      } as AWS.DynamoDB.Types.BatchGetItemOutput);
+
+      const dynamodb = new AWS.DynamoDB.DocumentClient();
+      const dynamodb_params = {
+        RequestItems: {
+          'test-table': {
+            Keys: [{ key1: { S: 'val1' } }],
+            ProjectionExpression: 'id',
+          },
+        },
+        ReturnConsumedCapacity: 'NONE',
+      };
+      dynamodb.batchGet(
+        dynamodb_params,
+        (
+          err: AWSError,
+          data: AWS.DynamoDB.DocumentClient.BatchGetItemOutput
+        ) => {
+          const spans = getTestSpans();
+          expect(spans.length).toStrictEqual(1);
+          const attrs = spans[0].attributes;
+          expect(attrs[SemanticAttributes.DB_SYSTEM]).toStrictEqual('dynamodb');
+          expect(attrs[SemanticAttributes.DB_OPERATION]).toStrictEqual(
+            'BatchGetItem'
+          );
+          expect(
+            attrs[SemanticAttributes.AWS_DYNAMODB_TABLE_NAMES]
+          ).toStrictEqual(['test-table']);
+          expect(
+            attrs[SemanticAttributes.AWS_DYNAMODB_CONSUMED_CAPACITY]
+          ).toBeUndefined();
+          expect(
+            JSON.parse(attrs[SemanticAttributes.DB_STATEMENT] as string)
+          ).toEqual(dynamodb_params);
+          expect(err).toBeFalsy();
+          done();
+        }
+      );
+    });
   });
 });