diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md index e5895db9..b696fe2d 100644 --- a/docs/release-notes/breaking-changes.md +++ b/docs/release-notes/breaking-changes.md @@ -15,34 +15,6 @@ products: Breaking changes can impact your applications, potentially disrupting normal operations and their monitoring. Before you upgrade, carefully review the Elastic Distribution of OpenTelemetry Java breaking changes and take the necessary steps to mitigate any issues. -% ## Next version [edot-java-X.X.X-breaking-changes] - -% Use the following template to add entries to this document. - -% TEMPLATE START -% ::::{dropdown} Title of breaking change -% Description of the breaking change. -% **Impact**
Impact of the breaking change. -% **Action**
Steps for mitigating impact. -% View [PR #](PR link). -% :::: -% TEMPLATE END - -::::{dropdown} OpenAI instrumentation switched from openai-client to openai -In OpenTelemetry Java agent version 2.18.0, an `openai` instrumentation module was added. This conflicted with the `openai-client` instrumentation module that was implemented in the EDOT agent. Since the `openai` module is on by default, we switched off the `openai-client` instrumentation module (previously on by default). The functionality is broadly the same. -**Impact**
Small changes in span names and attributes expected. If the elastic specific `ELASTIC_OTEL_JAVA_INSTRUMENTATION_GENAI_EMIT_EVENTS` was previously set to true, this would no longer produce events. -**Action**
The equivalent of `ELASTIC_OTEL_JAVA_INSTRUMENTATION_GENAI_EMIT_EVENTS` is `OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT`. If you want to revert entirely to the previous setup, turn off the upstream implementation and turn on the EDOT one. For example: `OTEL_INSTRUMENTATION_OPENAI=false` and `OTEL_INSTRUMENTATION_OPENAI_CLIENT=true` -View [PR #763](https://github.com/elastic/elastic-otel-java/pull/763). -:::: -## 1.9.0 [1.9.0] - -**Release date:** February 9, 2026 - -- univeral profiling is disabled by default #958 - -## 1.6.0 [1.6.0] - -**Release date:** October 6, 2025 - -* Switch to upstream instrumentation of openai by default #763 - +:::{changelog} /releases/ +:type: breaking-change +::: diff --git a/docs/release-notes/deprecations.md b/docs/release-notes/deprecations.md index 308b3509..00724da7 100644 --- a/docs/release-notes/deprecations.md +++ b/docs/release-notes/deprecations.md @@ -17,17 +17,6 @@ Over time, certain Elastic functionality becomes outdated and is replaced or rem Review the deprecated functionality for Elastic Distribution of OpenTelemetry Java. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade. To learn how to upgrade, check out [Upgrade](docs-content://deploy-manage/upgrade.md). -% ## Next version [edot-java-X.X.X-deprecations] - -% Use the following template to add entries to this document. - -% TEMPLATE START -% ::::{dropdown} Deprecation title -% Description of the deprecation. -% **Impact**
Impact of the deprecation. -% **Action**
Steps for mitigating impact. -% View [PR #](PR link). -% :::: -% TEMPLATE END - -No deprecations. \ No newline at end of file +:::{changelog} /releases/ +:type: deprecation +::: diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index c8843cc0..fbb77832 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -17,174 +17,6 @@ Review the changes, fixes, and more in each version of Elastic Distribution of O To check for security updates, go to [Security announcements for the Elastic stack](https://discuss.elastic.co/c/announcements/security-announcements/31). -% Release notes include only features, enhancements, and fixes. Add breaking changes, deprecations, and known issues to the applicable release notes sections. - -% ## version.next [edot-java-X.X.X-release-notes] - -% ### Features and enhancements [edot-java-X.X.X-features-enhancements] -% * - -% ### Fixes [edot-java-X.X.X-fixes] -% * - -## 1.10.0 [edot-java-1-10-0-release-notes] -**Release date:** March 24, 2026 - -The 1.10.0 release contains fixes for potential security vulnerabilities. -Refer to our [security advisory](https://discuss.elastic.co/t/elastic-otel-java-1-10-0-security-update-esa-2026-22-ghsa-xw7x-h9fj-p2c7/385700) for more details. - -This release is based on the following upstream versions: - -* opentelemetry-javaagent: [2.26.1](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.26.1) -* opentelemetry-sdk: [1.60.1](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.60.1) -* opentelemetry-semconv: [1.40.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.40.0) -* opentelemetry-java-contrib: [1.54.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.54.0) - -## 1.9.0 [edot-java-1-9-0-release-notes] -**Release date:** February 9, 2026 - -### Breaking changes [edot-java-1-9-0-fixes] -- univeral profiling is disabled by default #958 - -## 1.8.0 [edot-java-1-8-0-release-notes] -**Release date:** December 9, 2025 - -### Features and enhancements [edot-java-1-8-0-features-enhancements] -* Enable indy delegation by default - [#899](https://github.com/elastic/apm-agent-java/pull/899) - -## 1.7.0 [edot-java-1-7-0-release-notes] -**Release date:** November 5, 2025 - -### Features and enhancements [edot-java-1-7-0-features-enhancements] -* Inferred spans can now be disabled and re-enabled via central config - [#838](https://github.com/elastic/elastic-otel-java/pull/838) -* The agent config is now logged on startup, use option elastic.otel.java.experimental.configuration.logging.enabled (default true) to disable if needed - [835](https://github.com/elastic/elastic-otel-java/pull/835) -* add header support for OpAMP integration [#848](https://github.com/elastic/elastic-otel-java/pull/848) - -This release is based on the following upstream versions: - - -* opentelemetry-javaagent: [2.21.0](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.21.0) -* opentelemetry-sdk: [1.55.0](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.55.0) -* opentelemetry-semconv: [1.37.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.37.0) -* opentelemetry-java-contrib: [1.50.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.50.0) - -## 1.6.0 [edot-java-1-6-0-release-notes] -**Release date:** October 6, 2025 - -### Features and enhancements [edot-java-1-6-0-features-enhancements] -* Add support for dynamic configuration options for 9.2 #818 -* Switch upstream Opamp client #789 - -### Breaking changes [edot-java-1-6-0-fixes] -* Switch to upstream instrumentation of openai by default #763 - -This release is based on the following upstream versions: - - -* opentelemetry-javaagent: [2.20.1](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.20.1) -* opentelemetry-sdk: [1.54.1](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.54.1) -* opentelemetry-semconv: [1.37.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.37.0) -* opentelemetry-java-contrib: [1.49.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.49.0) - -## 1.5.0 [edot-java-1.5.0-release-notes] - -### Features and enhancements [edot-java-1.5.0-features-enhancements] - -* Add support of `elastic.otel.verify.server.cert` config option to disable server certificate validation - #726 -* tech preview release of central configuration support for dynamically changing instrumentation and sending, using OpAMP protocol - -This release is based on the following upstream versions: - -* opentelemetry-javaagent: [2.17.1](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.17.1) -* opentelemetry-sdk: [1.51.0](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.51.0) -* opentelemetry-semconv: [1.34.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.34.0) -* opentelemetry-java-contrib: [1.46.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.46.0) - -## 1.4.1 [edot-java-1.4.1-release-notes] - -### Fixes [edot-java-1.4.1-fixes] - -* Fixed `otel.exporter.otlp.metrics.temporality.preference` config option having no effect. - -This release is based on the following upstream versions: - -* opentelemetry-javaagent: [2.15.0](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.15.0). -* opentelemetry-sdk: [1.49.0](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.49.0). -* opentelemetry-semconv: [1.32.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.32.0). -* opentelemetry-java-contrib: [1.45.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.45.0). - -## 1.4.0 [edot-java-1.4.0-release-notes] - -### Features and enhancements [edot-java-1.4.0-features-enhancements] - -* Switched the default of `otel.exporter.otlp.metrics.temporality.preference` from `CUMULATIVE` to `DELTA` to improve dashboarding experience with Kibana. If you want to restore the previous behaviour, you can manually override `otel.exporter.otlp.metrics.temporality.preference` to `CUMULATIVE` via JVM-properties or environment variables. -* Set elastic-specific User-Agent header for OTLP exporters. -* Added support for openAI client 1.1+, drop support for older versions. -* Enabled Azure resource provider by default with `otel.resource.providers.azure.enabled` = `true`. - -This release is based on the following upstream versions: - -* opentelemetry-javaagent: [2.15.0](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.15.0). -* opentelemetry-sdk: [1.49.0](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.49.0). -* opentelemetry-semconv: [1.32.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.32.0). -* opentelemetry-java-contrib: [1.45.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.45.0). - -## 1.3.0 [edot-java-1.3.0-release-notes] - -### Features and enhancements [edot-java-1.3.0-features-enhancements] - -* Added support for OpenAI client 0.14 to 0.31. -* Added support for OpenAI developer messages and raise minimum supported version to 0.8.0. - -This release is based on the following upstream versions: - -* opentelemetry-javaagent: [2.13.3](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.13.3). -* opentelemetry-sdk: [1.47.0](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.47.0). -* opentelemetry-semconv: [1.30.0-rc.1](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.30.0-rc.1). -* opentelemetry-java-contrib: [1.44.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.44.0). - -## 1.2.1 [edot-java-1.2.1-release-notes] - -### Features and enhancements [edot-java-1.2.1-features-enhancements] - -* Added support for OpenAI client 0.13.0. - -This release is based on the following upstream versions: - -* opentelemetry-javaagent: [2.12.0](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.12.0). -* opentelemetry-sdk: [1.46.0](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.46.0). -* opentelemetry-semconv: [1.29.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.29.0). -* opentelemetry-java-contrib: [1.42.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.42.0). - -## 1.2.0 [edot-java-1.2.0-release-notes] - -### Features and enhancements [edot-java-1.2.0-features-enhancements] - -* Added dynamically disabled instrumentation capability. -* Added disable all instrumentations option. -* Added stop-sending option. -* Added OpenAI client instrumentation. - -This release is based on the following upstream versions: - -* opentelemetry-javaagent: [2.12.0](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.12.0). -* opentelemetry-sdk: [1.46.0](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.46.0) -* opentelemetry-semconv: [1.29.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.29.0). -* opentelemetry-java-contrib: [1.42.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.42.0). - -## 1.1.0 [edot-java-1.1.0-release-notes] - -### Fixes [edot-java-1.1.0-fixes] - -* Fixed missing transitive dependencies when using universal profiling integration standalone. - -This release is based on the following upstream versions: - -* opentelemetry-javaagent: [2.10.0](https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/tag/v2.10.0). -* opentelemetry-sdk: [1.44.1](https://github.com/open-telemetry/opentelemetry-java/releases/tag/v1.44.1). -* opentelemetry-semconv: [1.28.0](https://github.com/open-telemetry/semantic-conventions-java/releases/tag/v1.28.0). -* opentelemetry-java-contrib: [1.40.0](https://github.com/open-telemetry/opentelemetry-java-contrib/releases/tag/v1.40.0). - -## 1.0.0 [edot-java-1.0.0-release-notes] - -General Availability release. +:::{changelog} /releases/ +:type: all +::: diff --git a/docs/release-notes/known-issues.md b/docs/release-notes/known-issues.md index 8830d3c7..a4ad7e33 100644 --- a/docs/release-notes/known-issues.md +++ b/docs/release-notes/known-issues.md @@ -13,4 +13,6 @@ products: # Elastic Distribution of OpenTelemetry Java known issues -No known issues. +:::{changelog} /releases/ +:type: known-issue +::: diff --git a/docs/releases/1.10.0.amend-1.yaml b/docs/releases/1.10.0.amend-1.yaml new file mode 100644 index 00000000..e8328bff --- /dev/null +++ b/docs/releases/1.10.0.amend-1.yaml @@ -0,0 +1,11 @@ +entries: +- file: + name: 1017.yaml + checksum: 97e10106382f21b7a8ea86be2013362e1b9bcaba + type: security + title: The 1.10.0 release contains fixes for potential security vulnerabilities + products: + - product: edot-java + description: Refer to our [security advisory](https://discuss.elastic.co/t/elastic-otel-java-1-10-0-security-update-esa-2026-22-ghsa-xw7x-h9fj-p2c7/385700) for more details. + prs: + - https://github.com/elastic/elastic-otel-java/pull/1017