|
Note
|
For the best reading experience, please view this documentation at elastic.co |
The Elastic APM Node.js Agent automatically instruments various APIs in Node.js core and third-party frameworks and packages. This page lists all supported technologies and version ranges.
Support for the Elastic APM Node.js agent follows the support schedule of Node.js itself to the end-of-life period of each version after its maintenance term. Versions of Node.js past their end-of-life date are not supported.
APM agent 4.x releases work with Node.js versions 14.17.0 and later. APM agent 3.x maintenance releases work with Node.js versions 8.6 and later. We will only break support for older Node.js versions with a major version release of the APM agent.
Beginning with version v3.48.0, the Elastic APM Node.js agent includes
limited and experimental support for instrumenting
ECMAScript module imports,
i.e. modules that are loaded via import … statements and import('…') (dynamic import).
See the [esm] document for details.
Note: If you are using TypeScript or JavaScript that is compiled/translated/transpiled to CommonJS-using JavaScript via tools like Babel, Webpack, esbuild, etc., then using import … in your source code is fine. To ensure your compiler is generating JS that uses CommonJS imports, use the following settings:
-
For TypeScript, use
"module": "commonjs"in your "tsconfig.json" (a complete tsconfig.json example). -
For Babel, use
"modules": "commonjs"in your Babel config (for example). -
For Webpack, use
target: 'node', externalsPresets: { node: true }in your "webpack.config.js". -
For esbuild, use
--platform=node --target=node…options toesbuild(for example).
This agent is compatible with {apm-guide-ref}[APM Server] v6.6 and above.
Though you can use Elastic APM with any Node.js framework, we automate a few things for the most popular Node.js modules. These are the frameworks that we officially support:
| Framework | Version | Note |
|---|---|---|
N/A |
||
~4 |
||
^4.0.0 |
||
>=1.0.0 |
See also Fastify’s own LTS documentation |
|
>=17.9.0 <22.0.0 |
||
Koa via koa-router or @koa/router |
>=5.2.0 <14.0.0 |
Koa doesn’t have a built in router, so we can’t support Koa directly since we rely on router information for full support. We currently support the most popular Koa router called koa-router. |
>=12.0.0 <13.3.0 |
(Technical Preview) This instruments Next.js routing to name transactions for incoming HTTP transactions; and reports errors in user pages. It supports the Next.js production server ( |
|
>=5.2.0 <12.0.0 |
The Node.js Elastic APM agent supports usage of the OpenTelemetry Tracing API via its [opentelemetry-bridge]. As well, it instruments the OpenTelemetry Metrics API and Metrics SDK to allow usage of the OpenTelemetry Metrics API.
| Framework | Version |
|---|---|
>=1.0.0 <1.10.0 |
|
>=1.11.0 <2 |
By default transactions are named based on their matched HTTP route if the framework used is listed above. These modules override that behavior to give better insights into specialized HTTP servers:
| Module | Version | Note |
|---|---|---|
>=0.6.1 <0.13.0 |
Will name all transactions by the GraphQL query name. There is a known issue with node <10.4. This module is deprecated and is no longer tested. |
|
>=2.0.4 <4 |
Will name all transactions by the GraphQL query name. Versions before 2.9.6 are no longer tested. |
|
>=4.0.0 |
Will name all transactions by the GraphQL query name |
The Node.js agent will automatically instrument the following modules to give you detailed performance metrics:
| Module | Version | Note |
|---|---|---|
>=2.858.0 <3 |
Will instrument SQS send/receive/delete messages, all S3 methods, all DynamoDB methods, and the SNS publish method |
|
>=3.15.0 <4 |
Will instrument all S3 methods |
|
>=3.15.0 <4 |
Will instrument the SNS publish method |
|
>=3.15.0 <4 |
Will instrument SQS send/receive/delete messages |
|
>=3.15.0 <4 |
Will instrument all DynamoDB methods |
|
>=3.0.0 <5 |
Will instrument all queries |
|
>=8.0.0 |
Will instrument all queries |
|
>=7.0.0 <9.0.0 |
Will instrument all queries |
|
>=0.7.0 <17 |
Will instrument all queries |
|
* |
Will instrument compile and render calls |
|
>=0.5.6 |
Will instrument compile and render calls; Deprecated. No longer tested. Use pug. |
|
>=0.1.0 |
Will instrument compile and render calls |
|
>=2.0.0 <6.0.0 |
Will instrument all queries |
|
>=2.2.0 |
Will instrument all commands. |
|
>=1.2.19 <4 |
Will instrument all queries. A lot of higher level MongoDB modules use mongodb-core, so those should be supported as well. |
|
>=2.0.0 <3.3.0 |
Supported via mongodb-core |
|
>=3.3.0 <7 |
Will instrument all queries |
|
>=1.0.0 <2.7.0 |
Supported via mongodb-core |
|
>=4.0.0 <5.7.0 |
Supported via mongodb-core |
|
>=5.7.0 <8 |
Supported via mongodb |
|
^2.0.0 |
Will instrument all queries |
|
>=1.0.0 <4.0.0 |
Will instrument all queries |
|
>=4.0.0 <9.0.0 |
Will instrument all queries |
|
>=2.0.0 <5.0.0 |
Will instrument all queries |
|
>=1.9 <20.0.0 |
(Excluding v4.0.0.) Will instrument all queries |
|
>=4.7.1 <6 |
Will instrument undici HTTP requests, except HTTP CONNECT. Requires node v14.17.0 or later, or the user to have installed the 'diagnostics_channel' polyfill. |
|
>=1.0.0 <8.0.0 |
Will instrument outgoing WebSocket messages |
|
>=2.0.0 <3.0.0 |
Will instrument all send methods for producers and message and batch processing for consumers. |
The APM agent can be configured to capture span stack traces, to show where in your code a span (e.g. for a database query) was initiated.
Given the async nature of Node.js, it’s not possible for the APM agent to see further back than the last async boundary. Modules that happen to have an async boundary between a call from your application code and the action that leads to an APM span will limit the utility of these span stack traces.
The modules listed below are those that the APM agent instruments to provide more useful span stack traces — ones that point to your application code — when enabled.
If you don’t see your own code in spans, please create a new topic in the Elastic APM discuss forum and include information about your dependencies.
| Module | Version | Note |
|---|---|---|
>=0.10.0 <4.0.0 |
Provides better span stack traces for 'pg' and 'mysql' spans. |
The Elastic APM agent monitors async operations in your Node.js application to maintain awareness of which request is the active request at any given time. Certain modules can interfere with this monitoring if not handled properly.
Below is a list of modules known to cause issues with this monitoring. The versions listed are the versions we support. If you use an unsupported version you might experience missing spans. This does not impact the stability of your application in any way - only the collected metrics.
If you do experience missing spans in your performance metrics, please create a new topic in the Elastic APM discuss forum and include information about your dependencies and what data is missing.
| Module | Version | Note |
|---|---|---|
>=2.0.0 <4.0.0 |
||
^2.0.0 || ^3.1.0 |
Used by a lot of database modules like for instance "pg" |
|
>=0.0.11 <1.0.0 |