dd-trace 5.0.0-pre-e4b9a26 → 5.0.0-pre-0fb796c

package/index.d.ts

@@ -1450,6 +1450,20 @@ declare namespace plugins {
     };
   }
 
+  /**
+   * This plugin automatically instruments the
+   * [openai](https://platform.openai.com/docs/api-reference?lang=node.js) module.
+   *
+   * Note that for logs to work you'll need to set the `DD_API_KEY` environment variable.
+   * You'll also need to adjust any firewall settings to allow the tracer to communicate
+   * with `http-intake.logs.datadoghq.com`.
+   *
+   * Note that for metrics to work you'll need to enable
+   * [DogStatsD](https://docs.datadoghq.com/developers/dogstatsd/?tab=hostagent#setup)
+   * in the agent.
+   */
+  interface openai extends Instrumentation {}
+
   /**
    * This plugin automatically instruments the
    * [opensearch](https://github.com/opensearch-project/opensearch-js) module.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "5.0.0-pre-e4b9a26",
+  "version": "5.0.0-pre-0fb796c",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -70,7 +70,7 @@
     "@datadog/native-iast-rewriter": "2.0.1",
     "@datadog/native-iast-taint-tracking": "^1.5.0",
     "@datadog/native-metrics": "^2.0.0",
-    "@datadog/pprof": "2.2.2",
+    "@datadog/pprof": "2.2.3",
     "@datadog/sketches-js": "^2.1.0",
     "@opentelemetry/api": "^1.0.0",
     "@opentelemetry/core": "^1.14.0",

package/packages/datadog-instrumentations/src/helpers/hooks.js

@@ -69,6 +69,7 @@ module.exports = {
   'net': () => require('../net'),
   'next': () => require('../next'),
   'oracledb': () => require('../oracledb'),
+  'openai': () => require('../openai'),
   'paperplane': () => require('../paperplane'),
   'pg': () => require('../pg'),
   'pino': () => require('../pino'),

package/packages/datadog-instrumentations/src/openai.js

@@ -0,0 +1,50 @@
+'use strict'
+
+const {
+  channel,
+  addHook
+} = require('./helpers/instrument')
+const shimmer = require('../../datadog-shimmer')
+
+const startCh = channel('apm:openai:request:start')
+const finishCh = channel('apm:openai:request:finish')
+const errorCh = channel('apm:openai:request:error')
+
+addHook({ name: 'openai', file: 'dist/api.js', versions: ['>=3.0.0'] }, exports => {
+  const methodNames = Object.getOwnPropertyNames(exports.OpenAIApi.prototype)
+  methodNames.shift() // remove leading 'constructor' method
+
+  for (const methodName of methodNames) {
+    shimmer.wrap(exports.OpenAIApi.prototype, methodName, fn => function () {
+      if (!startCh.hasSubscribers) {
+        return fn.apply(this, arguments)
+      }
+
+      startCh.publish({
+        methodName,
+        args: arguments,
+        basePath: this.basePath,
+        apiKey: this.configuration.apiKey
+      })
+
+      return fn.apply(this, arguments)
+        .then((response) => {
+          finishCh.publish({
+            headers: response.headers,
+            body: response.data,
+            path: response.request.path,
+            method: response.request.method
+          })
+
+          return response
+        })
+        .catch((err) => {
+          errorCh.publish({ err })
+
+          throw err
+        })
+    })
+  }
+
+  return exports
+})

package/packages/datadog-plugin-cassandra-driver/src/index.js

@@ -12,8 +12,8 @@ class CassandraDriverPlugin extends DatabasePlugin {
       query = combine(query)
     }
 
-    this.startSpan('cassandra.query', {
-      service: this.config.service,
+    this.startSpan(this.operationName(), {
+      service: this.serviceName(this.config, this.system),
       resource: trim(query, 5000),
       type: 'cassandra',
       kind: 'client',

package/packages/datadog-plugin-dns/src/lookup.js

@@ -33,7 +33,7 @@ class DNSLookupPlugin extends ClientPlugin {
       span.setTag('dns.address', result)
     }
 
-    span.finish()
+    super.finish()
   }
 }
 

package/packages/datadog-plugin-elasticsearch/src/index.js

@@ -8,8 +8,8 @@ class ElasticsearchPlugin extends DatabasePlugin {
   start ({ params }) {
     const body = getBody(params.body || params.bulkBody)
 
-    this.startSpan(`${this.system}.query`, {
-      service: this.config.service,
+    this.startSpan(this.operationName(), {
+      service: this.serviceName(this.config),
       resource: `${params.method} ${quantizePath(params.path)}`,
       type: 'elasticsearch',
       kind: 'client',

package/packages/datadog-plugin-google-cloud-pubsub/src/consumer.js

@@ -32,7 +32,7 @@ class GoogleCloudPubsubConsumerPlugin extends ConsumerPlugin {
       span.setTag('pubsub.ack', 1)
     }
 
-    span.finish()
+    super.finish()
   }
 }
 

package/packages/datadog-plugin-graphql/src/execute.js

@@ -32,7 +32,7 @@ class GraphQLExecutePlugin extends TracingPlugin {
   finish ({ res, args }) {
     const span = this.activeSpan
     this.config.hooks.execute(span, args, res)
-    span.finish()
+    super.finish()
   }
 }
 

package/packages/datadog-plugin-graphql/src/parse.js

@@ -25,7 +25,7 @@ class GraphQLParsePlugin extends TracingPlugin {
 
     this.config.hooks.parse(span, source, document)
 
-    span.finish()
+    super.finish()
   }
 }
 

package/packages/datadog-plugin-graphql/src/resolve.js

@@ -56,11 +56,6 @@ class GraphQLResolvePlugin extends TracingPlugin {
     }
   }
 
-  finish (finishTime) {
-    const span = this.activeSpan
-    span.finish(finishTime)
-  }
-
   constructor (...args) {
     super(...args)
 

package/packages/datadog-plugin-graphql/src/validate.js

@@ -21,7 +21,7 @@ class GraphQLValidatePlugin extends TracingPlugin {
   finish ({ document, errors }) {
     const span = this.activeSpan
     this.config.hooks.validate(span, document, errors)
-    span.finish()
+    super.finish()
   }
 }
 

package/packages/datadog-plugin-grpc/src/client.js

@@ -57,7 +57,7 @@ class GrpcClientPlugin extends ClientPlugin {
       addMetadataTags(span, metadata, metadataFilter, 'response')
     }
 
-    span.finish()
+    super.finish()
   }
 
   configure (config) {

package/packages/datadog-plugin-grpc/src/server.js

@@ -68,7 +68,7 @@ class GrpcServerPlugin extends ServerPlugin {
       addMetadataTags(span, trailer, metadataFilter, 'response')
     }
 
-    span.finish()
+    super.finish()
   }
 
   configure (config) {

package/packages/datadog-plugin-http/src/client.js

@@ -87,7 +87,7 @@ class HttpClientPlugin extends ClientPlugin {
     addRequestHeaders(req, span, this.config)
 
     this.config.hooks.request(span, req, res)
-    span.finish()
+    super.finish()
   }
 
   error (err) {

package/packages/datadog-plugin-http/src/server.js

@@ -1,63 +1,67 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
+const ServerPlugin = require('../../dd-trace/src/plugins/server')
 const { storage } = require('../../datadog-core')
 const web = require('../../dd-trace/src/plugins/util/web')
 const { incomingHttpRequestStart, incomingHttpRequestEnd } = require('../../dd-trace/src/appsec/channels')
 const { COMPONENT } = require('../../dd-trace/src/constants')
 
-class HttpServerPlugin extends Plugin {
+class HttpServerPlugin extends ServerPlugin {
   static get id () {
     return 'http'
   }
 
   constructor (...args) {
     super(...args)
-
     this._parentStore = undefined
+    this.addTraceSub('exit', message => this.exit(message))
+  }
+
+  addTraceSub (eventName, handler) {
+    this.addSub(`apm:${this.constructor.id}:server:${this.operation}:${eventName}`, handler)
+  }
 
-    this.addSub('apm:http:server:request:start', ({ req, res, abortController }) => {
-      const store = storage.getStore()
-      const span = web.startSpan(this.tracer, this.config, req, res, 'web.request')
+  start ({ req, res, abortController }) {
+    const store = storage.getStore()
+    const span = web.startSpan(this.tracer, this.config, req, res, 'web.request')
 
-      span.setTag(COMPONENT, this.constructor.id)
+    span.setTag(COMPONENT, this.constructor.id)
 
-      this._parentStore = store
-      this.enter(span, { ...store, req, res })
+    this._parentStore = store
+    this.enter(span, { ...store, req, res })
 
-      const context = web.getContext(req)
+    const context = web.getContext(req)
 
-      if (!context.instrumented) {
-        context.res.writeHead = web.wrapWriteHead(context)
-        context.instrumented = true
-      }
+    if (!context.instrumented) {
+      context.res.writeHead = web.wrapWriteHead(context)
+      context.instrumented = true
+    }
 
-      if (incomingHttpRequestStart.hasSubscribers) {
-        incomingHttpRequestStart.publish({ req, res, abortController }) // TODO: no need to make a new object here
-      }
-    })
+    if (incomingHttpRequestStart.hasSubscribers) {
+      incomingHttpRequestStart.publish({ req, res, abortController }) // TODO: no need to make a new object here
+    }
+  }
 
-    this.addSub('apm:http:server:request:error', (error) => {
-      web.addError(error)
-    })
+  error (error) {
+    web.addError(error)
+  }
 
-    this.addSub('apm:http:server:request:exit', ({ req }) => {
-      const span = this._parentStore && this._parentStore.span
-      this.enter(span, this._parentStore)
-      this._parentStore = undefined
-    })
+  finish ({ req }) {
+    const context = web.getContext(req)
 
-    this.addSub('apm:http:server:request:finish', ({ req }) => {
-      const context = web.getContext(req)
+    if (!context || !context.res) return // Not created by a http.Server instance.
 
-      if (!context || !context.res) return // Not created by a http.Server instance.
+    if (incomingHttpRequestEnd.hasSubscribers) {
+      incomingHttpRequestEnd.publish({ req, res: context.res })
+    }
 
-      if (incomingHttpRequestEnd.hasSubscribers) {
-        incomingHttpRequestEnd.publish({ req, res: context.res })
-      }
+    web.finishAll(context)
+  }
 
-      web.finishAll(context)
-    })
+  exit ({ req }) {
+    const span = this._parentStore && this._parentStore.span
+    this.enter(span, this._parentStore)
+    this._parentStore = undefined
   }
 
   configure (config) {

package/packages/datadog-plugin-http2/src/client.js

@@ -93,11 +93,6 @@ class Http2ClientPlugin extends ClientPlugin {
     this.enter(span, store)
   }
 
-  finish () {
-    const span = storage.getStore().span
-    span.finish()
-  }
-
   configure (config) {
     return super.configure(normalizeConfig(config))
   }

package/packages/datadog-plugin-http2/src/server.js

@@ -2,46 +2,46 @@
 
 // Plugin temporarily disabled. See https://github.com/DataDog/dd-trace-js/issues/312
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
+const ServerPlugin = require('../../dd-trace/src/plugins/server')
 const { storage } = require('../../datadog-core')
 const web = require('../../dd-trace/src/plugins/util/web')
 const { COMPONENT } = require('../../dd-trace/src/constants')
 
-class Http2ServerPlugin extends Plugin {
+class Http2ServerPlugin extends ServerPlugin {
   static get id () {
     return 'http2'
   }
 
-  constructor (...args) {
-    super(...args)
+  addTraceSub (eventName, handler) {
+    this.addSub(`apm:${this.constructor.id}:server:${this.operation}:${eventName}`, handler)
+  }
 
-    this.addSub('apm:http2:server:request:start', ({ req, res }) => {
-      const store = storage.getStore()
-      const span = web.startSpan(this.tracer, this.config, req, res, 'web.request')
+  start ({ req, res }) {
+    const store = storage.getStore()
+    const span = web.startSpan(this.tracer, this.config, req, res, 'web.request')
 
-      span.setTag(COMPONENT, this.constructor.id)
+    span.setTag(COMPONENT, this.constructor.id)
 
-      this.enter(span, { ...store, req, res })
+    this.enter(span, { ...store, req, res })
 
-      const context = web.getContext(req)
+    const context = web.getContext(req)
 
-      if (!context.instrumented) {
-        context.res.writeHead = web.wrapWriteHead(context)
-        context.instrumented = true
-      }
-    })
+    if (!context.instrumented) {
+      context.res.writeHead = web.wrapWriteHead(context)
+      context.instrumented = true
+    }
+  }
 
-    this.addSub('apm:http2:server:request:error', (error) => {
-      web.addError(error)
-    })
+  finish ({ req }) {
+    const context = web.getContext(req)
 
-    this.addSub('apm:http2:server:request:finish', ({ req }) => {
-      const context = web.getContext(req)
+    if (!context || !context.res) return // Not created by a http.Server instance.
 
-      if (!context || !context.res) return // Not created by a http.Server instance.
+    web.finishAll(context)
+  }
 
-      web.finishAll(context)
-    })
+  error (error) {
+    web.addError(error)
   }
 
   configure (config) {

package/packages/datadog-plugin-moleculer/src/client.js

@@ -29,7 +29,7 @@ class MoleculerClientPlugin extends ClientPlugin {
       span.addTags(moleculerTags(broker, ctx, this.config))
     }
 
-    span.finish()
+    super.finish()
   }
 }
 

package/packages/datadog-plugin-mongodb-core/src/index.js

@@ -10,8 +10,8 @@ class MongodbCorePlugin extends DatabasePlugin {
     const query = getQuery(ops)
     const resource = truncate(getResource(this, ns, query, name))
 
-    this.startSpan('mongodb.query', {
-      service: this.config.service,
+    this.startSpan(this.operationName(), {
+      service: this.serviceName(this.config),
       resource,
       type: 'mongodb',
       kind: 'client',