Upgrade to v1.x
Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud. Availability This functionality is generally available and ready for production usage. The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes. The Elastic APM Node.js agent enables you to trace the execution of operations in your Node.js applications, sending performance metrics and errors to the Elastic APM Server. Availability This functionality is generally available and ready for production usage. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Serverless Observability
Generally available
Stack
Generally available
APM Agent Node.js
Generally available
The following is a guide on upgrading your Node.js agent from version 0.x to version 1.x.
Version 1.x of the Node.js agent requires version 6.2 of the APM Server or higher.
The term "trace" was previously used to describe a small piece of work instrumented by the agent during a transaction. To align with modern APM vendors, we now refer to this as a "span"
The term "app" was previously used to describe your Node.js application in relation to Elastic APM. To be more specific, we now refer to this as a "service".
The following config options have been removed in version 1.0.0:
| Name | Note |
logBody |
Use captureBody instead. Note that this option is not a boolean |
The following config options have been renamed between version 0.x and 1.x.
The associated environment variable for each renamed config option have been renamed accordingly as well.
| Old name | New name | Note |
appName |
serviceName |
Renamed to align with new naming conventions |
appVersion |
serviceVersion |
Renamed to align with new naming conventions |
captureTraceStackTrace |
captureSpanStackTraces |
Renamed to align with new naming conventions |
sourceContextErrorAppFrames |
sourceLinesErrorAppFrames |
Renamed to align with other agents |
sourceContextSpanAppFrames |
sourceLinesSpanAppFrames |
Renamed to align with other agents |
sourceContextErrorLibraryFrames |
sourceLinesErrorLibraryFrames |
Renamed to align with other agents |
sourceContextSpanLibraryFrames |
sourceLinesSpanLibraryFrames |
Renamed to align with other agents |
validateServerCert |
verifyServerCert |
Renamed to align with other agents |
The following functions have been renamed between version 0.x and 1.x:
| Old name | New name | Note |
buildTrace() |
buildSpan() |
Renamed to align with new naming conventions |