dd-trace 4.9.0 → 4.10.0

package/CONTRIBUTING.md

@@ -4,4 +4,70 @@ Please reach out before starting work on any major code changes.
 This will ensure we avoid duplicating work, or that your code can't be merged due to a rapidly changing
 base. If you would like support for a module that is not listed, [contact support][1] to share a request.
 
+## Keep changes small and incremental
+
+Changes should be incremental and understandable. As much as possible, large-scale efforts should be broken up into many PRs over time for better reviewability. If a feature would require more changes to be "complete" it's fine to land partial changes if they are not wired up to anything yet, so long as tests are included which at least prove those parts work in isolation.
+
+There are great benefits to taking a measured and iterative approach to improvement. When working on code in fewer places there is far less risk of running into merge conflicts or incompatibilities with other systems. Keeping contributions small makes them easy to review which makes that much quicker to land. Additionally, keeping things small and iterative makes it easier for other teams to review and understand what the code does.
+
+## Be descriptive
+
+Sometimes code can be self-documenting, but often it can't. That is especially true to someone reviewing code they haven't worked on. Be conscious of writing code in a self-describing way and leave comments anywhere that self-description fails. This goes a long way towards making even complex code coherent to one not already familiar with it.
+
+Try to write code in a way the describes the intent when read. For example, verbs can be used for function and method names to communicate that they are used to do some specific action. In doing so it becomes clear when referenced by name elsewhere that it is a function and what the function is meant to do. If a function can not be described with a simple verb it's probably too complex or does too many things.
+
+## Give your code space
+
+Very dense code is hard to read. It helps to make use of empty lines to separate logical groupings of statements. Long lines should be split up into multiple lines to make them more readable. Complex objects or arrays should generally be split over several lines. Sometimes it's a good idea to assign a variable only to immediately use it in a call as it can be more descriptive than just using the expression in place. It's not always clear what an argument is for if it doesn't visibly have a name somehow. Remember, lines are free, our time is not.
+
+## Avoid large refactors
+
+Large refactors should generally be avoided in favour of iterative approaches. For example, rather than rewriting how every plugin works, one might make a special-case plugin that works a bit different for their particular use-case. If several dozen files need to change to add a feature we've probably done something wrong.
+
+Sometimes new patterns or new ideas emerge which would be a substantial improvement over the existing state. It can be tempting to want to go all-in on a new way to do something, but the code churn can be hard to manage. It's best to introduce such new things incrementally and advocate for their adoption gradually through the rest of the codebase. As old systems are gradually phased out, the infrastructure which supports them can be deleted or relegated to lazy-loading only if and when that specific part of the system needs to be used.
+
+## Test everything
+
+It's very difficult to know if a change is valid unless there are tests to prove it. As an extension of that, it's also difficult to know the _use_ of that code is valid if the way it is integrated is not propertly tested. For this reason we generally favour integration tests over unit tests. If an API is expected to be used in different places or in different ways then it should generally include unit tests too for each unique scenario, however great care should be taken to ensure unit tests are actually testing the _logic_ and not just testing the _mocks_. It's a very common mistake to write a unit test that abstracts away the actual use of the interface so much that it doesn't actually test how that interface works in real-world scenarios. Remember to test how it handles failures, how it operates under heavy load, and how it impacts usability of what its purpose is.
+
+## Don't forget benchmarks
+
+Observability products tend to have quite a bit of their behaviour running in app code hot paths. It's important we extensively benchmark anything we expect to have heavy use to ensure it performs well and we don't cause any significant regressions through future changes. Measuring once at the time of writing is insufficient--a graph with just one data point is not going to tell you much of anything.
+
+## Always consider backportability
+
+To reduce delta between release lines and make it easier for us to support older versions we try as much as possible to backport every change we can. We should be diligent about keeping breaking changes to a minimum and ensuring we don't use language or runtime features which are too new. This way we can generally be confident that a change can be backported.
+
+To reduce the surface area of a breaking change, the breaking aspects could be placed behind a flag which is disabled by default or isolated to a function. In the next major the change would then be just to change the default of the flag or to start or stop calling the isolated function. By isolating the breaking logic it also becomes easier to delete later when it's no longer relevant on any release line.
+
+Currently we do not have CI to test PRs for mergeability to past release lines, but we intend to expand our CI to include that in the future. For the time being, it's recommended when developing locally to try to cherry-pick your changes onto the previous vN.x branches to see if the tests pass there too.
+
+## Respect semantic versioning
+
+This library follows the semantic versioning standard, but there are some subtleties left under-specified so this section is meant to clarify exactly how we interpret the meaning of semver. Additionally, it exists to communicate that we also use semver labels on all PRs to indicate which type of release the change should land in. Outside contributions should be evaluated and a semver label selected by the relevant team.
+
+### semver-patch
+
+If the change is a bug or security fix, it should be labelled as semver-patch. These changes should generally not alter existing behaviour in any way other than to correct the specific issue.
+
+### semver-minor
+
+Any addition of new functionality should be labelled as semver-minor and should not change any existing behaviour either in how any existing API works or in changing the contents or value of any existing data being reported except in purely additive cases where all existing data retains its prior state. Such changes may include new configuration options which when used will change behaviour, or may include the addition of new data being captured such as a new instrumentation, but should not impact the current operating design of any existing features.
+
+### semver-major
+
+In the event that some existing functionality _does_ need to change, as much as possible the non-breaking aspects of that change should be made in a semver-minor PR and the actually breaking aspects should be done via a follow-up PR with only the specific aspects which are breaking. Remember to [always consider backportability](#always-consider-backportability).
+
+## Indicate intended release targets
+
+When writing major changes we use a series of labels in the form of `dont-land-on-vN.x` where N is the major release line which a PR should not land in. Every PR marked as semver-major should include these tags. These tags allow our [branch-diff](https://github.com/bengl/branch-diff) tooling to work smoothly as we can exclude PRs not intended for the release line we're preparing a release proposal for. The `semver-major` labels on their own are not sufficient as they don't encode any indication of from _which_ releases they are a major change.
+
+For outside contributions we will have the relevant team add these labels when they review and determine when they plan to release it.
+
+## Ensure all tests are green
+
+We follow an all-green policy which means that for any PR to be merged _all_ tests must be passing. If a test is flaky or failing consistently the owner of that test should make it a priority to fix that test and unblock other teams from landing changes. For outside contributors there are currently several tests which will always fail as full CI permission is required. For these PRs our current process is for the relevant team to copy the PR and resubmit it to run tests as a user with full CI permission.
+
+Eventually we plan to look into putting these permission-required tests behind a label which team members can add to their PRs at creation to run the full CI and can add to outside contributor PRs to trigger the CI from their own user credentials. If the label is not present there will be another action which checks the label is present. Rather than showing a bunch of confusing failures to new contributors it would just show a single job failure which indicates an additional label is required, and we can name it in a way that makes it clear that it's not the responsibility of the outside contributor to add it. Something like `approve-full-ci` is one possible choice there.
+
 [1]: https://docs.datadoghq.com/help

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dd-trace",
-  "version": "4.9.0",
+  "version": "4.10.0",
   "description": "Datadog APM tracing client for JavaScript",
   "main": "index.js",
   "typings": "index.d.ts",

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

@@ -74,7 +74,7 @@ function wrap (prefix, fn) {
     return asyncResource.runInAsyncScope(() => {
       const cb = callbackResource.bind(arguments[callbackIndex])
 
-      startCh.publish({ bucket: { name: this.name || this._name } })
+      startCh.publish({ bucket: { name: this.name || this._name }, seedNodes: this._dd_hosts })
 
       arguments[callbackIndex] = asyncResource.bind(function (error, result) {
         if (error) {
@@ -146,7 +146,8 @@ function wrapWithName (name) {
     return function () { // no arguments used by us
       return wrapCBandPromise(operation, name, {
         collection: { name: this._name || '_default' },
-        bucket: { name: this._scope._bucket._name }
+        bucket: { name: this._scope._bucket._name },
+        seedNodes: this._dd_connStr
       }, this, arguments)
     }
   }
@@ -155,7 +156,7 @@ function wrapWithName (name) {
 function wrapV3Query (query) {
   return function (q) {
     const resource = getQueryResource(q)
-    return wrapCBandPromise(query, 'query', { resource }, this, arguments)
+    return wrapCBandPromise(query, 'query', { resource, seedNodes: this._connStr }, this, arguments)
   }
 }
 
@@ -179,7 +180,7 @@ addHook({ name: 'couchbase', file: 'lib/bucket.js', versions: ['^2.6.12'] }, Buc
 
     const asyncResource = new AsyncResource('bound-anonymous-fn')
     return asyncResource.runInAsyncScope(() => {
-      startCh.publish({ resource: n1qlQuery, bucket: { name: this.name || this._name } })
+      startCh.publish({ resource: n1qlQuery, bucket: { name: this.name || this._name }, seedNodes: this._dd_hosts })
 
       emitter.once('rows', asyncResource.bind(() => {
         finishCh.publish(undefined)
@@ -212,11 +213,32 @@ addHook({ name: 'couchbase', file: 'lib/cluster.js', versions: ['^2.6.12'] }, Cl
   Cluster.prototype._maybeInvoke = wrapMaybeInvoke(Cluster.prototype._maybeInvoke)
   Cluster.prototype.query = wrapQuery(Cluster.prototype.query)
 
+  shimmer.wrap(Cluster.prototype, 'openBucket', openBucket => {
+    return function () {
+      const bucket = openBucket.apply(this, arguments)
+      const hosts = this.dsnObj.hosts
+      bucket._dd_hosts = hosts.map(hostAndPort => hostAndPort.join(':')).join(',')
+      return bucket
+    }
+  })
   return Cluster
 })
 
 // semver >=3 <3.2.0
 
+addHook({ name: 'couchbase', file: 'lib/bucket.js', versions: ['^3.0.7', '^3.1.3'] }, Bucket => {
+  shimmer.wrap(Bucket.prototype, 'collection', getCollection => {
+    return function () {
+      const collection = getCollection.apply(this, arguments)
+      const connStr = this._cluster._connStr
+      collection._dd_connStr = connStr
+      return collection
+    }
+  })
+
+  return Bucket
+})
+
 addHook({ name: 'couchbase', file: 'lib/collection.js', versions: ['^3.0.7', '^3.1.3'] }, Collection => {
   wrapAllNames(['upsert', 'insert', 'replace'], name => {
     shimmer.wrap(Collection.prototype, name, wrapWithName(name))
@@ -242,7 +264,21 @@ addHook({ name: 'couchbase', file: 'dist/collection.js', versions: ['>=3.2.0'] }
   return collection
 })
 
-addHook({ name: 'couchbase', file: 'dist/cluster.js', versions: ['3.2.0 - 3.2.1', '>=3.2.2'] }, cluster => {
+addHook({ name: 'couchbase', file: 'dist/bucket.js', versions: ['>=3.2.0'] }, bucket => {
+  const Bucket = bucket.Bucket
+  shimmer.wrap(Bucket.prototype, 'collection', getCollection => {
+    return function () {
+      const collection = getCollection.apply(this, arguments)
+      const connStr = this._cluster._connStr
+      collection._dd_connStr = connStr
+      return collection
+    }
+  })
+
+  return bucket
+})
+
+addHook({ name: 'couchbase', file: 'dist/cluster.js', versions: ['3.2.0 - 3.2.1', '>=3.2.2'] }, (cluster) => {
   const Cluster = cluster.Cluster
 
   shimmer.wrap(Cluster.prototype, 'query', wrapV3Query)

package/packages/datadog-plugin-aws-sdk/src/base.js

@@ -31,11 +31,10 @@ class BaseAwsSdkPlugin extends ClientPlugin {
       if (!this.isEnabled(request)) {
         return
       }
-      const serviceName = this.getServiceName()
       const childOf = this.tracer.scope().active()
       const tags = {
         'span.kind': 'client',
-        'service.name': serviceName,
+        'service.name': this.serviceName(),
         'aws.operation': operation,
         'aws.region': awsRegion,
         'region': awsRegion,
@@ -45,7 +44,7 @@ class BaseAwsSdkPlugin extends ClientPlugin {
       }
       if (this.requestTags) this.requestTags.set(request, tags)
 
-      const span = this.tracer.startSpan('aws.request', { childOf, tags })
+      const span = this.tracer.startSpan(this.operationFromRequest(request), { childOf, tags })
 
       analyticsSampler.sample(span, this.config.measured)
 
@@ -79,6 +78,26 @@ class BaseAwsSdkPlugin extends ClientPlugin {
     // implemented by subclasses, or not
   }
 
+  operationFromRequest (request) {
+    // can be overriden by subclasses
+    return this.operationName({
+      id: 'aws',
+      type: 'web',
+      kind: 'client',
+      awsService: this.serviceIdentifier
+    })
+  }
+
+  serviceName () {
+    return this.config.service ||
+      super.serviceName({
+        id: 'aws',
+        type: 'web',
+        kind: 'client',
+        awsService: this.serviceIdentifier
+      })
+  }
+
   isEnabled (request) {
     const serviceId = this.serviceIdentifier.toUpperCase()
     const envVarValue = process.env[`DD_TRACE_AWS_SDK_${serviceId}_ENABLED`]
@@ -122,13 +141,6 @@ class BaseAwsSdkPlugin extends ClientPlugin {
   configure (config) {
     super.configure(normalizeConfig(config, this.serviceIdentifier))
   }
-
-  // TODO: test splitByAwsService when the test suite is fixed
-  getServiceName () {
-    return this.config.service
-      ? this.config.service
-      : `${this.tracer._service}-aws-${this.serviceIdentifier}`
-  }
 }
 
 function normalizeConfig (config, serviceIdentifier) {

package/packages/datadog-plugin-aws-sdk/src/services/lambda.js

@@ -48,6 +48,22 @@ class Lambda extends BaseAwsSdkPlugin {
       }
     }
   }
+
+  operationFromRequest (request) {
+    if (request.operation === 'invoke') {
+      return this.operationName({
+        type: 'web',
+        kind: 'client'
+      })
+    }
+
+    return this.operationName({
+      id: 'aws',
+      type: 'web',
+      kind: 'client',
+      awsService: 'lambda'
+    })
+  }
 }
 
 module.exports = Lambda

package/packages/datadog-plugin-aws-sdk/src/services/sns.js

@@ -27,6 +27,24 @@ class Sns extends BaseAwsSdkPlugin {
     // for example if it contains a phone number?
   }
 
+  operationFromRequest (request) {
+    switch (request.operation) {
+      case 'publish':
+      case 'publishBatch':
+        return this.operationName({
+          type: 'messaging',
+          kind: 'producer'
+        })
+    }
+
+    return this.operationName({
+      id: 'aws',
+      type: 'web',
+      kind: 'client',
+      awsService: 'sns'
+    })
+  }
+
   requestInject (span, request) {
     const { operation, params } = request
 

package/packages/datadog-plugin-aws-sdk/src/services/sqs.js

@@ -41,6 +41,29 @@ class Sqs extends BaseAwsSdkPlugin {
     })
   }
 
+  operationFromRequest (request) {
+    switch (request.operation) {
+      case 'receiveMessage':
+        return this.operationName({
+          type: 'messaging',
+          kind: 'consumer'
+        })
+      case 'sendMessage':
+      case 'sendMessageBatch':
+        return this.operationName({
+          type: 'messaging',
+          kind: 'producer'
+        })
+    }
+
+    return this.operationName({
+      id: 'aws',
+      type: 'web',
+      kind: 'client',
+      awsService: 'sqs'
+    })
+  }
+
   isEnabled (request) {
     // TODO(bengl) Figure out a way to make separate plugins for consumer and producer so that
     // config can be isolated to `.configure()` instead of this whole isEnabled() thing.

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

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

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

@@ -1,51 +1,57 @@
 'use strict'
 
-const Plugin = require('../../dd-trace/src/plugins/plugin')
+const StoragePlugin = require('../../dd-trace/src/plugins/storage')
 const { storage } = require('../../datadog-core')
-const analyticsSampler = require('../../dd-trace/src/analytics_sampler')
 
-class CouchBasePlugin extends Plugin {
-  static get id () {
-    return 'couchbase'
-  }
+class CouchBasePlugin extends StoragePlugin {
+  static get id () { return 'couchbase' }
+  static get peerServicePrecursors () { return ['db.couchbase.seed.nodes'] }
 
-  addSubs (func, start, finish = defaultFinish) {
+  addSubs (func, start) {
     this.addSub(`apm:couchbase:${func}:start`, start)
-    this.addSub(`apm:couchbase:${func}:error`, this.addError)
-    this.addSub(`apm:couchbase:${func}:finish`, finish)
+    this.addSub(`apm:couchbase:${func}:error`, error => this.addError(error))
+    this.addSub(`apm:couchbase:${func}:finish`, message => this.finish(message))
   }
 
-  startSpan (operation, customTags, store, { bucket, collection }) {
+  startSpan (operation, customTags, store, { bucket, collection, seedNodes }) {
     const tags = {
       'db.type': 'couchbase',
       'component': 'couchbase',
-      'service.name': this.config.service || `${this.tracer._service}-couchbase`,
       'resource.name': `couchbase.${operation}`,
-      'span.kind': 'client'
+      'span.kind': this.constructor.kind,
+      'db.couchbase.seed.nodes': seedNodes
     }
 
+    if (bucket) tags['couchbase.bucket.name'] = bucket.name
+    if (collection) tags['couchbase.collection.name'] = collection.name
+
     for (const tag in customTags) {
       tags[tag] = customTags[tag]
     }
-    const span = this.tracer.startSpan(`couchbase.${operation}`, {
-      childOf: store ? store.span : null,
-      tags
-    })
 
-    if (bucket) span.setTag(`couchbase.bucket.name`, bucket.name)
-    if (collection) span.setTag(`couchbase.collection.name`, collection.name)
-
-    analyticsSampler.sample(span, this.config.measured)
-    return span
+    return super.startSpan(
+      this.operationName({ operation }),
+      {
+        service: this.serviceName({ pluginConfig: this.config }),
+        meta: tags
+      }
+    )
   }
 
   constructor (...args) {
     super(...args)
 
-    this.addSubs('query', ({ resource, bucket }) => {
+    this.addSubs('query', ({ resource, bucket, seedNodes }) => {
       const store = storage.getStore()
-      const span = this.startSpan('query', { 'span.type': 'sql', 'resource.name': resource },
-        store, { bucket })
+      const span = this.startSpan(
+        'query', {
+          'span.type': 'sql',
+          'resource.name': resource,
+          'span.kind': this.constructor.kind
+        },
+        store,
+        { bucket, seedNodes }
+      )
       this.enter(span, store)
     })
 
@@ -56,16 +62,12 @@ class CouchBasePlugin extends Plugin {
     this._addCommandSubs('prepend')
   }
   _addCommandSubs (name) {
-    this.addSubs(name, ({ bucket, collection }) => {
+    this.addSubs(name, ({ bucket, collection, seedNodes }) => {
       const store = storage.getStore()
-      const span = this.startSpan(name, {}, store, { bucket, collection })
+      const span = this.startSpan(name, {}, store, { bucket, collection, seedNodes })
       this.enter(span, store)
     })
   }
 }
 
-function defaultFinish () {
-  storage.getStore().span.finish()
-}
-
 module.exports = CouchBasePlugin

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

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

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

@@ -8,8 +8,8 @@ const formats = require('../../../ext/formats')
 const HTTP_HEADERS = formats.HTTP_HEADERS
 const urlFilter = require('../../dd-trace/src/plugins/util/urlfilter')
 const log = require('../../dd-trace/src/log')
-const url = require('url')
 const { CLIENT_PORT_KEY, COMPONENT, ERROR_MESSAGE, ERROR_TYPE, ERROR_STACK } = require('../../dd-trace/src/constants')
+const { URL } = require('url')
 
 const HTTP_STATUS_CODE = tags.HTTP_STATUS_CODE
 const HTTP_REQUEST_HEADERS = tags.HTTP_REQUEST_HEADERS
@@ -36,12 +36,12 @@ class HttpClientPlugin extends ClientPlugin {
     const method = (options.method || 'GET').toUpperCase()
     const childOf = store && allowed ? store.span : null
     // TODO delegate to super.startspan
-    const span = this.startSpan('http.request', {
+    const span = this.startSpan(this.operationName(), {
       childOf,
       meta: {
         [COMPONENT]: this.constructor.id,
         'span.kind': 'client',
-        'service.name': getServiceName(this.tracer, this.config, options),
+        'service.name': this.serviceName({ pluginConfig: this.config, sessionDetails: extractSessionDetails(options) }),
         'resource.name': method,
         'span.type': 'http',
         'http.method': method,
@@ -217,25 +217,15 @@ function hasAmazonSignature (options) {
   return search && search.toLowerCase().indexOf('x-amz-signature=') !== -1
 }
 
-function getServiceName (tracer, config, options) {
-  if (config.splitByDomain) {
-    return getHost(options)
-  } else if (config.service) {
-    return config.service
-  }
-
-  return tracer._service
-}
-
-function getHost (options) {
+function extractSessionDetails (options) {
   if (typeof options === 'string') {
-    return url.parse(options).host
+    return new URL(options).host
   }
 
-  const hostname = options.hostname || options.host || 'localhost'
+  const host = options.hostname || options.host || 'localhost'
   const port = options.port
 
-  return [hostname, port].filter(val => val).join(':')
+  return { host, port }
 }
 
 function startsWith (searchString) {

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

@@ -23,8 +23,16 @@ class HttpServerPlugin extends ServerPlugin {
 
   start ({ req, res, abortController }) {
     const store = storage.getStore()
-    const span = web.startSpan(this.tracer, this.config, req, res, 'web.request')
-
+    const span = web.startSpan(
+      this.tracer,
+      {
+        ...this.config,
+        service: this.config.service || this.serviceName()
+      },
+      req,
+      res,
+      this.operationName()
+    )
     span.setTag(COMPONENT, this.constructor.id)
 
     this._parentStore = store

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

@@ -38,12 +38,12 @@ class Http2ClientPlugin extends ClientPlugin {
 
     const store = storage.getStore()
     const childOf = store && allowed ? store.span : null
-    const span = this.startSpan('http.request', {
+    const span = this.startSpan(this.operationName(), {
       childOf,
       meta: {
         [COMPONENT]: this.constructor.id,
         [SPAN_KIND]: CLIENT,
-        'service.name': getServiceName(this.tracer, this.config, sessionDetails),
+        'service.name': this.serviceName({ pluginConfig: this.config, sessionDetails }),
         'resource.name': method,
         'span.type': 'http',
         'http.method': method,
@@ -133,20 +133,6 @@ function extractSessionDetails (authority, options) {
   return { protocol, port, host }
 }
 
-function getFormattedHostString (host, port) {
-  return [host, port].filter(val => val).join(':')
-}
-
-function getServiceName (tracer, config, sessionDetails) {
-  if (config.splitByDomain) {
-    return getFormattedHostString(sessionDetails.host, sessionDetails.port)
-  } else if (config.service) {
-    return config.service
-  }
-
-  return tracer._service
-}
-
 function hasAmazonSignature (headers, path) {
   if (headers) {
     headers = Object.keys(headers)

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

@@ -18,7 +18,16 @@ class Http2ServerPlugin extends ServerPlugin {
 
   start ({ req, res }) {
     const store = storage.getStore()
-    const span = web.startSpan(this.tracer, this.config, req, res, 'web.request')
+    const span = web.startSpan(
+      this.tracer,
+      {
+        ...this.config,
+        service: this.config.service || this.serviceName()
+      },
+      req,
+      res,
+      this.operationName()
+    )
 
     span.setTag(COMPONENT, this.constructor.id)
 

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

@@ -10,7 +10,7 @@ class MemcachedPlugin extends CachePlugin {
     const address = getAddress(client, server, query)
 
     this.startSpan({
-      service: this.serviceName(this.config, this.system),
+      service: this.serviceName({ pluginConfig: this.config, system: this.system }),
       resource: query.type,
       type: 'memcached',
       meta: {

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

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

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

@@ -8,7 +8,7 @@ class MySQLPlugin extends DatabasePlugin {
   static get system () { return 'mysql' }
 
   start (payload) {
-    const service = this.serviceName(this.config, payload.conf, this.system)
+    const service = this.serviceName({ pluginConfig: this.config, dbConfig: payload.conf, system: this.system })
     this.startSpan(this.operationName(), {
       service,
       resource: payload.sql,

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

@@ -19,11 +19,11 @@ class NextPlugin extends ServerPlugin {
   start ({ req, res }) {
     const store = storage.getStore()
     const childOf = store ? store.span : store
-    const span = this.tracer.startSpan('next.request', {
+    const span = this.tracer.startSpan(this.operationName(), {
       childOf,
       tags: {
         [COMPONENT]: this.constructor.id,
-        'service.name': this.config.service || this.tracer._service,
+        'service.name': this.config.service || this.serviceName(),
         'resource.name': req.method,
         'span.type': 'web',
         'span.kind': 'server',

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

@@ -10,7 +10,7 @@ class OracledbPlugin extends DatabasePlugin {
   static get peerServicePrecursors () { return ['db.instance', 'db.hostname'] }
 
   start ({ query, connAttrs }) {
-    const service = this.serviceName(this.config, connAttrs)
+    const service = this.serviceName({ pluginConfig: this.config, params: connAttrs })
     const url = getUrl(connAttrs.connectString)
 
     this.startSpan(this.operationName(), {

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

@@ -9,7 +9,7 @@ class PGPlugin extends DatabasePlugin {
   static get system () { return 'postgres' }
 
   start ({ params = {}, query, processId }) {
-    const service = this.serviceName(this.config, params)
+    const service = this.serviceName({ pluginConfig: this.config, params })
     const originalStatement = query.text
 
     this.startSpan(this.operationName(), {

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

@@ -15,7 +15,7 @@ class RedisPlugin extends CachePlugin {
 
     this.startSpan({
       resource,
-      service: this.serviceName(this.config, this.system, connectionName),
+      service: this.serviceName({ pluginConfig: this.config, system: this.system, connectionName }),
       type: 'redis',
       meta: {
         'db.type': 'redis',

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

@@ -10,7 +10,7 @@ class TediousPlugin extends DatabasePlugin {
 
   start ({ queryOrProcedure, connectionConfig }) {
     this.startSpan(this.operationName(), {
-      service: this.serviceName(this.config, this.system),
+      service: this.serviceName({ pluginConfig: this.config, system: this.system }),
       resource: queryOrProcedure,
       type: 'sql',
       kind: 'client',

package/packages/dd-trace/src/plugins/tracing.js

@@ -22,17 +22,24 @@ class TracingPlugin extends Plugin {
     return store && store.span
   }
 
-  serviceName (...serviceArgs) {
-    if (Nomenclature.shouldUseConsistentServiceNaming) {
-      return Nomenclature.shortCircuitServiceName(this.config, ...serviceArgs)
-    }
-    const { type, id, kind } = this.constructor
-    return Nomenclature.serviceName(type, kind, id, ...serviceArgs)
+  serviceName (opts = {}) {
+    const {
+      type = this.constructor.type,
+      id = this.constructor.id,
+      kind = this.constructor.kind
+    } = opts
+
+    return Nomenclature.serviceName(type, kind, id, opts)
   }
 
-  operationName (...opNameArgs) {
-    const { type, id, kind } = this.constructor
-    return Nomenclature.opName(type, kind, id, ...opNameArgs)
+  operationName (opts = {}) {
+    const {
+      type = this.constructor.type,
+      id = this.constructor.id,
+      kind = this.constructor.kind
+    } = opts
+
+    return Nomenclature.opName(type, kind, id, opts)
   }
 
   configure (config) {

package/packages/dd-trace/src/service-naming/index.js

@@ -18,20 +18,16 @@ class SchemaManager {
     return this.config.spanRemoveIntegrationFromService && this.version === 'v0'
   }
 
-  opName (type, kind, plugin, ...opNameArgs) {
-    return this.schema.getOpName(type, kind, plugin, ...opNameArgs)
+  opName (type, kind, plugin, opts) {
+    return this.schema.getOpName(type, kind, plugin, opts)
   }
 
-  serviceName (type, kind, plugin, ...serviceNameArgs) {
-    return this.schema.getServiceName(type, kind, plugin, this.config.service, ...serviceNameArgs)
-  }
+  serviceName (type, kind, plugin, opts) {
+    const schema = this.shouldUseConsistentServiceNaming
+      ? this.schemas.v1
+      : this.schema
 
-  shortCircuitServiceName (pluginConfig, ...args) {
-    // We're short-circuiting, so we do not obey custom service functions
-    if (typeof pluginConfig.service === 'function') {
-      return this.config.service
-    }
-    return pluginConfig.service || this.config.service
+    return schema.getServiceName(type, kind, plugin, { ...opts, tracerService: this.config.service })
   }
 
   configure (config = {}) {

package/packages/dd-trace/src/service-naming/schemas/definition.js

@@ -10,14 +10,14 @@ class SchemaDefinition {
     }
   }
 
-  getOpName (type, kind, plugin, ...opNameArgs) {
+  getOpName (type, kind, plugin, opts) {
     const item = this.getSchemaItem(type, kind, plugin)
-    return item.opName(...opNameArgs)
+    return item.opName(opts)
   }
 
-  getServiceName (type, kind, plugin, service, ...serviceNameArgs) {
+  getServiceName (type, kind, plugin, opts) {
     const item = this.getSchemaItem(type, kind, plugin)
-    return item.serviceName(service, ...serviceNameArgs)
+    return item.serviceName(opts)
   }
 }
 

package/packages/dd-trace/src/service-naming/schemas/util.js

@@ -1,5 +1,23 @@
-function identityService (service) {
-  return service
+function identityService ({ tracerService }) {
+  return tracerService
 }
 
-module.exports = { identityService }
+function getFormattedHostString ({ host, port }) {
+  return [host, port].filter(val => val).join(':')
+}
+
+function httpPluginClientService ({ tracerService, pluginConfig, sessionDetails }) {
+  if (pluginConfig.splitByDomain) {
+    return getFormattedHostString(sessionDetails)
+  } else if (pluginConfig.service) {
+    return pluginConfig.service
+  }
+
+  return tracerService
+}
+
+function awsServiceV0 ({ tracerService, awsService }) {
+  return `${tracerService}-aws-${awsService}`
+}
+
+module.exports = { identityService, httpPluginClientService, awsServiceV0 }

package/packages/dd-trace/src/service-naming/schemas/v0/messaging.js

@@ -1,7 +1,7 @@
-const { identityService } = require('../util')
+const { identityService, awsServiceV0 } = require('../util')
 
-function amqpServiceName (service) {
-  return `${service}-amqp`
+function amqpServiceName ({ tracerService }) {
+  return `${tracerService}-amqp`
 }
 
 const messaging = {
@@ -16,15 +16,23 @@ const messaging = {
     },
     'google-cloud-pubsub': {
       opName: () => 'pubsub.request',
-      serviceName: service => `${service}-pubsub`
+      serviceName: ({ tracerService }) => `${tracerService}-pubsub`
     },
     kafkajs: {
       opName: () => 'kafka.produce',
-      serviceName: service => `${service}-kafka`
+      serviceName: ({ tracerService }) => `${tracerService}-kafka`
     },
     rhea: {
       opName: () => 'amqp.send',
-      serviceName: service => `${service}-amqp-producer`
+      serviceName: ({ tracerService }) => `${tracerService}-amqp-producer`
+    },
+    sqs: {
+      opName: () => 'aws.request',
+      serviceName: awsServiceV0
+    },
+    sns: {
+      opName: () => 'aws.request',
+      serviceName: awsServiceV0
     }
   },
   consumer: {
@@ -42,11 +50,15 @@ const messaging = {
     },
     kafkajs: {
       opName: () => 'kafka.consume',
-      serviceName: service => `${service}-kafka`
+      serviceName: ({ tracerService }) => `${tracerService}-kafka`
     },
     rhea: {
       opName: () => 'amqp.receive',
       serviceName: identityService
+    },
+    sqs: {
+      opName: () => 'aws.request',
+      serviceName: awsServiceV0
     }
   },
   client: {
@@ -56,7 +68,7 @@ const messaging = {
     },
     'google-cloud-pubsub': {
       opName: () => 'pubsub.request',
-      serviceName: service => `${service}-pubsub`
+      serviceName: ({ tracerService }) => `${tracerService}-pubsub`
     }
   }
 }

package/packages/dd-trace/src/service-naming/schemas/v0/storage.js

@@ -1,37 +1,37 @@
-function getRedisService (config, connectionName) {
-  if (config.splitByInstance && connectionName) {
-    return config.service
-      ? `${config.service}-${connectionName}`
+function getRedisService (pluginConfig, connectionName) {
+  if (pluginConfig.splitByInstance && connectionName) {
+    return pluginConfig.service
+      ? `${pluginConfig.service}-${connectionName}`
       : connectionName
   }
 
-  return config.service
+  return pluginConfig.service
 }
 
-function fromSystem (service, system) {
-  return system ? `${service}-${system}` : undefined
+function fromSystem (tracerService, system) {
+  return system ? `${tracerService}-${system}` : undefined
 }
 
-function mysqlServiceName (service, config, dbConfig, system) {
-  if (typeof config.service === 'function') {
-    return config.service(dbConfig)
+function mysqlServiceName ({ tracerService, pluginConfig, dbConfig, system }) {
+  if (typeof pluginConfig.service === 'function') {
+    return pluginConfig.service(dbConfig)
   }
-  return config.service || fromSystem(service, system)
+  return pluginConfig.service || fromSystem(tracerService, system)
 }
 
 function withSuffixFunction (suffix) {
-  return (service, config, params) => {
-    if (typeof config.service === 'function') {
-      return config.service(params)
+  return ({ tracerService, pluginConfig, params }) => {
+    if (typeof pluginConfig.service === 'function') {
+      return pluginConfig.service(params)
     }
-    return config.service || `${service}-${suffix}`
+    return pluginConfig.service || `${tracerService}-${suffix}`
   }
 }
 
 const redisConfig = {
   opName: () => 'redis.command',
-  serviceName: (service, config, system, connectionName) => {
-    return getRedisService(config, connectionName) || fromSystem(service, system)
+  serviceName: ({ tracerService, pluginConfig, system, connectionName }) => {
+    return getRedisService(pluginConfig, connectionName) || fromSystem(tracerService, system)
   }
 }
 
@@ -39,11 +39,17 @@ const storage = {
   client: {
     'cassandra-driver': {
       opName: () => 'cassandra.query',
-      serviceName: (service, config, system) => config.service || fromSystem(service, system)
+      serviceName: ({ tracerService, pluginConfig, system }) =>
+        pluginConfig.service || fromSystem(tracerService, system)
+    },
+    couchbase: {
+      opName: ({ operation }) => `couchbase.${operation}`,
+      serviceName: ({ tracerService, pluginConfig }) => pluginConfig.service || `${tracerService}-couchbase`
     },
     elasticsearch: {
       opName: () => 'elasticsearch.query',
-      serviceName: (service, config) => config.service || `${service}-elasticsearch`
+      serviceName: ({ tracerService, pluginConfig }) =>
+        pluginConfig.service || `${tracerService}-elasticsearch`
     },
     ioredis: redisConfig,
     mariadb: {
@@ -52,11 +58,13 @@ const storage = {
     },
     memcached: {
       opName: () => 'memcached.command',
-      serviceName: (service, config, system) => config.service || fromSystem(service, system)
+      serviceName: ({ tracerService, pluginConfig, system }) =>
+        pluginConfig.service || fromSystem(tracerService, system)
     },
     'mongodb-core': {
       opName: () => 'mongodb.query',
-      serviceName: (service, config) => config.service || `${service}-mongodb`
+      serviceName: ({ tracerService, pluginConfig }) =>
+        pluginConfig.service || `${tracerService}-mongodb`
     },
     mysql: {
       opName: () => 'mysql.query',
@@ -68,7 +76,8 @@ const storage = {
     },
     opensearch: {
       opName: () => 'opensearch.query',
-      serviceName: (service, config) => config.service || `${service}-opensearch`
+      serviceName: ({ tracerService, pluginConfig }) =>
+        pluginConfig.service || `${tracerService}-opensearch`
     },
     oracledb: {
       opName: () => 'oracle.query',
@@ -81,7 +90,8 @@ const storage = {
     redis: redisConfig,
     tedious: {
       opName: () => 'tedious.request',
-      serviceName: (service, config, system) => config.service || fromSystem(service, system)
+      serviceName: ({ tracerService, pluginConfig, system }) =>
+        pluginConfig.service || fromSystem(tracerService, system)
     }
   }
 }

package/packages/dd-trace/src/service-naming/schemas/v0/web.js

@@ -1,4 +1,4 @@
-const { identityService } = require('../util')
+const { identityService, httpPluginClientService, awsServiceV0 } = require('../util')
 const { DD_MAJOR } = require('../../../../../../version')
 
 const web = {
@@ -10,6 +10,26 @@ const web = {
     moleculer: {
       opName: () => 'moleculer.call',
       serviceName: identityService
+    },
+    http: {
+      opName: () => 'http.request',
+      serviceName: httpPluginClientService
+    },
+    fetch: {
+      opName: () => 'http.request',
+      serviceName: httpPluginClientService
+    },
+    http2: {
+      opName: () => 'http.request',
+      serviceName: httpPluginClientService
+    },
+    aws: {
+      opName: () => 'aws.request',
+      serviceName: awsServiceV0
+    },
+    lambda: {
+      opName: () => 'aws.request',
+      serviceName: awsServiceV0
     }
   },
   server: {
@@ -20,6 +40,18 @@ const web = {
     moleculer: {
       opName: () => 'moleculer.action',
       serviceName: identityService
+    },
+    http: {
+      opName: () => 'web.request',
+      serviceName: identityService
+    },
+    http2: {
+      opName: () => 'web.request',
+      serviceName: identityService
+    },
+    next: {
+      opName: () => 'next.request',
+      serviceName: identityService
     }
   }
 }

package/packages/dd-trace/src/service-naming/schemas/v1/messaging.js

@@ -22,7 +22,15 @@ const messaging = {
       opName: () => 'kafka.send',
       serviceName: identityService
     },
-    rhea: amqpOutbound
+    rhea: amqpOutbound,
+    sqs: {
+      opName: () => 'aws.sqs.send',
+      serviceName: identityService
+    },
+    sns: {
+      opName: () => 'aws.sns.send',
+      serviceName: identityService
+    }
   },
   consumer: {
     amqplib: amqpInbound,
@@ -35,7 +43,11 @@ const messaging = {
       opName: () => 'kafka.process',
       serviceName: identityService
     },
-    rhea: amqpInbound
+    rhea: amqpInbound,
+    sqs: {
+      opName: () => 'aws.sqs.process',
+      serviceName: identityService
+    }
   },
   client: {
     amqplib: {

package/packages/dd-trace/src/service-naming/schemas/v1/storage.js

@@ -1,7 +1,6 @@
-const { identityService } = require('../util')
 
-function configWithFallback (service, config) {
-  return config.service || service
+function configWithFallback ({ tracerService, pluginConfig }) {
+  return pluginConfig.service || tracerService
 }
 
 const redisNaming = {
@@ -11,14 +10,14 @@ const redisNaming = {
 
 const mySQLNaming = {
   opName: () => 'mysql.query',
-  serviceName: identityService
+  serviceName: withFunction
 }
 
-function withFunction (service, config, params) {
-  if (typeof config.service === 'function') {
-    return config.service(params)
+function withFunction ({ tracerService, pluginConfig, params }) {
+  if (typeof pluginConfig.service === 'function') {
+    return pluginConfig.service(params)
   }
-  return configWithFallback(service, config)
+  return configWithFallback({ tracerService, pluginConfig })
 }
 
 const storage = {
@@ -27,6 +26,10 @@ const storage = {
       opName: () => 'cassandra.query',
       serviceName: configWithFallback
     },
+    couchbase: {
+      opName: () => 'couchbase.query',
+      serviceName: configWithFallback
+    },
     elasticsearch: {
       opName: () => 'elasticsearch.query',
       serviceName: configWithFallback
@@ -34,7 +37,7 @@ const storage = {
     ioredis: redisNaming,
     mariadb: {
       opName: () => 'mariadb.query',
-      serviceName: identityService
+      serviceName: withFunction
     },
     memcached: {
       opName: () => 'memcached.command',

package/packages/dd-trace/src/service-naming/schemas/v1/web.js

@@ -1,4 +1,4 @@
-const { identityService } = require('../util')
+const { identityService, httpPluginClientService } = require('../util')
 
 const web = {
   client: {
@@ -9,6 +9,26 @@ const web = {
     moleculer: {
       opName: () => 'moleculer.client.request',
       serviceName: identityService
+    },
+    http: {
+      opName: () => 'http.client.request',
+      serviceName: httpPluginClientService
+    },
+    fetch: {
+      opName: () => 'http.client.request',
+      serviceName: httpPluginClientService
+    },
+    http2: {
+      opName: () => 'http.client.request',
+      serviceName: httpPluginClientService
+    },
+    aws: {
+      opName: ({ awsService }) => `aws.${awsService}.request`,
+      serviceName: identityService
+    },
+    lambda: {
+      opName: () => 'aws.lambda.invoke',
+      serviceName: identityService
     }
   },
   server: {
@@ -19,6 +39,18 @@ const web = {
     moleculer: {
       opName: () => 'moleculer.server.request',
       serviceName: identityService
+    },
+    http: {
+      opName: () => 'http.server.request',
+      serviceName: identityService
+    },
+    http2: {
+      opName: () => 'http.server.request',
+      serviceName: identityService
+    },
+    next: {
+      opName: () => 'http.server.request',
+      serviceName: identityService
     }
   }
 }