Add support for `db.query.summary` in SqlClientAttributesExtractor by trask · Pull Request #15971 · open-telemetry/opentelemetry-java-instrumentation

trask · 2026-01-23T04:27:55Z

I've carefully broken out the commits to try to make review easier. I'm also happy to split the commits out into separate PRs.

Copy SqlSanitizer.jflex to SqlSanitizerWithSummary.jflex
Initial implementation of SQL summary
- Under stable semconv flag, adds support in SqlClientAttributesExtractor for db.query.summary and removes db.operation.name and db.collection.name where it was previously extracted from db.query.text to align with stable semconv. Hides this behavior behind marker interface so we can roll it out afterwards per instrumentation in smaller PRs.
Add paren tracking and improve JOIN table capture in SQL sanitizer
- Example: SELECT * FROM t1 LEFT JOIN t2 ON t1.id = t2.id JOIN t3 ON t2.x = t3.x
- Summary was: SELECT t1 t2
- Summary now: SELECT t1 t2 t3
Improve implicit join tracking with paren level awareness
- Example: select col from (select * from anotherTable)
- Summary was: SELECT SELECT
- Summary now: SELECT SELECT anotherTable
Capture tables from embedded SELECT in DML and DDL statements
- Example: INSERT INTO t1 SELECT * FROM t2
- Summary was: INSERT t1
- Summary now: INSERT t1 SELECT t2
Capture inner table names from subqueries in FROM clause
- Example: SELECT * FROM (SELECT * FROM inner1 JOIN inner2 ON inner1.id = inner2.id) AS sub
- Summary was: SELECT SELECT inner1 inner2 AS
- Summary now: SELECT SELECT inner1 inner2
Skip column alias lists in derived table definitions
- Example: SELECT * FROM (VALUES (1,2), (3,4)) AS t(a, b)
- Summary was: SELECT AS
- Summary now: SELECT
Add SQL Server CROSS APPLY / OUTER APPLY support
- Example: SELECT * FROM t1 CROSS APPLY t2
- Summary was: SELECT t1
- Summary now: SELECT t1 t2
Support multi-statement SQL with semicolon separators
- Example: SELECT * FROM t1; INSERT INTO t2 VALUES (1)
- Summary was: SELECT t1 INSERT t2
- Summary now: SELECT t1; INSERT t2
Add standalone VALUES clause support
- Example: VALUES (1, 'a'), (2, 'b')
- Summary was: null
- Summary now: VALUES
Add EXECUTE/EXEC stored procedure support
- Example: EXEC my_procedure @param=1
- Summary was: null
- Summary now: EXEC my_procedure
Add SQL Server bracket-quoted identifier support
- Example: SELECT * FROM [my table]
- Summary was: SELECT
- Summary now: SELECT [my table]
Fix MySQL escaped backtick handling in identifiers
- Example: SELECT * FROM `my``table`
- Summary was: SELECT `my`
- Summary now: SELECT `my``table`

Example: SELECT * FROM t1 LEFT JOIN t2 ON t1.id = t2.id JOIN t3 ON t2.x = t3.x Summary was: SELECT t1 t2 Summary now: SELECT t1 t2 t3

Example: select col from (select * from anotherTable) Summary was: SELECT SELECT Summary now: SELECT SELECT anotherTable

Example: INSERT INTO t1 SELECT * FROM t2 Summary was: INSERT t1 Summary now: INSERT t1 SELECT t2

Example: SELECT * FROM (SELECT * FROM inner1 JOIN inner2 ON inner1.id = inner2.id) AS sub Summary was: SELECT SELECT inner1 inner2 AS Summary now: SELECT SELECT inner1 inner2

Example: SELECT * FROM (VALUES (1,2), (3,4)) AS t(a, b) Summary was: SELECT AS Summary now: SELECT

Example: SELECT * FROM t1 CROSS APPLY t2 Summary was: SELECT t1 Summary now: SELECT t1 t2

