Draft release notes by otelbot-java-instrumentation[bot] · Pull Request #20347 · open-telemetry/opentelemetry-java-instrumentation · GitHub
Skip to content

Draft release notes - #20347

Merged
trask merged 33 commits into
mainfrom
otelbot/draft-release-notes-36949722178
Oct 3, 2026
Merged

trask merged 33 commits into
mainfrom
otelbot/draft-release-notes-36949722178

Conversation

@otelbot-java-instrumentation

Copy link
Copy Markdown
Contributor

Automated draft of the ## Unreleased section of CHANGELOG.md.

The entire ## Unreleased block was regenerated from per-PR classifications. Existing entries are intentionally replaced so the generated draft can be reviewed against them.

Download draft diagnostics

Copilot AI balanced review requested due to automatic review settings October 2, 2026 01:29
@otelbot-java-instrumentation
otelbot-java-instrumentation Bot requested a review from a team as a code owner October 2, 2026 01:29
@opentelemetry-pr-dashboard

opentelemetry-pr-dashboard Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Several entries contain incorrect configuration names or omit important breaking-change and deprecation guidance.

Review effort: Balanced
Findings: 6 Low severity

Open (6)
What changed in this PR

Regenerates the unreleased changelog from per-PR classifications.

Changes:

  • Replaces existing unreleased entries.
  • Adds categorized release notes and PR links.
  • Covers instrumentation, enhancements, fixes, deprecations, and breaking changes.
File Description
CHANGELOG.md Regenerates the complete unreleased release-notes section.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md
Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

Several breaking changes, deprecations, and migration impacts are missing or misclassified.

Review effort: Balanced
Findings: None

Resolved since last review (6)
Previously missed (6)

In code that hasn't changed since last review

Low severity Document deprecation of the entire Elasticsearch artifact

CHANGELOG.md:54

[General] The published opentelemetry-elasticsearch-rest-7.0 artifact is also deprecated, not just these two entrypoint classes (instrumentation/elasticsearch/README.md:3-8). Omitting the artifact-level deprecation leaves dependency consumers unaware that the entire library artifact is scheduled for removal.

Low severity Clarify sampler deprecation scope and SDK initialization failure

CHANGELOG.md:101

[Config] This deprecation is limited to the samplers bundled with the Java agent and Spring Boot starter, and #20249 also makes selecting either one fail SDK initialization under v3 preview. The unqualified wording overstates the affected surface while omitting the immediate failure mode users must address before enabling preview.

Low severity Document deprecation and behavior change for search query capture

CHANGELOG.md:170

[Config] #19675 also deprecates the stable otel.instrumentation.elasticsearch.capture-search-query setting (and YAML java.elasticsearch.capture_search_query) with no replacement; the implementation now warns that it will be removed. This enhancement entry does not communicate that migration impact, so add a separate bullet under Deprecations explaining that query capture becomes unconditional while sanitization remains configurable.

Low severity Document required isRequestStreaming API change

CHANGELOG.md:274

[General] This records the new attribute but omits #19879's binary-incompatible API change: GenAiAttributesGetter gained the required isRequestStreaming(REQUEST) method. Existing implementations can fail with AbstractMethodError when the extractor invokes it, so add a separate bullet under Breaking changes telling implementers to add the method.

Low severity Classify host.id default removal as a breaking change

CHANGELOG.md:366

[General] This changes the Java agent default so existing users stop emitting host.id unless they opt in. The release-note rules classify unconditional emitted-attribute changes as Breaking (.github/scripts/draft-release-notes/rules.md:57-63), so placing this under Enhancements hides an upgrade-impacting telemetry removal; move it to the appropriate Breaking section.

Low severity Specify the exact opt-in value for the preview flag

CHANGELOG.md:398

[Config] This omits the enabling value for the boolean preview flag, unlike the surrounding gated entries. As written it can be read as applying whenever the property is present, including when set to false; name the exact opt-in value.

trask and others added 5 commits October 2, 2026 11:38
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md
Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md
Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

Several breaking changes and configuration deprecations lack necessary migration guidance.

Review effort: Balanced
Findings: 7 Low severity

Open (7)
Previously missed (1)

In code that hasn't changed since last review

Low severity Clarify Elasticsearch REST library artifacts are deprecated

CHANGELOG.md:54

[General] This narrows the deprecation to two entry-point classes, but the Elasticsearch REST library artifacts themselves are deprecated. Restore the artifact-level wording so consumers understand that the dependency, not merely these two types, is being retired.

Comment thread CHANGELOG.md Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

Several API and configuration deprecations are missing or incomplete.

Review effort: Balanced
Findings: 6 Low severity

Open (6)
Resolved since last review (1)
Previously missed (1)

In code that hasn't changed since last review

Low severity Document deprecation of Elasticsearch REST library artifact

CHANGELOG.md:51

[General] The deprecation covers the published Elasticsearch REST library artifact as well as these two entry points. Omitting the artifact makes it appear that consumers can continue using another API from the library, even though the artifact itself is scheduled for removal.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@opentelemetry-pr-dashboard
opentelemetry-pr-dashboard Bot requested a balanced review from Copilot October 2, 2026 23:07

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

