Node.js Compatibility Requirements
Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel,
n'hésitez pas à nous contacter.
Releases
Versioning
Versioning of the Datadog Node.js tracing library follows semver. When a new major version is released it becomes the primary release line, where all new features, bug fixes and security patches land. Here’s an outline of what constitutes each type of semver change:
Major | Minor | Patch |
---|
Changes that are incompatible with previous versions. | Adding anything that is compatible with previous versions (does not break them). | Security fixes |
API changes incompatible with previous versions. | API additions | Bug fixes |
Functionality changes incompatible with previous versions. | Functionality additions | |
Dropping support for anything such as Node.js versions, supported libraries, or other features. | Adding tested support for anything, such as Node.js versions, supported libraries, or other features. | |
When a release has changes that could go in multiple semver categories, the highest one is chosen. Release notes are posted with each GitHub release.
Maintenance
Maintenance mode is a period during which a release gets only security and bug fixes whenever possible, but not new features except on a case-by-case basis. Major versions of dd-trace
enter maintenance mode upon the release of the subsequent major version of dd-trace. The maintenance mode period lasts for one year after the release date of that subsequent version.
For example, if version 5.0.0 of dd-trace
is released on May 4, 2023, the 4.x.x release line is supported on a maintenance mode basis until May 4, 2024. During this maintenance mode period, security and bug patches will be applied whenever possible.
If you have any questions or concerns about our support for a particular version of dd-trace-js
, contact Support to discuss.
Node.js Version Support
When the Node.js project drops support for an LTS major release line (when it goes EOL), support for it is dropped in the next major version of dd-trace
.
The last major supporting release line of dd-trace
library supports that EOL version of Node.js for at least another year on a maintenance mode basis.
Some issues cannot be solved in dd-trace
and instead must be solved in Node.js. When this happens and the Node.js release in question is EOL, it’s not possible to solve the issue without moving to another non-EOL release.
Datadog does not make new releases of dd-trace
to provide specific support for non-LTS Node.js major release lines (odd numbered versions).
For the best level of support, always run the latest LTS release of Node.js, and the latest major version of dd-trace
. Whatever release line of Node.js you use, also use the latest version of Node.js on that release line, to ensure you have the latest security fixes.
For more information about Node.js release, see the official Node.js documentation.
Operating system support
The following operating systems are officially supported by dd-trace
. Any operating system not listed is still likely to work, but with some features missing, for example ASM, profiling, and runtime metrics. Generally speaking, operating systems that are actively maintained at the time of initial release for a major version are supported.
dd-trace Version | Operating System | Architectures | Minimum Versions |
---|
3.x | Linux (glibc) | arm, arm64, x64 | CentOS 7, Debian 9, RHEL 7, Ubuntu 14.04 |
| Linux (musl) | arm, arm64, x64 | Alpine 3.13 |
| macOS | arm64, x64 | Catalina (10.15) |
| Windows | ia32, x64 | Windows 8.1, Windows Server 2012 |
2.x | Linux (glibc) | arm, arm64, ia32, x64 | CentOS 7, Debian 9, RHEL 7, Ubuntu 14.04 |
| Linux (musl) | arm, arm64, ia32, x64 | Alpine 3.10 |
| macOS | arm64, x64 | Yosemite (10.10) |
| Windows | ia32, x64 | Windows 8.1, Windows Server 2012 |
Supported integrations
APM provides out-of-the-box instrumentation for many popular frameworks and libraries by using a plugin system. To request support for a module that is not listed, contact our awesome support team.
For details about how to how to toggle and configure plugins, check out the API documentation.
Web framework compatibility
Module | Versions | Support Type | Notes |
---|
connect | >=2 | Fully supported | |
express | 4.x | Fully supported | Supports Sails, Loopback, and more |
fastify | >=1 | Fully supported | |
graphql | >=0.10 | Fully supported | Supports Apollo Server and express-graphql |
graphql-yoga | >=3.6.0 | Fully supported | Supports graphql-yoga v3 executor |
gRPC | >=1.13 | Fully supported | |
hapi | >=2 | Fully supported | Supports [@hapi/hapi] versions >=17.9 |
koa | >=2 | Fully supported | |
microgateway-core | >=2.1 | Fully supported | Core library for Apigee Edge. Support for the edgemicro CLI requires static patching using @datadog/cli. |
moleculer | >=0.14 | Fully supported | |
next | >=9.5 | Fully supported | See note on Complex framework usage.
The tracer supports the following Next.js features:- Standalone (
output: 'standalone' ) - App Router
- Middleware: Not traced, use tracer versions
4.18.0 and 3.39.0 or higher for best experience.
Note: Next.js is under heavy active development, and it is not uncommon for patch releases to break compatibility with dd-trace. Test automations alert Datadog to these issues, but it can often take a few days to fix compatibility with the latest Next.js release. |
paperplane | >=2.3 | Fully supported | Not supported in serverless-mode |
restify | >=3 | Fully supported | |
Complex framework usage
Some modern complex Node.js frameworks, such as Next.js and Nest.js, provide their own entry-point into an application. For example, instead of running node app.js
, you may need to run next start
. In these cases, the entry point is a file that ships in the framework package, not a local application file (app.js
).
Loading the Datadog tracer early in your application code isn’t effective because the framework could have already loaded modules that should be instrumented.
To load the tracer before the framework, use one of the following methods:
Prefix all commands you run with an environment variable:
NODE_OPTIONS='--require dd-trace/init' npm start
Or, modify the package.json
file if you typically start an application with npm or yarn run scripts:
// existing command
"start": "next start",
// suggested command
"start": "node --require dd-trace/init ./node_modules/next start",
"start": "NODE_OPTIONS='--require dd-trace/init' ./node_modules/next start",
Note: The previous examples use Next.js, but the same approach applies to other frameworks with custom entry points, such as Nest.js. Adapt the commands to fit your specific framework and setup. Either command should work, but using NODE_OPTIONS
also applies to any child Node.js processes.
Native module compatibility
Module | Support Type | Notes |
---|
dns | Fully supported | |
http | Fully supported | |
https | Fully supported | |
http2 | Partially supported | Only HTTP2 clients are currently supported and not servers. |
net | Fully supported | |
Data store compatibility
Module | Versions | Support Type | Notes |
---|
cassandra-driver | >=3 | Fully supported | |
couchbase | ^2.4.2 | Fully supported | |
elasticsearch | >=10 | Fully supported | Supports @elastic/elasticsearch versions >=5 |
ioredis | >=2 | Fully supported | |
knex | >=0.8 | Fully supported | This integration is only for context propagation |
mariadb | >=3 | Fully supported | |
memcached | >=2.2 | Fully supported | |
mongodb-core | >=2 | Fully supported | Supports Mongoose |
mysql | >=2 | Fully supported | |
mysql2 | >=1 | Fully supported | |
oracledb | >=5 | Fully supported | |
pg | >=4 | Fully supported | Supports pg-native when used with pg |
redis | >=0.12 | Fully supported | |
sharedb | >=1 | Fully supported | |
tedious | >=1 | Fully supported | SQL Server driver for mssql and sequelize |
Worker compatibility
Module | Versions | Support Type | Notes |
---|
@google-cloud/pubsub | >=1.2 | Fully supported | |
amqp10 | >=3 | Fully supported | Supports AMQP 1.0 brokers (such as ActiveMQ, or Apache Qpid) |
amqplib | >=0.5 | Fully supported | Supports AMQP 0.9 brokers (such as RabbitMQ, or Apache Qpid) |
generic-pool | >=2 | Fully supported | |
kafkajs | >=1.4 | Fully supported | |
rhea | >=1 | Fully supported | |
SDK compatibility
Module | Versions | Support Type | Notes |
---|
aws-sdk | >=2.1.35 | Fully supported | CloudWatch, DynamoDB, Kinesis, Redshift, S3, SNS, SQS, and generic requests. |
openai | >=3.0.0 | Fully supported | |
langchain | >=0.1.0 | Partially supported | The following workflow invocations are supported:
chain.invoke and chain.batch chat_model.invoke llm.invoke openaiEmbeddings.embedQuery and openaiEmbeddings.embedDocuments
|
Promise library compatibility
Module | Versions | Support Type |
---|
bluebird | >=2 | Fully supported |
promise | >=7 | Fully supported |
promise-js | >=0.0.3 | Fully supported |
q | >=1 | Fully supported |
when | >=3 | Fully supported |
Logger compatibility
Unsupported libraries
Fibers
fibers
is incompatible with async_hooks
, a Node.js module that is used by dd-trace-js
to track asynchronous contexts thereby ensuring accurate tracing. Interactions between fibers
and async_hooks
may lead to unpreventable crashes and undefined behavior. So, the use of dd-trace-js
with applications that invoke fibers
directly or indirectly through frameworks such as Meteor may result in instability (crashes) or incorrect tracing.
For additional information or to discuss leave a comment on this github issue or reach out to support to discuss further.
Further Reading
Documentation, liens et articles supplémentaires utiles: