Capture configured OpenSearch REST server targets by trask · Pull Request #19903 · open-telemetry/opentelemetry-java-instrumentation

trask · 2026-08-28T20:35:18Z

Captures each OpenSearch REST client's initially configured node list and reports it through stable database semantic conventions.

Stable spans use the configured target for server.address, server.port, and span naming. The target is a sorted snapshot capped at five endpoints; sniffing and later setNodes calls do not change it. A single non-default port is reported separately, while multi-endpoint targets omit all-default ports or inline every effective port when any endpoint uses a non-default port.

Legacy conventions retain peer address and network type sourced directly from the OpenSearch response. Lower-level HTTP spans retain their independently sourced transport attributes.

This is the third layer of #19974 and is stacked on #19902.

opentelemetry-pr-dashboard · 2026-08-28T20:36:26Z

Pull request dashboard status

Merged · refreshed 2026-09-10 16:34 UTC

Status above doesn't look right?

Anything look wrong? Report it with what you expected; it helps us improve the dashboard.

Copilot

Pull request overview

Adds stable OpenSearch server targets while retaining the actual connected endpoint as network peer telemetry.

Changes:

Captures initial node configuration for OpenSearch 1.x–3.x.
Propagates peer socket details through Apache HttpClient instrumentation.
Extends trace and metric assertions for target and peer attributes.

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`AbstractOpenSearchRestTest.java`	Tests target stability, peers, and metrics.
`OpenSearchServerTargets.java`	Stores initial targets via `VirtualField`.
`OpenSearchServerTarget.java`	Models and sanitizes configured endpoints.
`OpenSearchRestResponse.java`	Removes response-based peer lookup.
`OpenSearchRestRequest.java`	Carries target and peer state.
`OpenSearchRestAttributesGetter.java`	Extracts server and peer attributes.
`OpenSearchRest3Test.java`	Supports configurable 3.x test nodes.
`v3_0/RestClientInstrumentation.java`	Propagates target and peer state.
`v3_0/RestClientConstructorInstrumentation.java`	Captures initial 3.x nodes.
`v3_0/OpenSearchRestSingletons.java`	Simplifies response conversion.
`v3_0/OpenSearchRestInstrumentationModule.java`	Registers constructor instrumentation.
`OpenSearchRestTest.java`	Supports configurable 1.x/2.x test nodes.
`v1_0/RestClientInstrumentation.java`	Propagates target and peer state.
`v1_0/RestClientConstructorInstrumentation.java`	Captures initial 1.x/2.x nodes.
`v1_0/OpenSearchRestSingletons.java`	Simplifies response conversion.
`v1_0/OpenSearchRestInstrumentationModule.java`	Registers constructor instrumentation.
`ApacheHttpAsyncClientInstrumentation.java`	Captures Apache HttpClient 5 peer endpoints.

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

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated no new comments.

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated no new comments.

Copilot

Pull request overview

Copilot reviewed 20 out of 20 changed files in this pull request and generated no new comments.

Review finding: AbstractOpenSearchRestTest adds the field as protected, but nothing outside the class reads it. Only openSearchAttributes() in the same class uses peerAddress; OpenSearchRestTest and OpenSearchRest3Test read only the opensearch container field. The repository style instruction .github/instructions/java-style.instructions.md requires the principle of least access, using the most restrictive modifier that still works, and the sibling Elasticsearch tests declare the same field as private static String peerAddress (ElasticsearchRest5Test line 66, ElasticsearchRest7Test line 63). Fix: declare the field private String peerAddress. Analysis: peerAddress holds the resolved container address that openSearchAttributes() compares against network.peer.address and network.type. It is written once in setUp() and read only inside AbstractOpenSearchRestTest, at lines 261 and 265. The two subclasses, OpenSearchRestTest and OpenSearchRest3Test, inherit the field but never mention it; they use only the opensearch container field. The neighbouring fields are protected because they predate this change, which does not make protected right for a field this pull request introduces. Compiling both subclass test source sets confirms nothing outside the class needs the wider access. Upsides: The field matches the visibility rule the repository states, and the class now says which of its fields a subclass may rely on. A later subclass cannot silently start depending on a field the base class owns. Downsides: The field's modifier differs from the protected fields declared beside it, so the block is no longer uniform. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

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

Review finding: SearchPeerResponseConsumer.failed(Exception) calls capture(parentContext, httpContext), but WrappedFutureCallback.failed(Exception) already makes that exact call with the same parentContext and the same HttpContext instance. Both objects are created together in ClientAdvice.methodEnter under the same captureSearchPeer flag and are installed as arguments 1 and 4 of the same execute() call, so whenever this consumer is in place the wrapped future callback is too. Unlike consumeResponse, which captures from the live HttpContext the client passes in, this override has no context of its own and reads the stored field, so it can never observe endpoint details the callback would miss. The sibling apache-httpasyncclient-4.1 instrumentation makes the same distinction deliberately: its SearchPeerResponseConsumer.failed only delegates, and the capture lives in WrappedFutureCallback.failed and cancelled. Fix: drop the capture call from SearchPeerResponseConsumer.failed in the 5.0 instrumentation, leaving it a plain delegate like its 4.1 sibling, and keep the captures in WrappedFutureCallback.failed and cancelled. Analysis: Apache HttpClient 5.x notifies the future callback on every path that also fails the response consumer, so the consumer capture can never be the only one. Full clients call responseConsumer.failed() and future.failed() together, and minimal clients do the same through BasicClientExchangeHandler. Both captures read the same stored HttpContext field and pass the same parent context, so they resolve identical endpoint details. The live capture stays in consumeResponse, where the client supplies its own HttpContext argument that can differ from the stored one. With the failure-path capture gone, the httpContext field and its constructor argument have no remaining reader, so they go too; the 4.1 sibling keeps its field only because its responseReceived callback has no context parameter. Upsides: Removes a capture that cannot change the recorded peer, drops a field and constructor argument that nothing reads, and makes the 5.0 consumer match the capture points its 4.1 sibling already uses. Downsides: No material downside identified. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

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

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

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

