Skip to content

Do not prepend DBM <> APM trace comment in SQLCommenter if there is a pg plan hint #8864

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 22, 2025
Merged

Do not prepend DBM <> APM trace comment in SQLCommenter if there is a pg plan hint #8864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00ae9df
Append comment if there's a pg plan hint
edengorevoy May 21, 2025
e4c3c62
Another test for comment placement
edengorevoy May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions ...t/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,11 @@ public static String inject(
if (dbType != null) {
final String firstWord = getFirstWord(sql);

// The Postgres JDBC parser doesn't allow SQL comments anywhere in a JDBC callable statements
// The Postgres JDBC parser doesn't allow SQL comments anywhere in a JDBC
// callable statements
// https://github.com/pgjdbc/pgjdbc/blob/master/pgjdbc/src/main/java/org/postgresql/core/Parser.java#L1038
// TODO: Could we inject the comment after the JDBC has been converted to standard SQL?
// TODO: Could we inject the comment after the JDBC has been converted to
// standard SQL?
if (firstWord.startsWith("{") && dbType.startsWith("postgres")) {
return sql;
}
Expand All @@ -92,11 +94,17 @@ public static String inject(
appendComment = true;
}

// Both Postgres and MySQL are unhappy with anything before CALL in a stored procedure
// Both Postgres and MySQL are unhappy with anything before CALL in a stored
// procedure
// invocation but they seem ok with it after so we force append mode
if (firstWord.equalsIgnoreCase("call")) {
appendComment = true;
}

// Append the comment in the case of a pg_hint_plan extension
if (dbType.startsWith("postgres") && containsPgHint(sql)) {
Copy link
Contributor

@amarziali amarziali May 22, 2025

Choose a reason for hiding this comment

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

is the extension applying systematically that to all the queries? in this case that info can be pinned to the dbInfo once

Copy link
Contributor Author

@edengorevoy edengorevoy May 22, 2025

Choose a reason for hiding this comment

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

The comments are user annotations, it doesn't apply to all queries. The extension will just parse the user's annotation and will miss it if the tracer comment is prepended.

appendComment = true;
}
}

AgentSpan currSpan = activeSpan();
Expand Down Expand Up @@ -295,4 +303,10 @@ private static int computeInitialCapacity() {
+ CLOSE_COMMENT.length(); // two quotes, one equals & one comma * 5 + \* */
return tagKeysLen + extraCharsLen;
}

// pg_hint_plan extension works by checking the first block comment
// we'll have to append the traced comment if there is a pghint
private static boolean containsPgHint(String sql) {
return sql.indexOf("/*+") > 0;
}
}
2 changes: 2 additions & 0 deletions dd-java-agent/instrumentation/jdbc/src/test/groovy/SQLCommenterTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ class SQLCommenterTest extends AgentTestRunner {
"/*traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-01'*/ SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "mysql" | "h" | "n" | "TestVersion" | false | false | null | "/*traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-01'*/ SELECT * FROM foo"
"/*customer-comment*/ SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "mysql" | "h" | "n" | "TestVersion" | false | false | null | "/*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',dde='Test',ddpv='TestVersion'*/ /*customer-comment*/ SELECT * FROM foo"
"/*traceparent" | "SqlCommenter" | "Test" | "my-service" | "mysql" | "h" | "n" | "TestVersion" | false | false | null | "/*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',dde='Test',ddpv='TestVersion'*/ /*traceparent"
"SELECT /*+ SeqScan(foo) */ * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "postgres" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "SELECT /*+ SeqScan(foo) */ * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
"/*+ SeqScan(foo) */ SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "postgres" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "/*+ SeqScan(foo) */ SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
}

def "test encode Sql Comment with peer service"() {
Expand Down