Skip to content

Commit

Permalink
Added v7 upgrade guide
Browse files Browse the repository at this point in the history 
* Add v7 upgrade guide
* Fixed v6 link
* Added version to '#node-support' sections
* Changed `Node.js v...` to `Node.js agent v...` for all versions to specify agent version and not Node.js version 

Please reach out to the Node team in #node-agent for technical review. If you have any questions, reach out to me in slack or in the #gts-nodejs channel! Thank you!
  • Loading branch information
@linbaker
linbaker committed Jul 5, 2021
1 parent d05f2ba commit 24dac0c
Showing 1 changed file with 100 additions and 8 deletions.
108 changes: 100 additions & 8 deletions ...ent/docs/agents/nodejs-agent/installation-configuration/update-nodejs-agent.mdx
View file
Expand Up @@ -18,9 +18,101 @@ To take full advantage of New Relic's latest features, enhancements, and importa

**Recommendation:** Test your updated version before moving it into production. If you have problems, follow the Node.js agent [troubleshooting procedures](/docs/agents/nodejs-agent/troubleshooting/troubleshooting-your-nodejs-installation).

## Upgrade to Node.js agent version 6 [#node-agent-v5]
## Upgrade to Node.js agent version 7 [#node-agent-v7]

Before upgrading to Node.js version 6, review this information for major changes.
Before upgrading to Node.js version 7, review this information for major changes.

<table>
<thead>
<tr>
<th style={{ width: "250px" }}>
**Major changes with Node.js agent v7**
</th>

<th>
**Comments**
</th>
</tr>
</thead>

<tbody>

<tr>
<td>
**BREAKING** Removed deprecated `httpResponseCode`, `response.status` and `httpResponseMessage` http response attributes
</td>

<td>
* **v6.4.2-v6.14.0:** Starting in agent v6.4.2, these attributes were marked as deprecated but left in to give a transition period for the new attributes.
* **v7:** When http response attribute reporting is enabled, `http.statusCode` and `http.statusText` will be reported.
</td>
</tr>

<tr>
<td>
**BREAKING** Removed deprecated `setIgnoreTransaction` API method
</td>

