Update Jedis to stable database semconv by trask · Pull Request #18808 · open-telemetry/opentelemetry-java-instrumentation

trask · 2026-05-20T03:28:14Z

Update the Jedis 4.0 javaagent instrumentation to fill in the remaining stable database semantic convention fields that require connection metadata:

db.namespace from the configured Redis database index
server.address
server.port

This also updates stable database span names to include the server endpoint fallback and adds the Jedis connection metadata plumbing needed to capture those values for command spans.

Copilot

Pull request overview

Updates Jedis instrumentations to align with stable database semantic conventions by enriching span attributes and span naming (primarily for Jedis 4.0), and adjusts tests to validate the new stable-semconv behavior.

Changes:

Jedis 4.0: capture server address/port + configured database index and emit them via stable semconv (including updated span naming).
Jedis 1.4/3.0: update span naming behavior under stable database semconv.
Tests: reset Redis DB to index 0 between tests and add/extend stable-semconv assertions.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
instrumentation/jedis/jedis-common-1.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/common/v1_4/JedisRequestContext.java	Adds helper to derive a database index for stable semconv emission.
instrumentation/jedis/jedis-4.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/jedis/v4_0/Jedis40ClientTest.java	Updates assertions for stable DB semconv span names/attributes and adds db.namespace scenarios.
instrumentation/jedis/jedis-4.0/javaagent/src/main/java/redis/clients/jedis/DefaultJedisSocketFactoryUtil.java	Injected helper to access Jedis package-private host/port from socket factory.
instrumentation/jedis/jedis-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/v4_0/JedisSingletons.java	Replaces generic DB span-name extractor with Redis-specific stable-semconv span naming; adds VirtualField for connection metadata.
instrumentation/jedis/jedis-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/v4_0/JedisRequest.java	Extends request model to carry server/db metadata needed for stable semconv.
instrumentation/jedis/jedis-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/v4_0/JedisInstrumentationModule.java	Enables injected helper class loading for Jedis 4.0 via experimental module hooks.
instrumentation/jedis/jedis-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/v4_0/JedisDbAttributesGetter.java	Implements stable-semconv getters for db.namespace and server.* attributes.
instrumentation/jedis/jedis-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/v4_0/JedisConnectionInstrumentation.java	Captures connection metadata at construction and threads connection through request creation.
instrumentation/jedis/jedis-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/v4_0/JedisConnectionInfo.java	Stores extracted server address/port and configured database index for reuse per connection.
instrumentation/jedis/jedis-3.0/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/jedis/v3_0/Jedis30ClientTest.java	Ensures tests reset Redis DB index to 0 between runs.
instrumentation/jedis/jedis-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/v3_0/JedisSingletons.java	Updates span naming to match stable DB semconv behavior.
instrumentation/jedis/jedis-1.4/testing/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/AbstractJedisTest.java	Ensures tests reset Redis DB index to 0 between runs.
instrumentation/jedis/jedis-1.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/v1_4/JedisSingletons.java	Updates span naming to match stable DB semconv behavior.

Copilot

Pull request overview

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

Copilot

Pull request overview

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

CI compiled the Jedis 4 javaagent against a Jedis version where JedisClientConfig#getDatabase returns Integer, while the captured database index is stored as Long. Convert the returned database index with Long.valueOf(...) so the source compiles against both int and Integer signatures. Validation: .\gradlew.bat :instrumentation:jedis:jedis-4.0:javaagent:compileJava Validation: .\gradlew.bat :instrumentation:jedis:jedis-4.0:javaagent:compileJava -PtestLatestDeps=true Validation: .\gradlew.bat :instrumentation:jedis:jedis-4.0:javaagent:muzzle Validation: .\gradlew.bat :instrumentation:jedis:jedis-4.0:javaagent:muzzle -PtestLatestDeps=true

Jedis 4 stable semconv tests expected db.namespace on spans and metrics from the default connection, but stable Redis telemetry only emits db.namespace when the Jedis client is explicitly configured with a database index. Update the span assertions and duration metric expectation to match the emitted attributes. Validation: .\gradlew.bat :instrumentation:jedis:jedis-4.0:javaagent:testStableSemconv .\gradlew.bat :instrumentation:jedis:jedis-4.0:javaagent:testStableSemconv -PtestLatestDeps=true

Copilot

Pull request overview

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

…space # Conflicts: # instrumentation/jedis/jedis-1.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/v1_4/JedisSingletons.java # instrumentation/jedis/jedis-3.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/v3_0/JedisSingletons.java # instrumentation/jedis/jedis-4.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/v4_0/JedisSingletons.java

