To ensure that you have the most up-to-date version of New Relic, refer to the Node.js agent release notes. The release notes include a download link when applicable, plus instructions to download and install the latest version.
- If the
newrelicmodule is listed in your
- If you want to target just the
npm update newrelic.
New Relic recommends testing your updated version before moving it into production. If you have problems, follow the Node.js agent troubleshooting procedures.
Upgrade to Node.js agent version 2
Review this information to help you upgrade to New Relic's Node.js v2 agent, or refer to New Relic's Node.js migration guide on GitHub. Here is a summary of major changes.
|Major changes with Node.js v2 agent||Comments|
|Reversed naming and ignore rules||
|De-duplicated HTTP request transactions||
|Stopped swallowing outbound request errors||
Updated configuration options as of v2
newrelic.js, edit the Node.js agent configuration properties you use for compatiblity with the latest versions:
|Deprecated property||New property|
By default, request attributes are not sent to New Relic. Set
Add any request attribute keys to the
These Node.js agent configuration properties also have overrides for specific destinations, including:
For example, if the root
true and you set
transaction_tracer.attributes.enabled: false, this will restrict attributes from being collected in transaction traces, while still allowing them for all others.
Deprecated API methods as of v2
The following methods from the Node.js agent have been deprecated, and New Relic will delete them in the next major version of the Node.js agent. Each has an easy replacement that accomplishes the same task in a more flexible and reliable way.
New v2 agent API methods
The following API methods are new with the New Relic Node.js v2 agent.
This method gets a reference to the currently running transaction. Use in conjunction with:
- Callback-based message consumer services for troubleshooting message consumers
These new API methods replace the older
create*Transactionmethods. They are easier to use and seamlessly work with promises. Unlike the v1 method, the provided callback is invoked immediately.
Use these methods to add custom instrumentation for third party modules, including those already instrumented by the New Relic Node.js agent. For more information, see New Relic's Node.js instrumentation tutorials on GitHub.
Use this method to add a custom trace attribute.
Use this method to add multiple custom trace attributes.
Node version support
The earliest version of Node supported by the New Relic Node.js v2 agent is 0.10. Node 0.8, which has not been updated since July of 2014, is not supported by v2. Customers running Node 0.8 have two options:
- Upgrade to a supported version of Node and take advantage of the New Relic Node.js v2 agent's new features.
- Remain on New Relic Node.js v1 agent without the ability to use new features only available with updated agent versions.
Node 0.10 also no longer receives updates, but New Relic will continue to support this version of Node for the time being.
Recommendation: Upgrade to a newer version of Node as soon as possible. The next major version of the New Relic Node.js agent will likely remove support for Node 0.10.
npm version support as of v2
The New Relic Node.js agent now requires npm version 2.0.0 or higher. This version of npm comes packaged with Node 0.10.44 or higher.
If you are using an earlier version of Node 0.10 you will need to first install npm 2.0.0 or higher, or upgrade to a newer version of Node. To install npm version 2:
$ npm install --global npm@2
Feature flags as of v2
As of New Relic Node.js agent v2:
express_segments: This feature is no longer configurable.
cat: This feature is now controlled by the
Framework minimum versions as of v2
As of New Relic Node.js agent v2:
|Module||V2 minimum||Minimum before v2|