trask requested a balanced review from Copilot August 28, 2026 20:35

opentelemetry-pr-dashboard Bot mentioned this pull request Aug 28, 2026

Pull Request Dashboard #18435

Open

Copilot started reviewing on behalf of trask August 28, 2026 20:36

View session

Copilot AI reviewed Aug 28, 2026

View reviewed changes

Comment thread ...entelemetry/javaagent/instrumentation/opensearch/rest/common/AbstractOpenSearchRestTest.java Outdated

Comment thread ...ntelemetry/javaagent/instrumentation/opensearch/rest/common/v1_0/OpenSearchServerTarget.java Outdated

This was referenced Aug 28, 2026

Capture configured OpenSearch Java client targets #19904

Merged

Align database target and network peer attributes with semantic conventions #19899

Closed

trask requested a balanced review from Copilot August 28, 2026 23:19

Copilot started reviewing on behalf of trask August 28, 2026 23:20

View session

Copilot AI reviewed Aug 28, 2026

View reviewed changes

trask force-pushed the trask-opensearch-rest-targets branch from 069cbdf to 7830b7c Compare August 29, 2026 00:55

trask requested a balanced review from Copilot August 29, 2026 01:00

Copilot started reviewing on behalf of trask August 29, 2026 01:01

View session

Copilot AI reviewed Aug 29, 2026

View reviewed changes

trask changed the title ~~Capture OpenSearch REST targets and network peers~~ Capture the OpenSearch REST logical server and network peer addresses Aug 29, 2026

trask force-pushed the trask-opensearch-rest-targets branch from 7830b7c to 9348e92 Compare August 29, 2026 19:30

trask requested a balanced review from Copilot August 30, 2026 00:14

Copilot started reviewing on behalf of trask August 30, 2026 00:15

View session

Copilot AI reviewed Aug 30, 2026

View reviewed changes

trask changed the title ~~Capture the OpenSearch REST logical server and network peer addresses~~ Capture OpenSearch REST server and peer addresses Aug 30, 2026

trask force-pushed the trask-opensearch-rest-targets branch from f2c8b8b to 10d492e Compare August 30, 2026 15:15

trask force-pushed the trask-opensearch-rest-targets branch from 10d492e to 9c6b787 Compare August 30, 2026 22:32

trask force-pushed the trask-opensearch-rest-targets branch from 0178703 to dae2e68 Compare August 31, 2026 00:21

trask force-pushed the trask-opensearch-rest-targets branch from dae2e68 to c19a9f7 Compare August 31, 2026 01:11

trask and others added 25 commits September 9, 2026 11:40

Preserve legacy OpenSearch REST peer attributes

22c63ab

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

Stabilize OpenSearch REST target ordering

e1cb281

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

Normalize OpenSearch REST target ports

5da2a1e

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

Fix OpenSearch REST configured targets

6a12aaf

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

Cap OpenSearch REST server addresses

196c405

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

Update OpenSearch REST endpoint targets

5e75794

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

Adopt shared OpenSearch REST targets

3b92567

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

Preserve OpenSearch REST node order

c386c97

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

Narrow Apache HTTP search peer helper visibility

506aa03

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

Limit OpenSearch peer capture to stable semconv

4035c32

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

Trim delegated OpenSearch target tests

f7e1404

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

Keep OpenSearch REST integration tests focused

74e3ab5

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

Remove redundant OpenSearch database dup tests

a1d5712

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

Reuse shared OpenSearch REST target

07cd40a

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

Order OpenSearch getter annotations consistently

fc2afff

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

Avoid dead-node retries in OpenSearch target tests

cf3bf79

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

Use the explicit legacy semconv predicate

35a4fb0

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

Use stable network peer capture

5da707a

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

Inline OpenSearch REST attribute assertions

158e783

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

Inline OpenSearch span name assertions

02367d7

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

Canonicalize OpenSearch REST server targets

db89535

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

Remove OpenSearch REST peer capture bridge

ad8e7a5

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

Clarify OpenSearch node replacement comments

5134fcc

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

trask force-pushed the trask-opensearch-rest-targets branch from 6c37fed to 5134fcc Compare September 9, 2026 18:40

trask merged commit 24ef7d8 into main Sep 9, 2026
102 checks passed

trask deleted the trask-opensearch-rest-targets branch September 9, 2026 22:12

laurit pushed a commit to laurit/opentelemetry-java-instrumentation that referenced this pull request Sep 21, 2026

Capture configured OpenSearch REST server targets (open-telemetry#19903)

2f5b00b

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

Navigation Menu

Repository navigation

Capture configured OpenSearch REST server targets - #19903

Capture configured OpenSearch REST server targets#19903
trask merged 30 commits into
trask-elasticsearch-transport-targetsfrom
trask-opensearch-rest-targets

trask commented Aug 28, 2026 •

edited

Loading

Uh oh!

opentelemetry-pr-dashboard Bot commented Aug 28, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

trask commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

opentelemetry-pr-dashboard Bot commented Aug 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request dashboard status

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

trask commented Aug 28, 2026 •

edited

Loading

opentelemetry-pr-dashboard Bot commented Aug 28, 2026 •

edited

Loading