feat: implment awk-sdk v2 dynamodb instrumentation

.tav.yml

@@ -413,13 +413,14 @@ body-parser:
     - node test/sanitize-field-names/express.js
 
 aws-sdk:
-  # We want this version range:
+  # We want a version range something like this:
   #   versions: '>=2.858 <3'
   # However, awk-sdk releases *very* frequently (almost every day) and there
   # is no need to test *all* those releases. Instead we statically list every
   # N=5 releases to test.
   #
   # Maintenance note: This should be updated periodically.
-  versions: '2.858.0 || 2.863.0 || 2.868.0 || 2.873.0 || 2.878.0 || 2.883.0 || 2.888.0 || 2.893.0 || 2.898.0 || 2.903.0 || 2.908.0 || 2.913.0 || 2.918.0 || >2.918 <3'
+  versions: '2.876.0 || 2.881.0 || 2.886.0 || 2.891.0 || 2.896.0 || 2.901.0 || 2.906.0 || 2.911.0 || 2.916.0 || 2.921.0 || 2.926.0 || 2.931.0 || 2.936.0 || >2.918 <3'
   commands:
     - node test/instrumentation/modules/aws-sdk/sqs.js
+    - node test/instrumentation/modules/aws-sdk/dynamodb.js

CHANGELOG.asciidoc

@@ -41,6 +41,9 @@ Notes:
 * Add <<disable-send, `disableSend`>> configuration option. This supports some
   use cases using the APM agent **without** an APM server. ({issues}2101[#2101])
 
+* Add instrumentation of all DynamoDB methods when using the
+  https://www.npmjs.com/package/aws-sdk[JavaScript AWS SDK v2] (`aws-sdk`).
+
 [float]
 ===== Bug fixes
 

docs/supported-technologies.asciidoc

@@ -72,7 +72,7 @@ The Node.js agent will automatically instrument the following modules to give yo
 [options="header"]
 |=======================================================================
 |Module |Version |Note
-|https://www.npmjs.com/package/aws-sdk[aws-sdk] |>1 <3 |Will instrument SQS send/receive/delete messages, all S3 methods
+|https://www.npmjs.com/package/aws-sdk[aws-sdk] |>1 <3 |Will instrument SQS send/receive/delete messages, all S3 methods, and all DynamoDB methods
 |https://www.npmjs.com/package/cassandra-driver[cassandra-driver] |>=3.0.0 |Will instrument all queries
 |https://www.npmjs.com/package/elasticsearch[elasticsearch] |>=8.0.0 |Will instrument all queries
 |https://www.npmjs.com/package/@elastic/elasticsearch[@elastic/elasticsearch] |>=7.0.0 <8.0.0 |Will instrument all queries

lib/instrumentation/modules/aws-sdk.js

@@ -3,10 +3,12 @@ const semver = require('semver')
 const shimmer = require('../shimmer')
 const { instrumentationS3 } = require('./aws-sdk/s3')
 const { instrumentationSqs } = require('./aws-sdk/sqs')
+const { instrumentationDynamoDb } = require('./aws-sdk/dynamodb.js')
 
 const instrumentorFromSvcId = {
   s3: instrumentationS3,
-  sqs: instrumentationSqs
+  sqs: instrumentationSqs,
+  dynamodb: instrumentationDynamoDb
 }
 
 // Called in place of AWS.Request.send and AWS.Request.promise

lib/instrumentation/modules/aws-sdk/dynamodb.js

@@ -0,0 +1,122 @@
+'use strict'
+const constants = require('../../../constants')
+const TYPE = 'db'
+const SUBTYPE = 'dynamodb'
+const ACTION = 'query'
+
+function getRegionFromRequest (request) {
+  return request && request.service &&
+        request.service.config && request.service.config.region
+}
+
+function getPortFromRequest (request) {
+  return request && request.service &&
+        request.service.endpoint && request.service.endpoint.port
+}
+
+function getMethodFromRequest (request) {
+  const method = request && request.operation
+  if (method) {
+    return method[0].toUpperCase() + method.slice(1)
+  }
+}
+
+function getStatementFromRequest (request) {
+  const method = getMethodFromRequest(request)
+  if (method === 'Query' && request && request.params && request.params.KeyConditionExpression) {
+    return request.params.KeyConditionExpression
+  }
+  return undefined
+}
+
+function getAddressFromRequest (request) {
+  return request && request.service && request.service.endpoint &&
+        request.service.endpoint.host
+}
+
+function getTableFromRequest (request) {
+  const table = request && request.params && request.params.TableName
+  if (!table) {
+    return ''
+  }
+  return ` ${table}`
+}
+
+// Creates the span name from request information
+function getSpanNameFromRequest (request) {
+  const method = getMethodFromRequest(request)
+  const table = getTableFromRequest(request)
+  const name = `DynamoDB ${method}${table}`
+  return name
+}
+
+function shouldIgnoreRequest (request, agent) {
+  return false
+}
+
+// Main entrypoint for SQS instrumentation
+//
+// Must call (or one of its function calls must call) the
+// `orig` function/method
+function instrumentationDynamoDb (orig, origArguments, request, AWS, agent, { version, enabled }) {
+  if (shouldIgnoreRequest(request, agent)) {
+    return orig.apply(request, origArguments)
+  }
+
+  const type = TYPE
+  const subtype = SUBTYPE
+  const action = ACTION
+  // const action = getActionFromRequest(request)
+  const name = getSpanNameFromRequest(request)
+  const span = agent.startSpan(name, type, subtype, action)
+  if (!span) {
+    return orig.apply(request, origArguments)
+  }
+  // span.setDestinationContext(getMessageDestinationContextFromRequest(request))
+  // span.setMessageContext(getMessageContextFromRequest(request))
+  span.setDbContext({
+    instance: getRegionFromRequest(request),
+    statement: getStatementFromRequest(request),
+    type: SUBTYPE
+  })
+  span.setDestinationContext({
+    address: getAddressFromRequest(request),
+    port: getPortFromRequest(request),
+    service: {
+      name: SUBTYPE,
+      type: 'db',
+      resource: SUBTYPE
+    },
+    cloud: {
+      region: getRegionFromRequest(request)
+    }
+  })
+
+  request.on('complete', function (response) {
+    if (response && response.error) {
+      const errOpts = {
+        skipOutcome: true
+      }
+      agent.captureError(response.error, errOpts)
+      span._setOutcomeFromErrorCapture(constants.OUTCOME_FAILURE)
+    }
+
+    // we'll need to manually mark this span as async.  The actual async hop
+    // is captured by the agent's async hooks instrumentation
+    span.sync = false
+    span.end()
+  })
+
+  return orig.apply(request, origArguments)
+}
+
+module.exports = {
+  instrumentationDynamoDb,
+
+  // exported for testing
+  getRegionFromRequest,
+  getPortFromRequest,
+  getStatementFromRequest,
+  getAddressFromRequest,
+  getMethodFromRequest
+}