Example: SELECT * FROM t1; INSERT INTO t2 VALUES (1) Summary was: SELECT t1 INSERT t2 Summary now: SELECT t1; INSERT t2

Example: VALUES (1, 'a'), (2, 'b') Summary was: null Summary now: VALUES

@param

Example: EXEC my_procedure @param=1 Summary was: null Summary now: EXEC my_procedure

Example: SELECT * FROM [my table] Summary was: SELECT Summary now: SELECT [my table]

Example: SELECT * FROM `my``table` Summary was: SELECT `my` Summary now: SELECT `my``table`

laurit · 2026-01-23T12:43:04Z

 HEX_NUM              = "0x" ([a-f] | [A-F] | [0-9])+
 QUOTED_STR           = "'" ("''" | [^'])* "'"
 DOUBLE_QUOTED_STR    = "\"" ("\"\"" | [^\"])* "\""
 DOLLAR_QUOTED_STR    = "$$" [^$]* "$$"


FYI it is also possible to use$tag$<string_constant>$tag$ instead of just $$ https://neon.com/postgresql/postgresql-plpgsql/dollar-quoted-string-constants

I'll follow up on it after this PR (even if only to document current state via tests)

laurit · 2026-01-23T12:47:50Z

+      String doubleQuote = quote + quote;
+      String withoutEscapedQuotes = s.replace(doubleQuote, "");
+      if (!withoutEscapedQuotes.contains(quote)) {
        return s;


should is return s.replace(doubleQuote, quote);?

oops, didn't intend to update this file, reverted in aca9248

laurit · 2026-01-23T13:22:10Z

+      if (!identifierCaptured) {
+        appendTargetToSummary();
+        identifierCaptured = true;
+        // Only set storedProcedureName if this is a real procedure call (not "call next value for sequence")


Perhaps we should add a comment that hibernate uses this query on hsqldb (we have a test that has this query there). Looking at hibernate sources it seems the same query is also used on h2, most of the other databases use a select for this.
Looks like it might be possible for it to also use call current value for sequence. Idk whether or when it is used. I think we can deal with this in complaint driven way if this really is an issue for someone.

laurit · 2026-01-23T13:48:04Z

+      assertThat(result.getQuerySummary()).isEqualTo(expected.getQuerySummary());
+    } else {
+      assertThat(result.getOperationName()).isEqualTo(expected.getOperationName());
+      assertThat(result.getCollectionName()).isEqualToIgnoringCase(expected.getCollectionName());


A bit surprised to see case insensitive comparison for collection name and proc name. Since we should preserve the case for these would have expected just isEqualTo here.

laurit · 2026-01-23T14:01:12Z

+
+        // MySQL escaped backticks
+        Arguments.of(
+            "SELECT * FROM `my``table`", expect("SELECT", "my``table", "SELECT `my``table`")),


"my``table" should probably be "my`table"

collection name got changed back now to just my (which of course is even more wrong) when I reverted the inadvertent changes to the old jflex

not planning to fix the old jflex, but this points out a likely problem in new jflex with stored procedure name capture, will follow-up on that after this PR

trask added 12 commits January 22, 2026 20:15

Copy SqlSanitizer.jflex to SqlSanitizerWithSummary.jflex

6129435

Initial implementation of SQL summary

6ef0580

Add paren tracking and improve JOIN table capture in SQL sanitizer

0780335

Example: SELECT * FROM t1 LEFT JOIN t2 ON t1.id = t2.id JOIN t3 ON t2.x = t3.x Summary was: SELECT t1 t2 Summary now: SELECT t1 t2 t3

Improve implicit join tracking with paren level awareness

b07ef2c

Example: select col from (select * from anotherTable) Summary was: SELECT SELECT Summary now: SELECT SELECT anotherTable

Capture tables from embedded SELECT in DML and DDL statements

7bc8a6b

Example: INSERT INTO t1 SELECT * FROM t2 Summary was: INSERT t1 Summary now: INSERT t1 SELECT t2

Capture inner table names from subqueries in FROM clause

efa5e8a

Example: SELECT * FROM (SELECT * FROM inner1 JOIN inner2 ON inner1.id = inner2.id) AS sub Summary was: SELECT SELECT inner1 inner2 AS Summary now: SELECT SELECT inner1 inner2

Skip column alias lists in derived table definitions

63c6b59

Example: SELECT * FROM (VALUES (1,2), (3,4)) AS t(a, b) Summary was: SELECT AS Summary now: SELECT

Add SQL Server CROSS APPLY / OUTER APPLY support

4fc9c97

Example: SELECT * FROM t1 CROSS APPLY t2 Summary was: SELECT t1 Summary now: SELECT t1 t2

Support multi-statement SQL with semicolon separators

533de44

Example: SELECT * FROM t1; INSERT INTO t2 VALUES (1) Summary was: SELECT t1 INSERT t2 Summary now: SELECT t1; INSERT t2

Add standalone VALUES clause support

c2e7260

Example: VALUES (1, 'a'), (2, 'b') Summary was: null Summary now: VALUES

Add EXECUTE/EXEC stored procedure support

de9457d

Example: EXEC my_procedure @param=1 Summary was: null Summary now: EXEC my_procedure

Add SQL Server bracket-quoted identifier support

dfb3713

Example: SELECT * FROM [my table] Summary was: SELECT Summary now: SELECT [my table]

This was referenced Jan 23, 2026

Add support for db.query.summary in SqlClientAttributesExtractor #15896

Closed

Handle more stored procedure variants #15860

Closed

Implement db.query.summary for SqlClientAttributesExtractor #15548

Closed

Fix MySQL escaped backtick handling in identifiers

d39d233

Example: SELECT * FROM `my``table` Summary was: SELECT `my` Summary now: SELECT `my``table`

trask force-pushed the sql-summary branch from 115a0b7 to d39d233 Compare January 23, 2026 04:32

fixup! Initial implementation of SQL summary

a73d0b7

trask marked this pull request as ready for review January 23, 2026 05:47

trask requested a review from a team as a code owner January 23, 2026 05:47

Merge branch 'main' into sql-summary

8f12761

laurit reviewed Jan 23, 2026

View reviewed changes

laurit approved these changes Jan 23, 2026

View reviewed changes

trask added 3 commits January 23, 2026 09:52

Revert inadvertent change to SqlSanitizer.jflex

aca9248

Case sensitive assertions

8cae5e8

Remove duplicate call next value for sequence test

47cf1dd

Add comment about call next value for sequence

daecc11

trask merged commit 7b5426f into open-telemetry:main Jan 23, 2026
85 checks passed

trask deleted the sql-summary branch January 23, 2026 18:37

This was referenced Jan 24, 2026

Add test coverage for db.stored_procedure.name case preservation #15888

Closed

Database semantic convention stability implementation tracking issue #12608

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for `db.query.summary` in SqlClientAttributesExtractor#15971

Add support for `db.query.summary` in SqlClientAttributesExtractor#15971
trask merged 19 commits intoopen-telemetry:mainfrom
trask:sql-summary

trask commented Jan 23, 2026 •

edited

Loading

Uh oh!

laurit Jan 23, 2026

Uh oh!

trask Jan 23, 2026

Uh oh!

laurit Jan 23, 2026

Uh oh!

trask Jan 23, 2026

Uh oh!

laurit Jan 23, 2026

Uh oh!

trask Jan 23, 2026

Uh oh!

laurit Jan 23, 2026

Uh oh!

trask Jan 23, 2026

Uh oh!

laurit Jan 23, 2026

Uh oh!

trask Jan 23, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

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

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

trask commented Jan 23, 2026 •

edited

Loading