Preserve SQL query summary operation case by trask · Pull Request #18930 · open-telemetry/opentelemetry-java-instrumentation

trask · 2026-06-07T05:33:01Z

Preserve the original case of SQL operation keywords when building stable query summaries. This switches matched operation tokens to use the lexer text consistently, including nested SELECTs and top-level VALUES, and adds coverage across supported summary operations.

Copilot

Pull request overview

This PR updates the SQL query summary lexer to preserve the original case of operation keywords (e.g., select vs SELECT) when building stable query summaries, and expands test coverage to validate case preservation across supported summary operations and nested SELECT scenarios.

Changes:

Switched query-summary operation tokens to use the lexer’s matched text (yytext()) instead of hard-coded uppercase keywords.
Updated nested/embedded SELECT handling to propagate the matched operation text through handleSelect(...).
Added/updated tests to assert query summaries preserve the input operation keyword case across many operations (including nested SELECTs and top-level VALUES).

Reviewed changes

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

File	Description
instrumentation-api-incubator/src/main/jflex/SqlSanitizerWithSummary.jflex	Uses matched lexer text for operation keywords and threads original `SELECT` token text through operation handling to preserve case in summaries.
instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/SqlQueryAnalyzerTest.java	Adds a parameterized test for operation-case preservation and updates existing summary expectations to reflect case-preserving behavior.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

SQL query summaries now preserve the operation casing from the original statement. Stable database semconv tests were still expecting canonical uppercase summaries and span names for lowercase generated SQL, causing the CI failures. Update the affected Camel, Hibernate, and Vert.x expectations to match the preserved case while leaving uppercase native SQL expectations unchanged. Validation: .\gradlew.bat :instrumentation-api-incubator:test --tests io.opentelemetry.instrumentation.api.incubator.semconv.db.SqlQueryAnalyzerTest --tests io.opentelemetry.instrumentation.api.incubator.semconv.db.SqlQuerySummaryEdgeCasesTest; .\gradlew.bat :instrumentation:hibernate:hibernate-6.0:javaagent:hibernate6TestStableSemconv; .\gradlew.bat :instrumentation:camel-2.20:javaagent-unit-tests:testStableSemconv :instrumentation:camel-2.20:javaagent:testStableSemconv :instrumentation:hibernate:hibernate-6.0:javaagent:hibernate6TestStableSemconv :instrumentation:hibernate:hibernate-6.0:spring-testing:testStableSemconv :instrumentation:hibernate:hibernate-reactive-1.0:javaagent:hibernateReactive1TestStableSemconv :instrumentation:vertx:vertx-sql-client:vertx-sql-client-4.0:javaagent:testStableSemconv; .\gradlew.bat spotlessCheck

…ary-case

Copilot

Pull request overview

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

Stable database semantic convention query summaries are emitted with lowercase SQL operation names by the updated SQL analyzer. Several Hibernate, ClickHouse, and Spring Data tests still expected uppercase stable span names or db.query.summary values, causing the CI testStableSemconv jobs to fail. Update the affected expectations to match the emitted stable semconv values while preserving legacy-mode expectations. Validation: ./gradlew.bat :instrumentation:hibernate:hibernate-6.0:javaagent:test --tests io.opentelemetry.javaagent.instrumentation.hibernate.v6_0.CriteriaTest --tests io.opentelemetry.javaagent.instrumentation.hibernate.v6_0.EntityManagerTest.testNoResultExceptionIgnored ./gradlew.bat :instrumentation:hibernate:hibernate-6.0:javaagent:testStableSemconv --tests io.opentelemetry.javaagent.instrumentation.hibernate.v6_0.CriteriaTest --tests io.opentelemetry.javaagent.instrumentation.hibernate.v6_0.EntityManagerTest.testNoResultExceptionIgnored ./gradlew.bat :instrumentation:hibernate:hibernate-6.0:spring-testing:test --tests spring.jpa.SpringJpaTest ./gradlew.bat :instrumentation:hibernate:hibernate-4.0:javaagent:testStableSemconv --tests io.opentelemetry.javaagent.instrumentation.hibernate.v4_0.CriteriaTest --tests io.opentelemetry.javaagent.instrumentation.hibernate.v4_0.EntityManagerTest.testNoResultExceptionIgnored --tests io.opentelemetry.javaagent.instrumentation.hibernate.v4_0.QueryTest.testHibernateQuerySingleCall ./gradlew.bat :instrumentation:hibernate:hibernate-3.3:javaagent:testStableSemconv --tests io.opentelemetry.javaagent.instrumentation.hibernate.v3_3.QueryTest ./gradlew.bat :instrumentation:clickhouse:clickhouse-client-v2-0.8:javaagent:testStableSemconv --tests io.opentelemetry.javaagent.instrumentation.clickhouse.clientv2.v0_8.ClickHouseClientV2Test ./gradlew.bat :instrumentation:spring:spring-data:spring-data-1.8:javaagent:testStableSemconv

Stable database semconv lowercases generated HQL/ORM query summaries and span names, while native SQL keeps its SQL operation casing. The Hibernate tests mixed those expectations, causing stable-semconv and latest-deps CI failures after the PR changed the expected assertions. Update the affected Hibernate 4 and 6 tests to expect lowercase generated query names and preserve uppercase native SQL names, and run Spotless for the logged formatting issue. Validation: .\gradlew.bat :instrumentation:hibernate:hibernate-4.0:javaagent:testStableSemconv :instrumentation:hibernate:hibernate-6.0:javaagent:testStableSemconv .\gradlew.bat :instrumentation:hibernate:hibernate-4.0:javaagent:testStableSemconv :instrumentation:hibernate:hibernate-6.0:javaagent:testStableSemconv -PtestLatestDeps=true .\gradlew.bat :instrumentation:hibernate:hibernate-3.3:javaagent:spotlessCheck :instrumentation:hibernate:hibernate-4.0:javaagent:spotlessCheck :instrumentation:hibernate:hibernate-6.0:javaagent:spotlessCheck

