Skip to content

Commit 3b3a07f

Browse files
rochdevjuan-fernandezuurien
authored andcommitted
add migration guide for 3.x to 4.x (#3137)
* add migration guide for 3.x to 4.x * Update MIGRATING.md Co-authored-by: Juan Antonio Fernández de Alba <[email protected]> * Update MIGRATING.md Co-authored-by: Juan Antonio Fernández de Alba <[email protected]> * Update README.md Co-authored-by: Ugaitz Urien <[email protected]> --------- Co-authored-by: Juan Antonio Fernández de Alba <[email protected]> Co-authored-by: Ugaitz Urien <[email protected]>
1 parent 5934898 commit 3b3a07f

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

MIGRATING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,45 @@ This guide describes the steps to upgrade dd-trace from a major version to the
44
next. If you are having any issues related to migrating, please feel free to
55
open an issue or contact our [support](https://www.datadoghq.com/support/) team.
66

7+
## 3.0 to 4.0
8+
9+
### Node 14 is no longer supported
10+
11+
Node.js 14 has reached EOL in April 2023 and is no longer supported. Generally
12+
speaking, we highly recommend always keeping Node.js up to date regardless of
13+
our support policy.
14+
15+
### The `orphanable` option was removed
16+
17+
This option was only useful internally for a single integration that has since
18+
been removed. It was never useful for manual instrumentation since all that is
19+
needed to orphan a span on creation is to use
20+
`tracer.trace('web.request', { childOf: null })`.
21+
22+
### Support for `jest-jasmine2` has been removed
23+
24+
The default test runner for Jest was changed to `jest-circus` around 2 years ago and
25+
is no longer supported by our Jest integration for CI Visibility. We recommend
26+
switching to `jest-circus` to anyone still using `jest-jasmine2`.
27+
28+
### Support for older Next.js versions was removed
29+
30+
We now support only Next.js 10.2 and up.
31+
32+
### W3C headers are now prioritized over Datadog headers
33+
34+
As we move towards open standards, we have decided to prioritize W3C Trace
35+
Context headers over our own vendor-specific headers for context propagation
36+
across services. For most applications this shouldn't change anything and
37+
distributed tracing should continue to work seamlessly.
38+
39+
In some rare cases it's possible that some of the services involved in a trace
40+
are not instrumented by Datadog at all which can cause spans within the trace to
41+
become disconnected. While the data would still be available in the UI, the
42+
relationship between spans would no longer be visible. This can be addressed by
43+
restoring the previous behaviour using
44+
`DD_TRACE_PROPAGATION_STYLE='datadog,tracecontext'`.
45+
746
## 2.0 to 3.0
847

948
### Node 12 is no longer supported

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,11 @@ $ yarn lint
153153

154154
### Experimental ESM Support
155155

156+
> **Warning**
157+
>
158+
> ESM support has been temporarily disabled starting from Node 20 as significant
159+
> changes are in progress.
160+
156161
ESM support is currently in the experimental stages, while CJS has been supported
157162
since inception. This means that code loaded using `require()` should work fine
158163
but code loaded using `import` might not always work.

0 commit comments

Comments
 (0)