<td>
* **v5 - v6:** Starting in agent v5.0.0, this method was marked as deprecated but left in to give a transition period for the new methods.
* **v7:** Applications must use the API method [`transactionHandle.ignore()`](/docs/agents/nodejs-agent/api-guides/nodejs-agent-api/#transaction-handle-ignore).
</td>
</tr>

<tr>
<td>
**BREAKING** Removed the `api.custom_parameters_enabled` configuration item and associated environment variable `NEW_RELIC_API_CUSTOM_PARAMETERS`.
</td>

<td>
* Applications must use the configuration [`api.custom_attributes_enabled` or the associated environment variable `NEW_RELIC_API_CUSTOM_ATTRIBUTES`](/docs/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration/#custom-attributes) to enable [`newrelic.addCustomAttribute`](/docs/agents/nodejs-agent/api-guides/nodejs-agent-api/#add-custom-attribute) and [`newrelic.addCustomAttributes`](/docs/agents/nodejs-agent/api-guides/nodejs-agent-api/#add-custom-attributes).
</td>
</tr>

<tr>
<td>
**BREAKING** Removed deprecated Distributed Tracing API methods, `createDistributedTracePayload()` and `acceptDistributedTracePayload()`
</td>

<td>
* **v6.4.0-v6.14.0:** Starting in agent v6.4.0, these method were marked as deprecated but left in to give a transition period for the new methods.
* **v7:** Applications must use the API methods [`transactionHandle.insertDistributedTraceHeaders(headers)`](/docs/agents/nodejs-agent/api-guides/nodejs-agent-api/#transaction-handle-insertDistributedTraceHeaders) and [`transactionHandle.acceptDistributedTraceHeaders(transportType, headers)
`](/docs/agents/nodejs-agent/api-guides/nodejs-agent-api/#transaction-handle-acceptDistributedTraceHeaders). With these methods, the Node agent will now accept W3C's `traceparent` and `tracestate` headers when calling `transactionHandle.acceptDistributedTraceHeaders(headers)` and include the W3C headers along with the New Relic distributed tracing header when calling `transactionHandle.insertDistributedTraceHeaders(headers)`, unless the New Relic trace header format is disabled using [`distributed_tracing.exclude_newrelic_header:true`.](/docs/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration/#dt-exclude-newrelic-header)
</td>
</tr>

<tr>
<td>
Update New Relic Dependencies to versions with updated Node version support
</td>

<td>
* @newrelic/aws-sdk v3.0.0
* @newrelic/koa v5.0.0
* @newrelic/native-metrics v6.0.0
* @newrelic/superagent v4.0.0
* @newrelic/test-utilities v5.0.0
</td>
</tr>
</tbody>
</table>

## Node version support [#node-support-v7]

Node v10 is the earliest version supported by the New Relic Node.js v7 agent. Node 8 and 9 are not supported by v7. Customers running Node 9 and earlier have two options:

* Upgrade to a supported version of Node and take advantage of the New Relic Node.js v7 agent's new features.
* Remain on New Relic Node.js v6 agent without the ability to use new features only available with update agent versions.

[Node 10 no longer receive updates](https://github.com/nodejs/Release/tree/cecdcf#end-of-life-releases), but New Relic will continue to support these versions of Node for the time being.

<Callout variant="tip">
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 10.
</Callout>

## Upgrade to Node.js agent version 6 [#node-agent-v6]

Before upgrading to Node.js agent version 6, review this information for major changes.

<table>
<thead>
Expand Down Expand Up @@ -63,7 +155,7 @@ Before upgrading to Node.js version 6, review this information for major changes
</tbody>
</table>

## Node version support [#node-support]
## Node version support [#node-support-v6]

Node 8 is the earliest version supported by the New Relic Node.js v6 agent. Node 6, 7 and 9 are not supported by v6. Customers running Node 6, 7 and 9 have two options:

Expand All @@ -78,7 +170,7 @@ Node 8 is the earliest version supported by the New Relic Node.js v6 agent. Node

## Upgrade to Node.js agent version 5 [#node-agent-v5]

Before upgrading to Node.js v5, review this information for major changes. Also see New Relic's [Node.js v5 migration guide on GitHub](https://github.com/newrelic/node-newrelic/blob/819db2f3f9051960e034f36540817450f663241f/Migration%20Guide.md).
Before upgrading to Node.js agent v5, review this information for major changes. Also see New Relic's [Node.js v5 migration guide on GitHub](https://github.com/newrelic/node-newrelic/blob/819db2f3f9051960e034f36540817450f663241f/Migration%20Guide.md).

<table>
<thead>
Expand Down Expand Up @@ -153,7 +245,7 @@ Before upgrading to Node.js v5, review this information for major changes. Also
</tbody>
</table>

## Node version support [#node-support]
## Node version support [#node-support-v5]

Node 6 is the earliest version supported by the New Relic Node.js v5 agent. Node 4 and 5 are not supported by v5. Customers running Node 4 or 5 have two options:

Expand All @@ -177,7 +269,7 @@ As of New Relic for Node.js v5:

## Upgrade to Node.js agent version 4 [#node-agent-v4]

Before upgrading to Node.js v4, review this information for major changes. Also see New Relic's [Node.js v4 migration guide on GitHub](https://github.com/newrelic/node-newrelic/blob/819db2f3f9051960e034f36540817450f663241f/Migration%20Guide.md#upgrading-to-agent-v4).
Before upgrading to Node.js agent v4, review this information for major changes. Also see New Relic's [Node.js v4 migration guide on GitHub](https://github.com/newrelic/node-newrelic/blob/819db2f3f9051960e034f36540817450f663241f/Migration%20Guide.md#upgrading-to-agent-v4).

<CollapserGroup>
<Collapser
Expand Down Expand Up @@ -206,7 +298,7 @@ Before upgrading to Node.js v4, review this information for major changes. Also

## Upgrade to Node.js agent version 3 [#node-agent-v3]

Before upgrading to Node.js v3, review this information for major changes. Also see New Relic's [Node.js v3 migration guide on GitHub](https://github.com/newrelic/node-newrelic/blob/819db2f3f9051960e034f36540817450f663241f/Migration%20Guide.md#upgrading-to-agent-v3).
Before upgrading to Node.js agent agent v3, review this information for major changes. Also see New Relic's [Node.js v3 migration guide on GitHub](https://github.com/newrelic/node-newrelic/blob/819db2f3f9051960e034f36540817450f663241f/Migration%20Guide.md#upgrading-to-agent-v3).

<CollapserGroup>
<Collapser
Expand Down Expand Up @@ -263,7 +355,7 @@ Before upgrading to Node.js v3, review this information for major changes. Also

## Upgrade to Node.js agent version 2 [#node-agent-v2]

Before upgrading to Node.js v2, review this information for major changes. Also see New Relic's [Node.js v2 migration guide on GitHub](https://github.com/newrelic/node-newrelic/blob/819db2f3f9051960e034f36540817450f663241f/Migration%20Guide.md#upgrading-to-agent-v2).
Before upgrading to Node.js agent v2, review this information for major changes. Also see New Relic's [Node.js v2 migration guide on GitHub](https://github.com/newrelic/node-newrelic/blob/819db2f3f9051960e034f36540817450f663241f/Migration%20Guide.md#upgrading-to-agent-v2).

<CollapserGroup>
<Collapser
Expand Down

0 comments on commit 24dac0c

Please sign in to comment.