Several migration notes omit compatibility details needed to avoid incorrect configuration or telemetry expectations.

Review effort: Balanced
Findings: None

Previously missed (3)

In code that hasn't changed since last review

Low severity Clarify metric pattern migration and automatic stable metrics

CHANGELOG.md:23

[Config] The old value is a target name such as tomcat, while the replacement accepts metric-name patterns such as tomcat.*; copying the value across would select no unstable metrics. Also clarify that stable metrics are collected automatically so the migration is actionable.

Low severity Specify supported Elasticsearch Java client versions

CHANGELOG.md:40

[General] The recommended native client support is only available in Elasticsearch Java API Client 7.17.20+ on the 7.x line and 8.10+. Without those bounds, users on earlier client versions are directed to functionality their dependency does not provide.

Low severity Clarify JVM metrics differ from deprecated OSHI process metrics

CHANGELOG.md:80

[General] These JVM metrics are not equivalent replacements for the deprecated OSHI process metrics: jvm.memory.used reports JVM memory pools rather than process RSS/VMS, and jvm.cpu.time does not preserve the user/system split. Restore that distinction so users do not expect equivalent telemetry after migration.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

The JMX deprecation directs default-mode users to a replacement property that is not honored.

Review effort: Balanced
Findings: None

Previously missed (1)

In code that hasn't changed since last review

Low severity Clarify JMX configuration key behavior outside v3-preview

CHANGELOG.md:32

[Config] This migration is not effective in the release's default mode: JmxMetricInsightInstaller reads java.jmx.enabled (bridged to otel.jmx.enabled) outside v3-preview, while otel.instrumentation.jmx.enabled is consulted only in the v3-preview branch. A user following this note can set the replacement to false and still get JMX metrics. Clarify that the old key remains required in the current default mode and that the new key is the 3.0 replacement.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

Two deprecation entries need more accurate migration guidance.

Review effort: Balanced
Findings: None

Previously missed (2)

In code that hasn't changed since last review

Low severity Clarify otel.jmx.target.system to metric-name glob migration

CHANGELOG.md:23

[General] otel.jmx.target.system accepts target names and enables both stable and unstable definitions, whereas the replacement accepts metric-name glob patterns and only opts in unstable bundled metrics; stable bundled metrics are automatic. Clarify that migration so users do not copy values such as tomcat into the new property (the working equivalent is tomcat.*).

Low severity Document JVM metrics missing ProcessMetrics measurements

CHANGELOG.md:80

[General] The two JVM metrics are not equivalent replacements for ProcessMetrics: they drop process RSS/virtual-memory measurements and the user/system CPU-time split. Preserve this migration caveat so users do not assume their existing process-metric dashboards can switch names without losing data.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

The OSHI migration note omits a consequential difference between the deprecated metrics and their suggested replacements.

Review effort: Balanced
Findings: None

Previously missed (1)

In code that hasn't changed since last review

Low severity Preserve warning that JVM metrics do not replace ProcessMetrics

CHANGELOG.md:79

[General] This reads as though the JVM metrics are equivalent replacements, but ProcessMetrics records process RSS/virtual memory and separate user/system CPU times, while the suggested JVM metrics do not. Preserve the non-equivalence warning from the API Javadoc so users do not unknowingly lose those measurements during migration.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

Two deprecation entries need accurate migration details.

Review effort: Balanced
Findings: None

Previously missed (2)

In code that hasn't changed since last review

Low severity Document migration from target names to metric-name glob patterns

CHANGELOG.md:22

[Config] The replacement property selects metric-name glob patterns, not target-system names, so this reads like a direct property rename even though reusing a value such as tomcat would not enable the target's metrics. Include the value migration (for example, tomcat → tomcat.*) so users can preserve their collection.

Low severity Document minimum client versions for native OpenTelemetry support

CHANGELOG.md:40

[General] Native OpenTelemetry support is only available in Elasticsearch Java API Client 7.17.20+ on the 7.x line and 8.10+. Omitting these minimum versions directs users of earlier clients to a feature they do not have; preserve the version-qualified migration guidance used by the deprecated API's Javadoc.

Comment thread CHANGELOG.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🔵 Needs a closer look

The structured-logging entry omits four deprecated configuration properties.

Review effort: Balanced
Findings: None

Previously missed (1)

In code that hasn't changed since last review

Low severity Document migration from deprecated capture-* boolean properties

CHANGELOG.md:54

[Config] This documents only the source-specific .included/.excluded selectors, but #20066 also deprecates the four capture-* boolean properties. Users relying on those toggles receive no migration guidance; include them here and direct them to the unified .included selector (* preserves the enabled behavior).

@trask
trask merged commit 9eaf312 into main Oct 3, 2026
97 checks passed
@trask
trask deleted the otelbot/draft-release-notes-36949722178 branch October 3, 2026 02:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants