Skip to content

Commit 7e64bee

Browse files
authored
Add note to readme for difference between 1.x and 2.x releases (#12239)
1 parent 521109e commit 7e64bee

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,13 @@ This package includes the instrumentation agent as well as
6767
instrumentations for all supported libraries and all available data exporters.
6868
The package provides a completely automatic, out-of-the-box experience.
6969

70+
*Note: There are 2.x releases and 1.x releases. The 2.0 release included significant breaking
71+
changes, the details of which can be found in the [release notes](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.0.0).
72+
It is recommended to use the latest 2.x release which will have the latest features and improvements.
73+
1.x will receive security patches for a limited time and will not include other bug fixes and
74+
enhancements.*
75+
76+
7077
Enable the instrumentation agent using the `-javaagent` flag to the JVM.
7178

7279
```

0 commit comments

Comments
 (0)