laurit · 2026-06-10T11:29:29Z

        Instrumenter.<JedisRequest, Void>builder(
                GlobalOpenTelemetry.get(),
                INSTRUMENTATION_NAME,
-                DbClientSpanNameExtractor.create(dbAttributesGetter))


not really necessary since namespace is not implemented

opentelemetry-java-instrumentation/instrumentation/jedis/jedis-1.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jedis/v1_4/JedisDbAttributesGetter.java

Lines 28 to 30 in be68ff0

public String getDbNamespace(JedisRequest request) {

return null;

}

laurit · 2026-06-10T11:35:55Z

                GlobalOpenTelemetry.get(),
                INSTRUMENTATION_NAME,
-                DbClientSpanNameExtractor.create(dbAttributesGetter))
+                request -> spanName(dbAttributesGetter, request))


wondering maybe it would be better to use something like

JedisDbAttributesGetter spanNameAttributesGetter = new JedisDbAttributesGetter() { @Override @Nullable public String getDbNamespace(JedisRequest request) { return null; } }; ... DbClientSpanNameExtractor.create(spanNameAttributesGetter))

so that the whole name logic wouldn't need to be reimplemented.

Copilot

Pull request overview

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

Update Jedis to stable database semconv

7585199

trask requested a review from Copilot May 20, 2026 03:28

Copilot started reviewing on behalf of trask May 20, 2026 03:29 View session

Copilot AI reviewed May 20, 2026

View reviewed changes

github-actions Bot mentioned this pull request May 20, 2026

Pull Request Dashboard #18435

Open

trask added 4 commits June 6, 2026 12:07

Address review comment: rename Jedis connection field

a64001a

Address review comment: narrow Jedis connection accessor

74b5a04

Address review comment: avoid retaining Jedis connection

d02666a

Address review comment: clarify Jedis select test

45b50ba

trask requested a review from Copilot June 6, 2026 19:16

Copilot started reviewing on behalf of trask June 6, 2026 19:16 View session

Copilot AI reviewed Jun 6, 2026

View reviewed changes

trask added 3 commits June 6, 2026 12:34

comment

9357ed0

Remove Jedis database index fallback

829e1ef

Make Jedis connection database index nullable

715c209

trask requested a review from Copilot June 6, 2026 20:31

Copilot started reviewing on behalf of trask June 6, 2026 20:31 View session

Copilot AI reviewed Jun 6, 2026

View reviewed changes

trask added 3 commits June 6, 2026 14:21

Restore Jedis default database namespace

ff2eb30

trask requested a review from Copilot June 8, 2026 04:11

Copilot started reviewing on behalf of trask June 8, 2026 04:12 View session

Copilot AI reviewed Jun 8, 2026

View reviewed changes

trask marked this pull request as ready for review June 8, 2026 04:27

trask requested a review from a team as a code owner June 8, 2026 04:27

trask added 2 commits June 9, 2026 18:09

Run spotless

0583252

laurit reviewed Jun 10, 2026

View reviewed changes

laurit approved these changes Jun 10, 2026

View reviewed changes

trask added 2 commits June 10, 2026 06:11

Address review comment: reuse Jedis span name extractor

c8afec1

Address review comment: reuse Jedis 4 span name logic

293038f

trask requested a review from Copilot June 10, 2026 13:24

Copilot started reviewing on behalf of trask June 10, 2026 13:25 View session

Copilot AI reviewed Jun 10, 2026

View reviewed changes

trask enabled auto-merge (squash) June 10, 2026 13:58

trask merged commit 724f581 into main Jun 10, 2026
182 of 186 checks passed

trask deleted the trask/jedis-db-namespace branch June 10, 2026 14:10

trask mentioned this pull request Jun 12, 2026

Database semantic convention stability implementation tracking issue #12608

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update Jedis to stable database semconv#18808

Update Jedis to stable database semconv#18808
trask merged 15 commits into
mainfrom
trask/jedis-db-namespace

trask commented May 20, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

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!

laurit Jun 10, 2026

Uh oh!

trask Jun 10, 2026

Uh oh!

laurit Jun 10, 2026

Uh oh!

trask Jun 10, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	public String getDbNamespace(JedisRequest request) {
	return null;
	}

Uh oh!

Conversation

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

Uh oh!

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!

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!

laurit Jun 10, 2026

Choose a reason for hiding this comment

Uh oh!

trask Jun 10, 2026

Choose a reason for hiding this comment

Uh oh!

laurit Jun 10, 2026

Choose a reason for hiding this comment

Uh oh!

trask Jun 10, 2026

Choose a reason for hiding this comment

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 May 20, 2026 •

edited

Loading