dd-trace 3.3.1 → 3.12.1

package/LICENSE-3rdparty.csv

@@ -1,6 +1,8 @@
 Component,Origin,License,Copyright
 require,@datadog/native-appsec,Apache license 2.0,Copyright 2018 Datadog Inc.
 require,@datadog/native-metrics,Apache license 2.0,Copyright 2018 Datadog Inc.
+require,@datadog/native-iast-rewriter,Apache license 2.0,Copyright 2018 Datadog Inc.
+require,@datadog/native-iast-taint-tracking,Apache license 2.0,Copyright 2018 Datadog Inc.
 require,@datadog/pprof,Apache license 2.0,Copyright 2019 Google Inc.
 require,@datadog/sketches-js,Apache license 2.0,Copyright 2020 Datadog Inc.
 require,crypto-randomuuid,MIT,Copyright 2021 Node.js Foundation and contributors
@@ -18,8 +20,10 @@ require,lodash.uniq,MIT,Copyright JS Foundation and other contributors
 require,lru-cache,ISC,Copyright (c) 2010-2022 Isaac Z. Schlueter and Contributors
 require,methods,MIT,Copyright 2013-2014 TJ Holowaychuk
 require,module-details-from-path,MIT,Copyright 2016 Thomas Watson Steen
+require,node-abort-controller,MIT,Copyright (c) 2019 Steve Faulkner
 require,opentracing,MIT,Copyright 2016 Resonance Labs Inc
 require,path-to-regexp,MIT,Copyright 2014 Blake Embrey
+require,protobufjs,BSD-3-Clause,Copyright 2016 Daniel Wirtz
 require,retry,MIT,Copyright 2011 Tim Koschützki Felix Geisendörfer
 require,semver,ISC,Copyright Isaac Z. Schlueter and Contributors
 dev,@types/node,MIT,Copyright Authors
@@ -35,6 +39,7 @@ dev,dotenv,BSD-2-Clause,Copyright 2015 Scott Motte
 dev,eslint,MIT,Copyright JS Foundation and other contributors https://js.foundation
 dev,eslint-config-standard,MIT,Copyright Feross Aboukhadijeh
 dev,eslint-plugin-import,MIT,Copyright 2015 Ben Mosher
+dev,eslint-plugin-mocha,MIT,Copyright 2014 Mathias Schreck
 dev,eslint-plugin-node,MIT,Copyright 2015 Toru Nagashima
 dev,eslint-plugin-promise,ISC,jden and other contributors
 dev,eslint-plugin-standard,MIT,Copyright 2015 Jamund Ferguson
@@ -46,6 +51,8 @@ dev,int64-buffer,MIT,Copyright 2015-2016 Yusuke Kawasaki
 dev,jszip,MIT,Copyright 2015-2016 Stuart Knightley and contributors
 dev,mkdirp,MIT,Copyright 2010 James Halliday
 dev,mocha,MIT,Copyright 2011-2018 JS Foundation and contributors https://js.foundation
+dev,mocha-junit-reporter,MIT,Copyright (c) 2015 Michael Allen
+dev,mocha-multi-reporters,MIT,Copyright 2019 Yousaf Nabi and 2015 Stanley Ng
 dev,multer,MIT,Copyright 2014 Hage Yaapa
 dev,msgpack-lite,MIT,Copyright 2015 Yusuke Kawasaki
 dev,nock,MIT,Copyright 2017 Pedro Teixeira and other contributors
@@ -56,4 +63,5 @@ dev,sinon,BSD-3-Clause,Copyright 2010-2017 Christian Johansen
 dev,sinon-chai,WTFPL and BSD-2-Clause,Copyright 2004 Sam Hocevar 2012–2017 Domenic Denicola
 dev,tape,MIT,Copyright James Halliday
 dev,wait-on,MIT,Copyright 2015 Jeff Barczewski