The Hibernate 6 and 7 SessionTest query-state assertions always expected stable-semconv lowercase HQL span names, but the failing CI jobs run legacy database semconv mode where the instrumentation emits uppercase SELECT names. The tests now derive the expected query span name from the active semconv mode. Validation: .\gradlew.bat :instrumentation:hibernate:hibernate-6.0:javaagent:hibernate6Test :instrumentation:hibernate:hibernate-6.0:javaagent:hibernate7Test --tests *SessionTest .\gradlew.bat :instrumentation:hibernate:hibernate-6.0:javaagent:hibernate7Test --tests *SessionTest -PtestLatestDeps=true Co-authored-by: Copilot <[email protected]>

trask · 2026-06-08T22:56:31Z


        // hibernate/jpa query language
-        Arguments.of("FROM TABLE WHERE FIELD=1234", "FROM TABLE WHERE FIELD=?", "SELECT TABLE"));
+        Arguments.of("from TABLE WHERE FIELD=1234", "from TABLE WHERE FIELD=?", "select TABLE"));


changing FROM to from isn't relevant, but it does match what's seen from hibernate, so seems more realistic example data

Copilot

Pull request overview

Copilot reviewed 30 out of 30 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

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

Preserve SQL query summary operation case

6c3c86c

trask requested a review from a team as a code owner June 7, 2026 05:33

Copilot AI review requested due to automatic review settings June 7, 2026 05:33

Copilot started reviewing on behalf of trask June 7, 2026 05:33 View session

trask marked this pull request as draft June 7, 2026 05:34

This was referenced Jun 7, 2026

Emit stable Cassandra operation and collection attributes #18922

Merged

Fix DDL target case handling for password sanitization #18927

Merged

Copilot AI reviewed Jun 7, 2026

View reviewed changes

github-actions Bot mentioned this pull request Jun 7, 2026

Pull Request Dashboard #18435

Open

fix

61a9870

trask force-pushed the fix-stable-sql-summary-case branch from d549bc9 to 61a9870 Compare June 8, 2026 02:50

trask requested a review from Copilot June 8, 2026 03:02

Copilot started reviewing on behalf of trask June 8, 2026 03:02 View session

Copilot AI reviewed Jun 8, 2026

View reviewed changes

Comment thread instrumentation-api-incubator/src/main/jflex/SqlSanitizerWithSummary.jflex

trask requested a review from Copilot June 8, 2026 03:16

Copilot started reviewing on behalf of trask June 8, 2026 03:16 View session

Copilot AI reviewed Jun 8, 2026

View reviewed changes

Comment thread instrumentation-api-incubator/src/main/jflex/SqlSanitizerWithSummary.jflex

Avoid yytext allocation in SQL summary

d857c00

trask force-pushed the fix-stable-sql-summary-case branch from 5dc9919 to d857c00 Compare June 8, 2026 03:24

trask requested a review from Copilot June 8, 2026 03:25

Copilot started reviewing on behalf of trask June 8, 2026 03:25 View session

Copilot AI reviewed Jun 8, 2026

View reviewed changes

Comment thread ...est/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/SqlQueryAnalyzerTest.java

trask added 3 commits June 7, 2026 21:30

Gate SQL summary case test by stable semconv

3634baf

Merge remote-tracking branch 'upstream/main' into fix-stable-sql-summ…

499a71b

…ary-case

trask requested a review from Copilot June 8, 2026 15:23

Copilot started reviewing on behalf of trask June 8, 2026 15:24 View session

Copilot AI reviewed Jun 8, 2026

View reviewed changes

trask added 2 commits June 8, 2026 10:11

trask and others added 2 commits June 8, 2026 12:28

Fix stable SQL summary casing

01e5cc2

trask commented Jun 8, 2026

View reviewed changes

trask added 6 commits June 8, 2026 16:10

Simplify Hibernate 6 semconv expectations

839127c

Pass semconv-specific Hibernate verbs

87872b1

Clean up Hibernate 6 query expectations

836b60f

Clean up Hibernate 6 query expectations

a99c39a

Inline Hibernate entity span name expectation

c632304

spotless

b795c64

trask requested a review from Copilot June 9, 2026 00:51

Copilot started reviewing on behalf of trask June 9, 2026 00:51 View session

Copilot AI reviewed Jun 9, 2026

View reviewed changes

Comment thread instrumentation-api-incubator/src/main/jflex/SqlSanitizerWithSummary.jflex

Derive synthetic select case from FROM

4a6446b

trask requested a review from Copilot June 9, 2026 02:13

Copilot started reviewing on behalf of trask June 9, 2026 02:13 View session

Copilot AI reviewed Jun 9, 2026

View reviewed changes

trask marked this pull request as ready for review June 9, 2026 02:51

laurit approved these changes Jun 9, 2026

View reviewed changes

laurit merged commit ad5dcc3 into open-telemetry:main Jun 9, 2026
95 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Preserve SQL query summary operation case#18930

Preserve SQL query summary operation case#18930
laurit merged 17 commits into
open-telemetry:mainfrom
trask:fix-stable-sql-summary-case

trask commented Jun 7, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

trask Jun 8, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

trask commented Jun 7, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

trask Jun 8, 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!

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