dd-trace/packages/datadog-plugin-aws-sdk/src/services/s3.js

Datadog APM tracing client for JavaScript

'use strict'

const BaseAwsSdkPlugin = require('../base')
const log = require('../../../dd-trace/src/log')
const { generatePointerHash } = require('../util')
const { S3_PTR_KIND, SPAN_POINTER_DIRECTION } = require('../../../dd-trace/src/constants')

class S3 extends BaseAwsSdkPlugin {
  static id = 's3'
  static peerServicePrecursors = ['bucketname']
  static isPayloadReporter = true

  generateTags (params, operation, response) {
    if (!params?.Bucket) return {}

    return {
      'resource.name': `${operation} ${params.Bucket}`,
      'aws.s3.bucket_name': params.Bucket,
      bucketname: params.Bucket
    }
  }

  addSpanPointers (span, response) {
    const request = response?.request
    const operationName = request?.operation
    if (!['putObject', 'copyObject', 'completeMultipartUpload'].includes(operationName)) {
      // We don't create span links for other S3 operations.
      return
    }

    // AWS v2: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html
    // AWS v3: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/
    const bucketName = request?.params?.Bucket
    const objectKey = request?.params?.Key
    let eTag =
      response?.ETag || // v3 PutObject & CompleteMultipartUpload
      response?.CopyObjectResult?.ETag || // v3 CopyObject
      response?.data?.ETag || // v2 PutObject & CompleteMultipartUpload
      response?.data?.CopyObjectResult?.ETag // v2 CopyObject

    if (!bucketName || !objectKey || !eTag) {
      log.debug('Unable to calculate span pointer hash because of missing parameters.')
      return
    }

    // https://github.com/DataDog/dd-span-pointer-rules/blob/main/AWS/S3/Object/README.md
    if (eTag.startsWith('"') && eTag.endsWith('"')) {
      eTag = eTag.slice(1, -1)
    }
    const pointerHash = generatePointerHash([bucketName, objectKey, eTag])
    span.addSpanPointer(S3_PTR_KIND, SPAN_POINTER_DIRECTION.DOWNSTREAM, pointerHash)
  }
}

module.exports = S3