+file,aws-lambda-nodejs-runtime-interface-client,Apache 2.0,Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 file,profile.proto,Apache license 2.0,Copyright 2016 Google Inc.

package/README.md

@@ -1,76 +1,139 @@
-# dd-trace-js
+# `dd-trace`: Node.js APM Tracer Library
 
-[![npm](https://img.shields.io/npm/v/dd-trace.svg?colorB=blue)](https://www.npmjs.com/package/dd-trace)
-[![npm (tag)](https://img.shields.io/npm/v/dd-trace/dev.svg)](https://www.npmjs.com/package/dd-trace/v/dev)
-[![CircleCI](https://circleci.com/gh/DataDog/dd-trace-js.svg?style=shield)](https://circleci.com/gh/DataDog/dd-trace-js)
+[![npm v3](https://img.shields.io/npm/v/dd-trace/latest?color=blue&label=dd-trace%40v3&logo=npm)](https://www.npmjs.com/package/dd-trace)
+[![npm v2](https://img.shields.io/npm/v/dd-trace/latest-node12?color=blue&label=dd-trace%40v2&logo=npm)](https://www.npmjs.com/package/dd-trace/v/latest-node12)
+[![npm dev](https://img.shields.io/npm/v/dd-trace/dev?color=orange&label=dd-trace%40dev&logo=npm)](https://www.npmjs.com/package/dd-trace/v/dev)
 [![codecov](https://codecov.io/gh/DataDog/dd-trace-js/branch/master/graph/badge.svg)](https://codecov.io/gh/DataDog/dd-trace-js)
 
-**Node.js APM Tracer**
+<img align="right" src="https://user-images.githubusercontent.com/551402/208212084-1d0c07e2-4135-4c61-b2da-8f2fddbc66ed.png" alt="Bits the dog  JavaScript" width="200px"/>
 
-Datadog APM tracing client for Node.js.
+`dd-trace` is an npm package that you can install in your Node.js application to capture APM (Application Performance Monitoring) data. In Datadog terminology this library is called a Tracer. This data is then sent off to a process which collects and aggregates the data, called an Agent. Finally the data is sent off to the Datadog servers where it's stored and made available for querying in a myriad of ways, such as displaying in a dashboard or triggering alerts.
 
-## Getting Started
+![Tracer, Agent, Datadog relationship diagram](./docs/relationship.png)
 
-For a basic product overview, check out our [setup documentation](https://docs.datadoghq.com/tracing/languages/nodejs/).
 
-For installation, configuration, and details about using the API, check out our [API documentation](https://datadog.github.io/dd-trace-js).
+## Documentation
+
+Most of the documentation for `dd-trace` is available on these webpages:
+
+- [Tracing Node.js Applications](https://docs.datadoghq.com/tracing/languages/nodejs/) - most project documentation, including setup instructions
+- [Configuring the NodeJS Tracing Library](https://docs.datadoghq.com/tracing/trace_collection/library_config/nodejs) - environment variables and config options
+- [API Documentation](https://datadog.github.io/dd-trace-js) - method signatures, plugin list, and some usage examples
+- [APM Terms and Concepts](https://docs.datadoghq.com/tracing/visualization/) - a glossary of concepts applicable across all languages
+
+
+## Version Release Lines and Maintenance
+
+| Release Line                                             | Latest Version                                                                                         | Status          |Initial Release | End of Life |
+| :--:                                                     | :--:                                                                                                   | :---:           | :---:          | :---:       |
+| [`v1`](https://github.com/DataDog/dd-trace-js/tree/v1.x) | ![npm v1](https://img.shields.io/npm/v/dd-trace/legacy-v1?color=white&label=%20&style=flat-square)     | **End of Life** | 2021-07-13     | 2022-02-25  |
+| [`v2`](https://github.com/DataDog/dd-trace-js/tree/v2.x) | ![npm v2](https://img.shields.io/npm/v/dd-trace/latest-node12?color=white&label=%20&style=flat-square) | **Maintenance** | 2022-01-28     | 2023-08-15  |
+| [`v3`](https://github.com/DataDog/dd-trace-js/tree/v3.x) | ![npm v3](https://img.shields.io/npm/v/dd-trace/latest?color=white&label=%20&style=flat-square)        | **Current**     | 2022-08-15     | Unknown     |
+
+We currently maintain two release lines, namely `v2` and `v3`.
+Features and bug fixes that are merged are released to the `v3` line and, if appropriate, also the `v2` line.
+
+For any new projects it is recommended to use the `v3` release line:
+
+```sh
+$ npm install dd-trace
+$ yarn add dd-trace
+```
+
+However, existing projects that already use the `v2` release line, or projects that need to support Node.js v12, may use the `v2` release line.
+This is done by specifying the version when installing the package.
+Note that we also publish to npm using a `latest-node12` tag that can also be used for install:
+
+```sh
+$ npm install dd-trace@2
+$ yarn add dd-trace@2
+$ npm install dd-trace@latest-node12
+$ yarn add dd-trace@latest-node12
+```
+
+Any backwards-breaking functionality that is introduced into the library will result in an increase of the major version of the library and therefore a new release line.
+Such releases are kept to a minimum to reduce the pain of upgrading the library.
+
+When a new release line is introduced the previous release line then enters maintenance mode where it will receive updates for the next year.
+Once that year is up the release line enters End of Life and will not receive new updates.
+The library also follows the Node.js LTS lifecycle wherein new release lines drop compatibility with Node.js versions that reach end of life (with the maintenance release line still receiving updates for a year).
+
+For more information about library versioning and compatibility, see the [NodeJS Compatibility Requirements](https://docs.datadoghq.com/tracing/trace_collection/compatibility/nodejs/#releases) page.
+
+Changes associated with each individual release are documented on the [GitHub Releases](https://github.com/DataDog/dd-trace-js/releases) screen.
 
-For descriptions of terminology used in APM, take a look at the [official documentation](https://docs.datadoghq.com/tracing/visualization/).
 
 ## Development
 
 Before contributing to this open source project, read our [CONTRIBUTING.md](https://github.com/DataDog/dd-trace-js/blob/master/CONTRIBUTING.md).
 
-## Security Vulnerabilities
 
-If you have found a security issue, please contact the security team directly at [security@datadoghq.com](mailto:security@datadoghq.com).
-
-### Requirements
+## Requirements
 
 Since this project supports multiple Node versions, using a version
 manager such as [nvm](https://github.com/creationix/nvm) is recommended.
 
 We use [yarn](https://yarnpkg.com/) for its workspace functionality, so make sure to install that as well.
 
-To get started once you have Node and yarn installed, run:
+To install dependencies once you have Node and yarn installed, run:
 
 ```sh
 $ yarn
 ```
 
-### Testing
 
-Before running the tests, the data stores need to be running.
+## Testing
+
+Before running _plugin_ tests, the data stores need to be running.
 The easiest way to start all of them is to use the provided
 docker-compose configuration:
 
 ```sh
 $ docker-compose up -d -V --remove-orphans --force-recreate
+$ yarn services
 ```
 
-#### Unit Tests
 
-To run the unit tests, use:
+### Unit Tests
+
+There are several types of unit tests, for various types of components. The
+following commands may be useful:
 
 ```sh
-$ yarn test
+# Tracer core tests (i.e. testing `packages/dd-trace`)
+$ yarn test:trace:core
+# "Core" library tests (i.e. testing `packages/datadog-core`
+$ yarn test:core
+# Instrumentations tests (i.e. testing `packages/datadog-instrumentations`
+$ yarn test:instrumentations
 ```
 
-To run the unit tests continuously in watch mode while developing, use:
+Several other components have test commands as well. See `package.json` for
+details.
+
+To test _plugins_ (i.e. components in `packages/datadog-plugin-XXXX`
+directories, set the `PLUGINS` environment variable to the plugin you're
+interested in, and use `yarn test:plugins`. If you need to test multiple
+plugins you may separate then with a pipe (`|`) delimiter. Here's an
+example testing the `express` and `bluebird` plugins:
 
 ```sh
-$ yarn tdd
+PLUGINS="express|bluebird" yarn test:plugins
 ```
 
-#### Memory Leaks
+
+### Memory Leaks
 
 To run the memory leak tests, use:
 
 ```sh
-$ yarn leak
+$ yarn leak:core
+
+# or
+
+$ yarn leak:plugins
 ```
 
-Please note that memory leak tests only run on Node `>=8`.
 
 ### Linting
 
@@ -83,29 +146,31 @@ To run the linter, use:
 $ yarn lint
 ```
 
-### Continuous Integration
 
-We rely on CircleCI 2.0 for our tests. If you want to test how the CI behaves
-locally, you can use the CircleCI Command Line Interface as described here:
-https://circleci.com/docs/2.0/local-jobs/
+### Benchmarks
 
-After installing the `circleci` CLI, simply run one of the following:
+Our microbenchmarks live in `benchmark/sirun`. Each directory in there
+corresponds to a specific benchmark test and its variants, which are used to
+track regressions and improvements over time.
+
+In addition to those, when two or more approaches must be compared, please write
+a benchmark in the `benchmark/index.js` module so that we can keep track of the
+most efficient algorithm. To run your benchmark, use:
 
 ```sh
-$ circleci build --job lint
-$ circleci build --job node-leaks
-$ circleci build --job node-core-8
-$ circleci build --job node-core-10
-$ circleci build --job node-core-12
-$ circleci build --job node-core-latest
+$ yarn bench
 ```
 
-### Benchmarks
 
-When two or more approaches must be compared, please write a benchmark
-in the `benchmark/index.js` module so that we can keep track of the
-most efficient algorithm. To run your benchmark, just:
+## Serverless / Lambda
 
-```sh
-$ yarn bench
-```
+Note that there is a separate Lambda project, [datadog-lambda-js](https://github.com/DataDog/datadog-lambda-js), that is responsible for enabling metrics and distributed tracing when your application runs on Lambda.
+That project does depend on the `dd-trace` package but also adds a lot of Lambda-related niceties.
+If you find any issues specific to Lambda integrations then the issues may get solved quicker if they're added to that repository.
+That said, even if your application runs on Lambda, any core instrumentation issues not related to Lambda itself may be better served by opening an issue in this repository.
+Regardless of where you open the issue, someone at Datadog will try to help.
+
+
+## Security Vulnerabilities
+
+If you have found a security issue, please contact the security team directly at [security@datadoghq.com](mailto:security@datadoghq.com).

package/ci/init.js

@@ -7,7 +7,8 @@ const options = {
   startupLogs: false,
   tags: {
     [ORIGIN_KEY]: 'ciapp-test'
-  }
+  },
+  isCiVisibility: true
 }
 
 let shouldInit = true
@@ -25,6 +26,10 @@ but neither DD_API_KEY nor DATADOG_API_KEY are set in your environment, \
 so dd-trace will not be initialized.`)
     shouldInit = false
   }
+} else {
+  options.experimental = {
+    exporter: 'agent_proxy'
+  }
 }
 
 if (shouldInit) {

package/ext/exporters.d.ts

@@ -1,7 +1,8 @@
 declare const exporters: {
   LOG: 'log',
   AGENT: 'agent',
-  DATADOG: 'datadog'
+  DATADOG: 'datadog',
+  AGENT_PROXY: 'agent_proxy'
 }
 
 export = exporters

package/ext/exporters.js

@@ -2,5 +2,6 @@
 module.exports = {
   LOG: 'log',
   AGENT: 'agent',
-  DATADOG: 'datadog'
+  DATADOG: 'datadog',
+  AGENT_PROXY: 'agent_proxy'
 }