Version 1.2.0

This release requires the use of OpenTelemetry Java SDK 1.2.0.

Note that all artifacts other than io.opentelemetry.javaagent:opentelemetry-javaagent have the -alpha suffix attached to their version number, reflecting that they are still alpha quality and will continue to have breaking changes. Please see the VERSIONING.md for more details.

🌟 New javaagent instrumentation

• RxJava 3 (#2794)

🌟 New library instrumentation

• RxJava 3 (#2794)

📈 Enhancements

• Support sub-millisecond precision for start/end times on Java 9+ (#2600)
• @WithSpan async support added for methods returning async Reactor 3.x types (#2714)
• @WithSpan async support added for methods returning Guava ListenableFuture (#2811)
• Semantic attributes code.namespace and code.function captured on JAX-RS internal spans (#2805)
• Context propagated to reactor-netty callbacks (#2850)

☢️ Behavioral changes

• AWS lambda flush timeout raised to 10 seconds (#2855)
• SERVER span names improved for Spring MVC, Grails, Wicket, and Struts (#2814)
• SERVER span names improved for Servlet filters (#2887)
• SERVER span names improved for Resteasy (#2900)
• SERVER span names improved for Jersey and CXF (#2919)
• JAX-RS @ApplicationPath annotation captured as part of SERVER span name (#2824)
• RequestDispatcher forward() and include() internal spans removed (#2816)
• Raised gRPC min version supported to 1.6 in order to use new gRPC context bridge API (#2948)

🛠️ Bug fixes

• gRPC context bridging issues (#2564, #2959)
• URL credentials of the form https://username:[email protected]/ no longer captured (#2707)
• Spring MVC instrumentation can cause Spring MVC to misroute requests under some conditions (#2815)
• RxJava2 NoSuchFieldError (#2836)
• Duplicate http client tracing headers (#2842)
• Netty 4.1 listeners could not be removed by application (#2851)
• NPE caused in gRPC ProtoReflectionService (#2876)
• Context leak when using Ratpack (#2910)
• Context leak when using Jetty (#2920)
• Servlet instrumentation overwrites setStatus that was set manually earlier (#2929)
• Spans not captured on interface default methods annotated with JAX-RS annotations (#2930)

🧰 Tooling

• Documented how to write InstrumentationModule line by line (#2793)
• New instrumenter API used in JMS instrumentation (#2803)
• Instrumenter API improvements (#2860)
• Muzzle checks whether used fields are actually declared somewhere (#2870)
• Extracted javaagent-extension-api from tooling & spi (#2879)
  • You no longer have to depend on the javaagent-tooling module to implement custom instrumentations: a new javaagent-extension-api module was introduced, containing all the necessary instrumentation classes and interfaces;
  • InstrumentationModule and TypeInstrumentation were moved to the io.opentelemetry.javaagent.extension.instrumentation package;
  • AgentElementMatchers, ClassLoaderMatcher and NameMatchers were moved to the io.opentelemetry.javaagent.extension.matcher package;
  • A new SPI AgentExtension was introduced: it replaces ByteBuddyAgentCustomizer;
  • InstrumentationModule#getOrder() was renamed to order();
  • InstrumentationModule#additionalHelperClassNames() has been removed; use isHelperClass(String) instead if you use the muzzle compile plugin. If you're not using muzzle, you can override getMuzzleHelperClassNames() directly instead;
  • InstrumentationModule#getAllHelperClassNames() has been removed; you can call getMuzzleHelperClassNames() to retrieve all helper class names instead.

🙇 Thank you

This release was possible thanks to the following contributors who shared their brilliant ideas and awesome pull requests:

@agoallikmaa
@ankitgaur-cer
@anuraaga
@asarkar
@breedx-splk
@denis111
@dkulig
@fuleow
@HaloFour
@Hangzhi
@iNikem
@jguerra
@jkwatson
@kubawach
@laurit
@mateuszrzeszutek
@necrolyte2
@pavolloffay
@pellared
@raptium
@richardstartin
@RSoodAMAT
@ryanrupp
@skoppers
@trask
@tydhot
@tylerbenson

Version 1.1.0

This release requires the use of OpenTelemetry Java SDK 1.1.0.

Note that all artifacts other than io.opentelemetry.javaagent:opentelemetry-javaagent have the -alpha suffix attached to their version number, reflecting that they are still alpha quality and will continue to have breaking changes. Please see the VERSIONING.md for more details.

☢️ Behavioral changes

• Update servlet attribute names for log injection, from traceId and spanId to trace_id and span_id (#2593)
• Renamed runtime.jvm.gc.collection metric to runtime.jvm.gc.time (#2616)
• Removed support for Play 2.3 (#2783)
• Configuration properties names for our Spring Boot module were changed to match OpenTelemetry Java SDK properties (#2770)

🌟 New javaagent instrumentation

• Elasticsearch 7 (#2514, #2528)
• Couchbase 3.1 (#2524)
• Grails (#2512)
• RocketMQ (#2263)
• Lettuce 6 (#2589)
• Servlet 5 (#2609)
• Vaadin web framework (#2619)
• GWT (#2652)
• Tapestry web framework (#2690)
• @WithSpan support for methods returning CompletableFuture (#2530)
• @WithSpan support for methods returning async RxJava 2 types (#2530)

🌟 New library instrumentation

• Library instrumentation for AWS SDK v1 (#2525)
• Library instrumentation for Lettuce 5.1 (#2533)
• RocketMQ (#2263)
• Lettuce 6 (#2589)
• Spring Boot Autoconfigure support for @WithSpan methods returning CompletableFuture (#2618)
• Spring Boot Autoconfigure support for @WithSpan methods returning async RxJava 2 types (#2530)
• Mongo (#2789)

📈 Improvements

• Move attributes to span builder for use by samplers (#2587)
• Apache Camel - SNS propagation (#2562)
• Apache Camel - S3 to SQS propagation (#2583)
• Added runtime.jvm.gc.count metric (#2616)
• Support reactor netty HttpClient.from construction (#2650)
• Improve akka instrumentation (#2737)
• Record internal metric for SQL cache misses (#2747)
• End Netty 4.1 client and server spans when the response has completed, instead of when the response has started (#2641)
• More stable context propagation for reactive Mongo client (#2758)

🛠️ Bug fixes

• Fix RestTemplateInterceptor so that it calls endExceptionally() on exception (#2516)
• Fix app failure under Eclipse OSGi (#2521)
• Fix undertow span ending too early (#2560)
• Fix context leak in AWS SDK 2.2 and RocketMQ instrumentations (#2637)
• Fix hang when a webflux http request is made inside of another webflux http request (e.g. auth filter) (#2646)
• Fix @WithSpan instrumentation breaking Java 6 classes (#2699)
• Fix context not propagated over JMS when explicit destination used (#2702)
• Fix StackOverflowError if jdbc driver implementation of Connection getMetaData calls Statement execute (#2756)

🧰 Tooling

• Make muzzle reference creation package(s) configurable (#2615)
• Instrumentations now can skip defining context store manually (#2775)
• New Instrumenter API (#2596)

🙇 Thank you

This release was possible thanks to the following contributors who shared their brilliant ideas and awesome pull requests:

@addname
@agoallikmaa
@amitgud-doordash
@anuraaga
@breedx-splk
@felixbarny
@HaloFour
@iNikem
@jack-berg
@jkwatson
@kubawach
@laurit
@mateuszrzeszutek
@piotr-sumo
@shantanu-vsbhosale
@trask
@tydhot

Version 1.0.1

This release requires the use of OpenTelemetry Java SDK 1.0.0.

🛠️ Bug fixes

• AWS SDK v2 can be applied without a JSON-based service on the classpath (e.g., only S3 is available) #2555
• AWS resource detectors fixed to not NPE

Version 1.0.0

This release requires the use of OpenTelemetry Java SDK 1.0.0.

Note that all artifacts other than io.opentelemetry.javaagent:opentelemetry-javaagent have the -alpha suffix attached to their version number, reflecting that they are still alpha quality and will continue to have breaking changes. Please see the VERSIONING.md for more details.

🌟 New instrumentation

• OkHttp 3 library instrumentation #2489
• AsyncHttpClient 2+ javaagent instrumentation #2348
• JAX-WS frameworks javaagent instrumentation #2314
• RxJava 2 javaagent instrumentation #2130

📈 Improvements

• Low cardinality span names for servlet #2417
• Low cardinality span names for Cassandra #2423
• Low cardinality span names for Couchbase #2449
• Document DB statement sanitization #2451
• Update instrumentation names #2433
• Enrich JDBC spans with db.operation and db.sql.table #2425
• Add custom distro instrumentation unit test example #2373
• Perf improvement by precompiling pattern and using char replacement #2374
• Make http.flavor spec compliant #2370
• DynamoDB attributes #2262
• Make Netty span name spec compliant #2317

🛠️ Bug fixes

• Only set aws header attribute name once #2509
• Use correct value for operation in aws-sdk v1 #2488
• Use dynamic resolution of SQS to allow working without it #2421
• Fix for kubernetes-client instrumentation not working #2416
• Fix for log4j instrumentation breaking user's logger in 2.13.2 #2407
• Fix VerifyError in HttpUrlConnectionInstrumentation #2380
• Fix high concurrency test on later versions of Vert.x #2378
• Better context passing for Netty #2323, #2361

🧰 Tooling

• LOTS of improvements to the instrumentation-api tracers #2401, #2418, #2424, #2452, #2453, #2468, #2482, #2478, #2492
• Add a caching API based on caffeine for use from instrumentation #2477
• Fix gradle caching was not re-running some tests that needed to be re-run #2504
• SNS to SQS tracing propagation test #2483
• Use ClassValue instead of WeakMap to cache span name #2491
• Move some classes out of instrumentation-api #2466
• Fix flaky tests #2448, #2450
• Create a new SupportabilityMetrics class rather than using alpha Metrics #2353
• Use fetch-depth=0 for all non-release builds for consistent versioning #2392
• Enable disabled tests for HttpUrlConnection #2382
• Add OpenJ9 image smoke test configurations #2377, #2386
• Only run smoke tests if requested #2385
• Remove trivial uses of Guava from agent #2360
• Migrate Armeria to HttpServer/ClientTest #2345
• Remove HttpServerTest.testExceptionBody and redirectHasBody #2346

☢️ Breaking changes

• Expose only minimal entrypoint for Armeria library instrumentation #2463
• Refactor gRPC library instrumentation to expose minimal API #2474, #2510
• Migrate AWS SDK v2 to new library API pattern #2487
• Hide non-spec'd span attributes behind experimental flags #2376, #2402, #2434
• Rename some properties #2455, #2457, #2486

🙇 Thank you

Many thanks to all the people who have contributed over the past few years! We couldn't have done without everyone's help.

Version 0.17.0

This update requires the use of OpenTelemetry Java SDK 0.17.0 or 0.17.1. There are many breaking changes in the API so if you manually trace using the API, you should carefully go through the release notes to see what needs to be updated.

If you use library instrumentation, you will want to take advantage of our shiny new BOM that we now publish to manage versions of io.opentelemetry.instrumentation and io.opentelemetry at io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha:0.17.0-alpha. This means you do not want to use the SDK's BOM, io.opentelemetry:opentelemetry-bom - our BOM includes a compatible version so you don't have to worry about it.

Note that all artifacts other than io.opentelemetry.javaagent:javaagent have had the -alpha suffix attached to their version number to reflect the fact that we plan on releasing the javaagent as a stable artifact next month - all other artifacts will still be alpha quality and have continuing breaking changes.

🌟 New instrumentation

• RxJava2 instrumentation (library only for now) #2191
• Apache HTTPClient 5 #2254
• Runtime metrics for JVM enabled by javaagent #2311

📈 Improvements

• Some extraneous libraries have been removed from the agent package #2238 #2251 #2288
• The agent does not register an extraneous shutdown hook which is now managed by the SDK #2283
• Context is propagated to apache httpclient async callback #2276
• When agent debug is enabled, spans are also logged to standard out #2270
• Possibly minor startup performance improvement by avoiding String.format #2309
• Metric collected for when we suppress nested spans #2135
• MongoDB span names follow specification #2307
• More jetty handlers are instrumented #2320

🛠️ Bug fixes

• AWS Lambda instrumentation will now propagate from HTTP headers if X-Ray is disabled #2222
• Apache Camel instrumentation will not throw an NPE in app code when SQS propagation is not enabled #2250
• Prometheus collector's required HTTP dependency is restored #2259
• gRPC client instrumentation does not squash exceptions thrown in client message handlers #2294
• App server context name is correctly set for managed app servers #2089
• HttpUrlConnection exceptions correctly set status code #2272

🧰 Tooling

• Smoke tests are faster by only starting shared containers once #2249
• A license report of all dependencies bundled into the agent is now also bundled in #2239 #2261 #2278
• Tracers now return context instead of spans #2232
• Downstream instrumentation tests can now be written in java with junit5 using our new extensions #2241
• In general, the testing framework now makes less assumptions and should support wider use cases, for example ClassRule #2265
• Library instrumentation can now use HttpServerTest and HttpClientTest abstractions #2299
• Less chance (no chance?) of deadlock in builds due to logging race conditions #2236
• JDK does not need to be in the PATH to run the build #2322

☢️ Breaking changes

• Logging injection now sets fields trace_id, span_id, and trace_flags, instead of traceId, spanId, and sampled
• AWS Lambda instrumentation now requires an OpenTelemetrySdk to be provided for initialization of non-wrappers. Wrappers use opentelemetry-sdk-extension-autoconfigure similar to the javaagent. #2328

🙇 Thank you

This release was possible thanks to the following contributors who shared their brilliant ideas and awesome pull requests:

@agoallikmaa
@anuraaga
@breedx-splk
@iNikem
@jamal
@jkwatson
@kubawach
@laurit
@Oberon00
@mateuszrzeszutek
@trask

Version 0.16.1

This patch release contains a bug fix for a NPE in Apache Camel instrumentation - SQS context propagation (#2250).

For more details about what has changed since 0.15.1 see the release notes for version 0.16.0.

Version 0.16.0

This update is compatible with the OpenTelemetry Java SDK 0.16.0. There are many breaking changes in the API so if you manually trace using the API, you should carefully go through the release notes to see what needs to be updated.

🌟 New instrumentation

• Apache Dubbo #2108
• Apache CXF (JAX-RS) #2192
• JAX-WS #2176
• Reactor Netty 1.0 #2156
• Apache Wicket #2139

📈 Improvements

• Additional Cassandra span attributes captured #1314
• Apache Camel SQS propagation #2102
• Tracers support injection of OpenTelemetry instances #2233, #2197
• Context is used more consistently in Tracer classes #2194
• Major documentation re-org, no longer massive wall of text(!) #2226

🛠️ Bug fixes

• Broken traces from Netty Reactor instrumentation #2156, #2229 🤞

🧰 Tooling

• More muzzle doc #2158
• Static imports (style guidelines) doc #2161
• Clean up of spock test runners #2134, #2223, #2205, #2196
• Tracer hierarchy clean up #2159
• Improved test stability #2169, #2170, #2181, #2202, #2154
• Test latest hibernate versions #2182
• New tests exercising http client concurrency #2156
• Automation of draft release in GHA workflow #2237
• Add tests for tomee application server #2175

☢️ Breaking changes

• Some configuration properties have been updated to the latest specification
  • OTEL_TRACE_EXPORTER/otel.trace.exporter has been replaced with OTEL_TRACES_EXPORTER/otel.traces.exporter
  • OTEL_TRACE_SAMPLER/otel.trace.sampler has been replaced with OTEL_TRACES_SAMPLER/otel.traces.sampler
  • OTEL_TRACE_SAMPLER_ARG/otel.trace.sampler.arg has been replaced with OTEL_TRACES_SAMPLER_ARG/otel.traces.sampler.arg

🙇 Thank you

This release was possible thanks to the following contributors who shared their brilliant ideas and awesome pull requests:

@anuraaga
@breedx-splk
@brianashby-sfx
@evantorrie
@FrankSpitulski
@gliptak
@iNikem
@jkwatson
@kubawach
@laurit
@markfink-splunk
@mateuszrzeszutek
@trask
@tydhot
@vovencij

Version 0.15.1

This patch release contains a bug fix fox SQS propagation in apache-camel instrumentation (#2102).

For more details about what has changed since 0.14.0 see release notes for version 0.15.0.

Version 0.15.0

This update is compatible with the OpenTelemetry Java SDK 0.15.0. Most breaking changes are in the SDK so if you are using library instrumentation and the SDK directly, you may need to update code for initializing the SDK.

🌟 New instrumentation

• JSF actions #2018
• MongoDB 4 #2046
• Spring batch: items #2047
• Spring Web Services #2111
• Mojarra / Myfaces #2119

📈 Improvements

• Fix instrumentation of Jersey 2.30 #2071
• The agent now uses the SDK autoconfiguration module for environment variables #2077
• Servlet tracer names now reflect the version of the instrumentation library, e.g. servlet-2.0, servlet-3.0 #1979
• JMS does not create spans when no messages are received #2091
• SQL sanitization performance improved and now results are cached #2113 #2094
• AWS SDK v1 instrumentation will now always use AWS trace propagator without configuring it globally #2117
• AWS SDK v1 propagates SQS trace context #2114

🛠️ Bug fixes

• The agent will work correctly with the latest version of Netty #2070
• The agent will work correctly with the latest version of Apache Camel #2084
• The agent will work correctly with the latest version of Spring Webflux #2100

🧰 Tooling

• Tests for verifying behavior with Apache Camel and AWS SQS #2061
• Netty instrumentation only attempts to be applied now if the classpath contains 4.0, or 4.1 respectively #2099
• The default branch has been renamed to main #2118
• Agent testing libraries are published for use in custom distributions #2133

☢️ Breaking changes

• Jaeger thrift exporter has been removed from the default agent distribution. Splunk distribution still includes it. #2073
• Instrumentation-specific flags for enabling SQL sanitization have been consolidated into one otel.instrumentation.db-statement-sanitizer.enabled
• Many configuration properties have been updated to the latest specification
  • otel.exporter -> otel.trace.exporter / otel.metrics.exporter. The new variables only accept a single value
  • otel.exporter.otlp.endpoint now requires a scheme of http:// or https://. otel.exporter.otlp.insecure has been removed
  • otel.bsp.max.queue -> otel.bsp.max.queue.size
  • otel.bsp.max.export.batch -> otel.bsp.max.export.batch.size
  • otel.bsp.export.sampled has been removed. Only sampled spans are exported
  • otel.config.sampler.probability -> otel.trace.sampler=parentbased_traceidratio and otel.trace.sampler.arg=<probability>
  • otel.config.max.attrs -> otel.span.attribute.count.limit
  • otel.config.max.events -> otel.span.event.count.limit
  • otel.config.max.links -> otel.span.link.count.limit

🙇 Thank you

This release was possible thanks to the following contributors who shared their brilliant ideas and awesome pull requests:

@anuraaga
@ben-childs-docusign
@breedx-splk
@iNikem
@jkwatson
@kubawach
@laurit
@malafeev
@mateuszrzeszutek
@pavolloffay
@trask
@vovencij

Version 0.14.0

This update is compatible with the OpenTelemetry Java SDK 0.14.1. Most breaking changes are in the SDK so if you are using library instrumentation and the SDK directly, you may need to update code for initializing the SDK.

🌟 New instrumentation

• Spring batch chunks #1850
• Spring batch partitioning #2034
• App-server specific runtimes
  • Undertow #1917
  • Liberty #1929
  • Jetty #2029

📈 Improvements

• Grizzy spans have exceptions added #1987
• AWS Lambda flush timeout can be configured #1960
• Context propagation for apache camel instrumentation #2042
• Netty instrumentation adds exceptions #2027
• Logging exporter outputs one span per line instead of combining a batch #2054
• Lambda SQS users do not need to configure xray as their app propagators anymore #2056
• Armeria instrumentation updated to target 1.3.0 which had breaking changes

🛠️ Bug fixes

• External exporter JAR file is closed correctly during initialization #1970
• Correctly propagate context in Jetty #1966
• Correctly handle servlet2 response with unset status #1985
• Agent logs its version at startup again #2026

🧰 Tooling

• End-to-end benchmark for latency when using the agent #1935
• Tests are now run with an actual javaagent instead of post-startup bytebuddy reinstantiation #1643
• Automatic code security scanning enabled #1971
• Jackson version updated #2040

☢️ Breaking changes

• Armeria instrumentation does not support Armeria versions before 1.3.0

🙇 Thank you

This release was possible thanks to the following contributors who shared their brilliant ideas and awesome pull requests:

@amanbrar1999
@anuraaga
@avpatel257
@bhautikpip
@breedx-splk
@iNikem
@jkwatson
@kubawach
@laurit
@malafeev
@mateuszrzeszutek
@pavolloffay
@tobias-
@trask
@vovencij