Skip to content

feat: add SQLCommenter custom fields API with thread-local context#1

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

Draft
cgati wants to merge 5 commits into
base:master
Choose a base branch
from
Draft

feat: add SQLCommenter custom fields API with thread-local context #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d6c47f2
feat: add SQLCommenter custom fields API with thread-local context
cgati Jul 17, 2025
b721eee
Remove reference to Kotlin code example
cgati Jul 18, 2025
d8a3837
Fix html-encoded comment
cgati Jul 18, 2025
75d5761
simplify capacity calculation
cgati Jul 18, 2025
5ca884f
simplify the api to getting and setting the context map
cgati Jul 18, 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
37 changes: 32 additions & 5 deletions ...t/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenter.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand DownExpand Up@@ -117,7 +118,9 @@ public static String inject(
final String parentService = config.getServiceName();
final String env = config.getEnv();
final String version = config.getVersion();
final int commentSize = capacity(traceParent, parentService, dbService, env, version);
final Map<String, String> customFields = SQLCommenterContext.getCopyOfContextMap();
final int commentSize =
capacity(traceParent, parentService, dbService, env, version, customFields);
StringBuilder sb = new StringBuilder(sql.length() + commentSize);
boolean commentAdded = false;
String peerService = peerServiceObj != null ? peerServiceObj.toString() : null;
Expand All@@ -137,7 +140,8 @@ public static String inject(
peerService,
env,
version,
traceParent);
traceParent,
customFields);
sb.append(CLOSE_COMMENT);
} else {
sb.append(OPEN_COMMENT);
Expand All@@ -152,7 +156,8 @@ public static String inject(
peerService,
env,
version,
traceParent);
traceParent,
customFields);

sb.append(CLOSE_COMMENT);
sb.append(SPACE);
Expand DownExpand Up@@ -226,7 +231,8 @@ protected static boolean toComment(
final String peerService,
final String env,
final String version,
final String traceparent) {
final String traceparent,
final Map<String, String> customFields) {
int emptySize = sb.length();

append(sb, PARENT_SERVICE, parentService, false);
Expand All@@ -241,6 +247,14 @@ protected static boolean toComment(
if (injectTrace) {
append(sb, TRACEPARENT, traceparent, sb.length() > emptySize);
}

// Add custom fields from SQLCommenterContext
if (customFields != null) {
for (Map.Entry<String, String> entry : customFields.entrySet()) {
append(sb, encode(entry.getKey()), entry.getValue(), sb.length() > emptySize);
}
}

return sb.length() > emptySize;
}

Expand DownExpand Up@@ -268,7 +282,8 @@ private static int capacity(
final String parentService,
final String dbService,
final String env,
final String version) {
final String version,
final Map<String, String> customFields) {
int len = INITIAL_CAPACITY;
if (null != traceparent) {
len += traceparent.length();
Expand All@@ -285,6 +300,18 @@ private static int capacity(
if (null != version) {
len += version.length();
}

// Add capacity for custom fields
if (customFields != null) {
for (Map.Entry<String, String> entry : customFields.entrySet()) {
if (entry.getKey() != null && entry.getValue() != null) {
len += entry.getKey().length();
len += entry.getValue().length();
len += 4; // equals, comma, and two quotes
}
}
}

return len;
}

Expand Down
43 changes: 43 additions & 0 deletions ...umentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenterContext.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
package datadog.trace.instrumentation.jdbc;

import java.util.HashMap;
import java.util.Map;

/**
* Thread-local context system for custom SQL comment fields. This class provides functionality
* similar to SLF4J's MDC but specifically for SQL comment injection. External users can add custom
* key-value pairs that will be included in SQL comments.
*/
public class SQLCommenterContext {

private static final ThreadLocal<Map<String, String>> contextHolder =
new ThreadLocal<Map<String, String>>() {
@Override
protected Map<String, String> initialValue() {
return new HashMap<>();
}
};

/**
* Gets a copy of the current context map.
*
* @return a copy of the current context map, or null if no context is set
*/
public static Map<String, String> getCopyOfContextMap() {
Map<String, String> contextMap = contextHolder.get();
return contextMap.isEmpty() ? null : new HashMap<>(contextMap);
}

/**
* Sets the context map for the current thread.
*
* @param contextMap the new context map to set
*/
public static void setContextMap(Map<String, String> contextMap) {
if (contextMap == null) {
contextHolder.remove();
} else {
contextHolder.set(new HashMap<>(contextMap));
}
}
}
6 changes: 5 additions & 1 deletion ...ation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/StatementInstrumentation.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,11 @@ public Map<String, String> contextStore() {

@Override
public String[] helperClassNames() {
return new String[] {packageName + ".JDBCDecorator", packageName + ".SQLCommenter"};
return new String[] {
packageName + ".JDBCDecorator",
packageName + ".SQLCommenter",
packageName + ".SQLCommenterContext"
};
}

// prepend mode will prepend the SQL comment to the raw sql query
Expand Down
182 changes: 182 additions & 0 deletions dd-java-agent/instrumentation/jdbc/src/test/groovy/SQLCommenterTest.groovy
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import datadog.trace.bootstrap.instrumentation.api.AgentTracer
import datadog.trace.bootstrap.instrumentation.api.Tags

import datadog.trace.instrumentation.jdbc.SQLCommenter
import datadog.trace.instrumentation.jdbc.SQLCommenterContext

import static datadog.trace.agent.test.utils.TraceUtils.runUnderTrace

Expand DownExpand Up@@ -145,4 +146,185 @@ class SQLCommenterTest extends AgentTestRunner {
"SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "mysql" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
"SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "postgres" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
}

def "test SQL comment injection with custom fields"() {
setup:
injectSysConfig("dd.service", "SqlCommenter")
injectSysConfig("dd.env", "Test")
injectSysConfig("dd.version", "TestVersion")

when:
String sqlWithComment = ""

// Set up custom fields in context
SQLCommenterContext.put("tenant_id", "abc123")
SQLCommenterContext.put("request_id", "req-456")
SQLCommenterContext.put("user_id", 789)

sqlWithComment = SQLCommenter.inject(
"SELECT * FROM foo",
"my-service",
"mysql",
"h",
"n",
"00-00000000000000007fffffffffffffff-000000024cb016ea-00",
true,
true
)

SQLCommenterContext.clear()

then:
// Should contain all standard fields plus custom fields
sqlWithComment.contains("ddps='SqlCommenter'")
sqlWithComment.contains("dddbs='my-service'")
sqlWithComment.contains("ddh='h'")
sqlWithComment.contains("dddb='n'")
sqlWithComment.contains("dde='Test'")
sqlWithComment.contains("ddpv='TestVersion'")
sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
sqlWithComment.contains("tenant_id='abc123'")
sqlWithComment.contains("request_id='req-456'")
sqlWithComment.contains("user_id='789'")
sqlWithComment.startsWith("SELECT * FROM foo /*")
sqlWithComment.endsWith("*/")
}

def "test SQL comment injection with custom fields using withSQLCommentFields"() {
setup:
injectSysConfig("dd.service", "SqlCommenter")
injectSysConfig("dd.env", "Test")
injectSysConfig("dd.version", "TestVersion")

when:
String sqlWithComment = SQLCommenterContext.withSQLCommentFields(
["tenant_id": "abc123", "request_id": "req-456"], {
return SQLCommenter.inject(
"SELECT * FROM foo",
"my-service",
"mysql",
"h",
"n",
"00-00000000000000007fffffffffffffff-000000024cb016ea-00",
true,
true
)
}
)

then:
// Should contain all standard fields plus custom fields
sqlWithComment.contains("ddps='SqlCommenter'")
sqlWithComment.contains("dddbs='my-service'")
sqlWithComment.contains("tenant_id='abc123'")
sqlWithComment.contains("request_id='req-456'")
sqlWithComment.startsWith("SELECT * FROM foo /*")
sqlWithComment.endsWith("*/")

// Context should be cleared after the block
SQLCommenterContext.isEmpty()
}

def "test SQL comment injection with empty custom fields"() {
setup:
injectSysConfig("dd.service", "SqlCommenter")
injectSysConfig("dd.env", "Test")
injectSysConfig("dd.version", "TestVersion")

when:
String sqlWithComment = SQLCommenter.inject(
"SELECT * FROM foo",
"my-service",
"mysql",
"h",
"n",
"00-00000000000000007fffffffffffffff-000000024cb016ea-00",
true,
true
)

then:
// Should contain only standard fields
sqlWithComment.contains("ddps='SqlCommenter'")
sqlWithComment.contains("dddbs='my-service'")
sqlWithComment.contains("ddh='h'")
sqlWithComment.contains("dddb='n'")
sqlWithComment.contains("dde='Test'")
sqlWithComment.contains("ddpv='TestVersion'")
sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
sqlWithComment.startsWith("SELECT * FROM foo /*")
sqlWithComment.endsWith("*/")
}

def "test SQL comment injection with custom fields containing special characters"() {
setup:
injectSysConfig("dd.service", "SqlCommenter")
injectSysConfig("dd.env", "Test")
injectSysConfig("dd.version", "TestVersion")

when:
String sqlWithComment = ""

// Set up custom fields with special characters that need URL encoding
SQLCommenterContext.put("special_key", "value with spaces")
SQLCommenterContext.put("unicode_key", "value_with_émojis_🎉")
SQLCommenterContext.put("symbols_key", "value&with=symbols")

sqlWithComment = SQLCommenter.inject(
"SELECT * FROM foo",
"my-service",
"mysql",
"h",
"n",
null,
false,
true
)

SQLCommenterContext.clear()

then:
// Should contain URL-encoded custom fields (URLEncoder uses + for spaces)
sqlWithComment.contains("special_key='value+with+spaces'")
sqlWithComment.contains("unicode_key=") // Should be URL encoded
sqlWithComment.contains("symbols_key='value%26with%3Dsymbols'")
sqlWithComment.startsWith("SELECT * FROM foo /*")
sqlWithComment.endsWith("*/")
}

def "test SQL comment injection with null and empty custom field values"() {
setup:
injectSysConfig("dd.service", "SqlCommenter")
injectSysConfig("dd.env", "Test")
injectSysConfig("dd.version", "TestVersion")

when:
String sqlWithComment = ""

// Set up custom fields with null and empty values
SQLCommenterContext.put("null_key", null)
SQLCommenterContext.put("empty_key", "")
SQLCommenterContext.put("valid_key", "valid_value")

sqlWithComment = SQLCommenter.inject(
"SELECT * FROM foo",
"my-service",
"mysql",
"h",
"n",
null,
false,
true
)

SQLCommenterContext.clear()

then:
// Should not contain null or empty fields, but should contain valid field
!sqlWithComment.contains("null_key")
!sqlWithComment.contains("empty_key")
sqlWithComment.contains("valid_key='valid_value'")
sqlWithComment.startsWith("SELECT * FROM foo /*")
sqlWithComment.endsWith("*/")
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat: add SQLCommenter custom fields API with thread-local context by cgati · Pull Request #1 · mdg-private/dd-trace-java · GitHub
Skip to content
feat: add SQLCommenter custom fields API with thread-local context#1

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

 Draft

cgati
wants to merge
5
commits into

base:master
Choose a base branch

from

 Draft


feat: add SQLCommenter custom fields API with thread-local context
#1
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d6c47f2

feat: add SQLCommenter custom fields API with thread-local context


cgati Jul 17, 2025
b721eee

Remove reference to Kotlin code example


cgati Jul 18, 2025
d8a3837

Fix html-encoded comment


cgati Jul 18, 2025
75d5761

simplify capacity calculation


cgati Jul 18, 2025
5ca884f

simplify the api to getting and setting the context map


cgati Jul 18, 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


37 changes: 32 additions & 5 deletions
...t/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand DownExpand Up@@ -117,7 +118,9 @@ public static String inject(
 final String parentService = config.getServiceName();
 final String env = config.getEnv();
 final String version = config.getVersion();
 final int commentSize = capacity(traceParent, parentService, dbService, env, version);
 final Map<String, String> customFields = SQLCommenterContext.getCopyOfContextMap();
 final int commentSize =
 capacity(traceParent, parentService, dbService, env, version, customFields);
 StringBuilder sb = new StringBuilder(sql.length() + commentSize);
 boolean commentAdded = false;
 String peerService = peerServiceObj != null ? peerServiceObj.toString() : null;
Expand All@@ -137,7 +140,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);
 sb.append(CLOSE_COMMENT);
 } else {
 sb.append(OPEN_COMMENT);
Expand All@@ -152,7 +156,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);

 sb.append(CLOSE_COMMENT);
 sb.append(SPACE);
Expand DownExpand Up@@ -226,7 +231,8 @@ protected static boolean toComment(
 final String peerService,
 final String env,
 final String version,
 final String traceparent) {
 final String traceparent,
 final Map<String, String> customFields) {
 int emptySize = sb.length();

 append(sb, PARENT_SERVICE, parentService, false);
Expand All@@ -241,6 +247,14 @@ protected static boolean toComment(
 if (injectTrace) {
 append(sb, TRACEPARENT, traceparent, sb.length() > emptySize);
 }

 // Add custom fields from SQLCommenterContext
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 append(sb, encode(entry.getKey()), entry.getValue(), sb.length() > emptySize);
 }
 }

 return sb.length() > emptySize;
 }

Expand DownExpand Up@@ -268,7 +282,8 @@ private static int capacity(
 final String parentService,
 final String dbService,
 final String env,
 final String version) {
 final String version,
 final Map<String, String> customFields) {
 int len = INITIAL_CAPACITY;
 if (null != traceparent) {
 len += traceparent.length();
Expand All@@ -285,6 +300,18 @@ private static int capacity(
 if (null != version) {
 len += version.length();
 }

 // Add capacity for custom fields
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 if (entry.getKey() != null && entry.getValue() != null) {
 len += entry.getKey().length();
 len += entry.getValue().length();
 len += 4; // equals, comma, and two quotes
 }
 }
 }

 return len;
 }

Expand Down

43 changes: 43 additions & 0 deletions
...umentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenterContext.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
package datadog.trace.instrumentation.jdbc;

import java.util.HashMap;
import java.util.Map;

/**
 * Thread-local context system for custom SQL comment fields. This class provides functionality
 * similar to SLF4J's MDC but specifically for SQL comment injection. External users can add custom
 * key-value pairs that will be included in SQL comments.
 */
public class SQLCommenterContext {

 private static final ThreadLocal<Map<String, String>> contextHolder =
 new ThreadLocal<Map<String, String>>() {
 @Override
 protected Map<String, String> initialValue() {
 return new HashMap<>();
 }
 };

 /**
 * Gets a copy of the current context map.
 *
 * @return a copy of the current context map, or null if no context is set
 */
 public static Map<String, String> getCopyOfContextMap() {
 Map<String, String> contextMap = contextHolder.get();
 return contextMap.isEmpty() ? null : new HashMap<>(contextMap);
 }

 /**
 * Sets the context map for the current thread.
 *
 * @param contextMap the new context map to set
 */
 public static void setContextMap(Map<String, String> contextMap) {
 if (contextMap == null) {
 contextHolder.remove();
 } else {
 contextHolder.set(new HashMap<>(contextMap));
 }
 }
}

6 changes: 5 additions & 1 deletion
...ation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/StatementInstrumentation.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,11 @@ public Map<String, String> contextStore() {

 @Override
 public String[] helperClassNames() {
 return new String[] {packageName + ".JDBCDecorator", packageName + ".SQLCommenter"};
 return new String[] {
 packageName + ".JDBCDecorator",
 packageName + ".SQLCommenter",
 packageName + ".SQLCommenterContext"
 };
 }

 // prepend mode will prepend the SQL comment to the raw sql query
Expand Down

182 changes: 182 additions & 0 deletions
dd-java-agent/instrumentation/jdbc/src/test/groovy/SQLCommenterTest.groovy

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import datadog.trace.bootstrap.instrumentation.api.AgentTracer
import datadog.trace.bootstrap.instrumentation.api.Tags

import datadog.trace.instrumentation.jdbc.SQLCommenter
import datadog.trace.instrumentation.jdbc.SQLCommenterContext

import static datadog.trace.agent.test.utils.TraceUtils.runUnderTrace

Expand DownExpand Up@@ -145,4 +146,185 @@ class SQLCommenterTest extends AgentTestRunner {
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "mysql" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "postgres" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 }

 def "test SQL comment injection with custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields in context
 SQLCommenterContext.put("tenant_id", "abc123")
 SQLCommenterContext.put("request_id", "req-456")
 SQLCommenterContext.put("user_id", 789)

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.contains("user_id='789'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields using withSQLCommentFields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenterContext.withSQLCommentFields(
 ["tenant_id": "abc123", "request_id": "req-456"], {
 return SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )
 }
 )

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")

 // Context should be cleared after the block
 SQLCommenterContext.isEmpty()
 }

 def "test SQL comment injection with empty custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 then:
 // Should contain only standard fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields containing special characters"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with special characters that need URL encoding
 SQLCommenterContext.put("special_key", "value with spaces")
 SQLCommenterContext.put("unicode_key", "value_with_émojis_🎉")
 SQLCommenterContext.put("symbols_key", "value&with=symbols")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain URL-encoded custom fields (URLEncoder uses + for spaces)
 sqlWithComment.contains("special_key='value+with+spaces'")
 sqlWithComment.contains("unicode_key=") // Should be URL encoded
 sqlWithComment.contains("symbols_key='value%26with%3Dsymbols'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with null and empty custom field values"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with null and empty values
 SQLCommenterContext.put("null_key", null)
 SQLCommenterContext.put("empty_key", "")
 SQLCommenterContext.put("valid_key", "valid_value")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should not contain null or empty fields, but should contain valid field
 !sqlWithComment.contains("null_key")
 !sqlWithComment.contains("empty_key")
 sqlWithComment.contains("valid_key='valid_value'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: add SQLCommenter custom fields API with thread-local context by cgati · Pull Request #1 · mdg-private/dd-trace-java · GitHub
Skip to content
feat: add SQLCommenter custom fields API with thread-local context#1

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

 Draft

cgati
wants to merge
5
commits into

base:master
Choose a base branch

from

 Draft


feat: add SQLCommenter custom fields API with thread-local context
#1
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d6c47f2

feat: add SQLCommenter custom fields API with thread-local context


cgati Jul 17, 2025
b721eee

Remove reference to Kotlin code example


cgati Jul 18, 2025
d8a3837

Fix html-encoded comment


cgati Jul 18, 2025
75d5761

simplify capacity calculation


cgati Jul 18, 2025
5ca884f

simplify the api to getting and setting the context map


cgati Jul 18, 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


37 changes: 32 additions & 5 deletions
...t/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand DownExpand Up@@ -117,7 +118,9 @@ public static String inject(
 final String parentService = config.getServiceName();
 final String env = config.getEnv();
 final String version = config.getVersion();
 final int commentSize = capacity(traceParent, parentService, dbService, env, version);
 final Map<String, String> customFields = SQLCommenterContext.getCopyOfContextMap();
 final int commentSize =
 capacity(traceParent, parentService, dbService, env, version, customFields);
 StringBuilder sb = new StringBuilder(sql.length() + commentSize);
 boolean commentAdded = false;
 String peerService = peerServiceObj != null ? peerServiceObj.toString() : null;
Expand All@@ -137,7 +140,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);
 sb.append(CLOSE_COMMENT);
 } else {
 sb.append(OPEN_COMMENT);
Expand All@@ -152,7 +156,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);

 sb.append(CLOSE_COMMENT);
 sb.append(SPACE);
Expand DownExpand Up@@ -226,7 +231,8 @@ protected static boolean toComment(
 final String peerService,
 final String env,
 final String version,
 final String traceparent) {
 final String traceparent,
 final Map<String, String> customFields) {
 int emptySize = sb.length();

 append(sb, PARENT_SERVICE, parentService, false);
Expand All@@ -241,6 +247,14 @@ protected static boolean toComment(
 if (injectTrace) {
 append(sb, TRACEPARENT, traceparent, sb.length() > emptySize);
 }

 // Add custom fields from SQLCommenterContext
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 append(sb, encode(entry.getKey()), entry.getValue(), sb.length() > emptySize);
 }
 }

 return sb.length() > emptySize;
 }

Expand DownExpand Up@@ -268,7 +282,8 @@ private static int capacity(
 final String parentService,
 final String dbService,
 final String env,
 final String version) {
 final String version,
 final Map<String, String> customFields) {
 int len = INITIAL_CAPACITY;
 if (null != traceparent) {
 len += traceparent.length();
Expand All@@ -285,6 +300,18 @@ private static int capacity(
 if (null != version) {
 len += version.length();
 }

 // Add capacity for custom fields
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 if (entry.getKey() != null && entry.getValue() != null) {
 len += entry.getKey().length();
 len += entry.getValue().length();
 len += 4; // equals, comma, and two quotes
 }
 }
 }

 return len;
 }

Expand Down

43 changes: 43 additions & 0 deletions
...umentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenterContext.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
package datadog.trace.instrumentation.jdbc;

import java.util.HashMap;
import java.util.Map;

/**
 * Thread-local context system for custom SQL comment fields. This class provides functionality
 * similar to SLF4J's MDC but specifically for SQL comment injection. External users can add custom
 * key-value pairs that will be included in SQL comments.
 */
public class SQLCommenterContext {

 private static final ThreadLocal<Map<String, String>> contextHolder =
 new ThreadLocal<Map<String, String>>() {
 @Override
 protected Map<String, String> initialValue() {
 return new HashMap<>();
 }
 };

 /**
 * Gets a copy of the current context map.
 *
 * @return a copy of the current context map, or null if no context is set
 */
 public static Map<String, String> getCopyOfContextMap() {
 Map<String, String> contextMap = contextHolder.get();
 return contextMap.isEmpty() ? null : new HashMap<>(contextMap);
 }

 /**
 * Sets the context map for the current thread.
 *
 * @param contextMap the new context map to set
 */
 public static void setContextMap(Map<String, String> contextMap) {
 if (contextMap == null) {
 contextHolder.remove();
 } else {
 contextHolder.set(new HashMap<>(contextMap));
 }
 }
}

6 changes: 5 additions & 1 deletion
...ation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/StatementInstrumentation.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,11 @@ public Map<String, String> contextStore() {

 @Override
 public String[] helperClassNames() {
 return new String[] {packageName + ".JDBCDecorator", packageName + ".SQLCommenter"};
 return new String[] {
 packageName + ".JDBCDecorator",
 packageName + ".SQLCommenter",
 packageName + ".SQLCommenterContext"
 };
 }

 // prepend mode will prepend the SQL comment to the raw sql query
Expand Down

182 changes: 182 additions & 0 deletions
dd-java-agent/instrumentation/jdbc/src/test/groovy/SQLCommenterTest.groovy

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import datadog.trace.bootstrap.instrumentation.api.AgentTracer
import datadog.trace.bootstrap.instrumentation.api.Tags

import datadog.trace.instrumentation.jdbc.SQLCommenter
import datadog.trace.instrumentation.jdbc.SQLCommenterContext

import static datadog.trace.agent.test.utils.TraceUtils.runUnderTrace

Expand DownExpand Up@@ -145,4 +146,185 @@ class SQLCommenterTest extends AgentTestRunner {
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "mysql" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "postgres" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 }

 def "test SQL comment injection with custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields in context
 SQLCommenterContext.put("tenant_id", "abc123")
 SQLCommenterContext.put("request_id", "req-456")
 SQLCommenterContext.put("user_id", 789)

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.contains("user_id='789'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields using withSQLCommentFields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenterContext.withSQLCommentFields(
 ["tenant_id": "abc123", "request_id": "req-456"], {
 return SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )
 }
 )

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")

 // Context should be cleared after the block
 SQLCommenterContext.isEmpty()
 }

 def "test SQL comment injection with empty custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 then:
 // Should contain only standard fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields containing special characters"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with special characters that need URL encoding
 SQLCommenterContext.put("special_key", "value with spaces")
 SQLCommenterContext.put("unicode_key", "value_with_émojis_🎉")
 SQLCommenterContext.put("symbols_key", "value&with=symbols")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain URL-encoded custom fields (URLEncoder uses + for spaces)
 sqlWithComment.contains("special_key='value+with+spaces'")
 sqlWithComment.contains("unicode_key=") // Should be URL encoded
 sqlWithComment.contains("symbols_key='value%26with%3Dsymbols'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with null and empty custom field values"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with null and empty values
 SQLCommenterContext.put("null_key", null)
 SQLCommenterContext.put("empty_key", "")
 SQLCommenterContext.put("valid_key", "valid_value")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should not contain null or empty fields, but should contain valid field
 !sqlWithComment.contains("null_key")
 !sqlWithComment.contains("empty_key")
 sqlWithComment.contains("valid_key='valid_value'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: add SQLCommenter custom fields API with thread-local context by cgati · Pull Request #1 · mdg-private/dd-trace-java · GitHub
Skip to content
feat: add SQLCommenter custom fields API with thread-local context#1

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

 Draft

cgati
wants to merge
5
commits into

base:master
Choose a base branch

from

 Draft


feat: add SQLCommenter custom fields API with thread-local context
#1
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d6c47f2

feat: add SQLCommenter custom fields API with thread-local context


cgati Jul 17, 2025
b721eee

Remove reference to Kotlin code example


cgati Jul 18, 2025
d8a3837

Fix html-encoded comment


cgati Jul 18, 2025
75d5761

simplify capacity calculation


cgati Jul 18, 2025
5ca884f

simplify the api to getting and setting the context map


cgati Jul 18, 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


37 changes: 32 additions & 5 deletions
...t/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand DownExpand Up@@ -117,7 +118,9 @@ public static String inject(
 final String parentService = config.getServiceName();
 final String env = config.getEnv();
 final String version = config.getVersion();
 final int commentSize = capacity(traceParent, parentService, dbService, env, version);
 final Map<String, String> customFields = SQLCommenterContext.getCopyOfContextMap();
 final int commentSize =
 capacity(traceParent, parentService, dbService, env, version, customFields);
 StringBuilder sb = new StringBuilder(sql.length() + commentSize);
 boolean commentAdded = false;
 String peerService = peerServiceObj != null ? peerServiceObj.toString() : null;
Expand All@@ -137,7 +140,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);
 sb.append(CLOSE_COMMENT);
 } else {
 sb.append(OPEN_COMMENT);
Expand All@@ -152,7 +156,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);

 sb.append(CLOSE_COMMENT);
 sb.append(SPACE);
Expand DownExpand Up@@ -226,7 +231,8 @@ protected static boolean toComment(
 final String peerService,
 final String env,
 final String version,
 final String traceparent) {
 final String traceparent,
 final Map<String, String> customFields) {
 int emptySize = sb.length();

 append(sb, PARENT_SERVICE, parentService, false);
Expand All@@ -241,6 +247,14 @@ protected static boolean toComment(
 if (injectTrace) {
 append(sb, TRACEPARENT, traceparent, sb.length() > emptySize);
 }

 // Add custom fields from SQLCommenterContext
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 append(sb, encode(entry.getKey()), entry.getValue(), sb.length() > emptySize);
 }
 }

 return sb.length() > emptySize;
 }

Expand DownExpand Up@@ -268,7 +282,8 @@ private static int capacity(
 final String parentService,
 final String dbService,
 final String env,
 final String version) {
 final String version,
 final Map<String, String> customFields) {
 int len = INITIAL_CAPACITY;
 if (null != traceparent) {
 len += traceparent.length();
Expand All@@ -285,6 +300,18 @@ private static int capacity(
 if (null != version) {
 len += version.length();
 }

 // Add capacity for custom fields
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 if (entry.getKey() != null && entry.getValue() != null) {
 len += entry.getKey().length();
 len += entry.getValue().length();
 len += 4; // equals, comma, and two quotes
 }
 }
 }

 return len;
 }

Expand Down

43 changes: 43 additions & 0 deletions
...umentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenterContext.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
package datadog.trace.instrumentation.jdbc;

import java.util.HashMap;
import java.util.Map;

/**
 * Thread-local context system for custom SQL comment fields. This class provides functionality
 * similar to SLF4J's MDC but specifically for SQL comment injection. External users can add custom
 * key-value pairs that will be included in SQL comments.
 */
public class SQLCommenterContext {

 private static final ThreadLocal<Map<String, String>> contextHolder =
 new ThreadLocal<Map<String, String>>() {
 @Override
 protected Map<String, String> initialValue() {
 return new HashMap<>();
 }
 };

 /**
 * Gets a copy of the current context map.
 *
 * @return a copy of the current context map, or null if no context is set
 */
 public static Map<String, String> getCopyOfContextMap() {
 Map<String, String> contextMap = contextHolder.get();
 return contextMap.isEmpty() ? null : new HashMap<>(contextMap);
 }

 /**
 * Sets the context map for the current thread.
 *
 * @param contextMap the new context map to set
 */
 public static void setContextMap(Map<String, String> contextMap) {
 if (contextMap == null) {
 contextHolder.remove();
 } else {
 contextHolder.set(new HashMap<>(contextMap));
 }
 }
}

6 changes: 5 additions & 1 deletion
...ation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/StatementInstrumentation.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,11 @@ public Map<String, String> contextStore() {

 @Override
 public String[] helperClassNames() {
 return new String[] {packageName + ".JDBCDecorator", packageName + ".SQLCommenter"};
 return new String[] {
 packageName + ".JDBCDecorator",
 packageName + ".SQLCommenter",
 packageName + ".SQLCommenterContext"
 };
 }

 // prepend mode will prepend the SQL comment to the raw sql query
Expand Down

182 changes: 182 additions & 0 deletions
dd-java-agent/instrumentation/jdbc/src/test/groovy/SQLCommenterTest.groovy

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import datadog.trace.bootstrap.instrumentation.api.AgentTracer
import datadog.trace.bootstrap.instrumentation.api.Tags

import datadog.trace.instrumentation.jdbc.SQLCommenter
import datadog.trace.instrumentation.jdbc.SQLCommenterContext

import static datadog.trace.agent.test.utils.TraceUtils.runUnderTrace

Expand DownExpand Up@@ -145,4 +146,185 @@ class SQLCommenterTest extends AgentTestRunner {
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "mysql" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "postgres" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 }

 def "test SQL comment injection with custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields in context
 SQLCommenterContext.put("tenant_id", "abc123")
 SQLCommenterContext.put("request_id", "req-456")
 SQLCommenterContext.put("user_id", 789)

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.contains("user_id='789'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields using withSQLCommentFields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenterContext.withSQLCommentFields(
 ["tenant_id": "abc123", "request_id": "req-456"], {
 return SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )
 }
 )

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")

 // Context should be cleared after the block
 SQLCommenterContext.isEmpty()
 }

 def "test SQL comment injection with empty custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 then:
 // Should contain only standard fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields containing special characters"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with special characters that need URL encoding
 SQLCommenterContext.put("special_key", "value with spaces")
 SQLCommenterContext.put("unicode_key", "value_with_émojis_🎉")
 SQLCommenterContext.put("symbols_key", "value&with=symbols")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain URL-encoded custom fields (URLEncoder uses + for spaces)
 sqlWithComment.contains("special_key='value+with+spaces'")
 sqlWithComment.contains("unicode_key=") // Should be URL encoded
 sqlWithComment.contains("symbols_key='value%26with%3Dsymbols'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with null and empty custom field values"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with null and empty values
 SQLCommenterContext.put("null_key", null)
 SQLCommenterContext.put("empty_key", "")
 SQLCommenterContext.put("valid_key", "valid_value")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should not contain null or empty fields, but should contain valid field
 !sqlWithComment.contains("null_key")
 !sqlWithComment.contains("empty_key")
 sqlWithComment.contains("valid_key='valid_value'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat: add SQLCommenter custom fields API with thread-local context by cgati · Pull Request #1 · mdg-private/dd-trace-java · GitHub
Skip to content
feat: add SQLCommenter custom fields API with thread-local context#1

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

 Draft

cgati
wants to merge
5
commits into

base:master
Choose a base branch

from

 Draft


feat: add SQLCommenter custom fields API with thread-local context
#1
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d6c47f2

feat: add SQLCommenter custom fields API with thread-local context


cgati Jul 17, 2025
b721eee

Remove reference to Kotlin code example


cgati Jul 18, 2025
d8a3837

Fix html-encoded comment


cgati Jul 18, 2025
75d5761

simplify capacity calculation


cgati Jul 18, 2025
5ca884f

simplify the api to getting and setting the context map


cgati Jul 18, 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


37 changes: 32 additions & 5 deletions
...t/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand DownExpand Up@@ -117,7 +118,9 @@ public static String inject(
 final String parentService = config.getServiceName();
 final String env = config.getEnv();
 final String version = config.getVersion();
 final int commentSize = capacity(traceParent, parentService, dbService, env, version);
 final Map<String, String> customFields = SQLCommenterContext.getCopyOfContextMap();
 final int commentSize =
 capacity(traceParent, parentService, dbService, env, version, customFields);
 StringBuilder sb = new StringBuilder(sql.length() + commentSize);
 boolean commentAdded = false;
 String peerService = peerServiceObj != null ? peerServiceObj.toString() : null;
Expand All@@ -137,7 +140,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);
 sb.append(CLOSE_COMMENT);
 } else {
 sb.append(OPEN_COMMENT);
Expand All@@ -152,7 +156,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);

 sb.append(CLOSE_COMMENT);
 sb.append(SPACE);
Expand DownExpand Up@@ -226,7 +231,8 @@ protected static boolean toComment(
 final String peerService,
 final String env,
 final String version,
 final String traceparent) {
 final String traceparent,
 final Map<String, String> customFields) {
 int emptySize = sb.length();

 append(sb, PARENT_SERVICE, parentService, false);
Expand All@@ -241,6 +247,14 @@ protected static boolean toComment(
 if (injectTrace) {
 append(sb, TRACEPARENT, traceparent, sb.length() > emptySize);
 }

 // Add custom fields from SQLCommenterContext
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 append(sb, encode(entry.getKey()), entry.getValue(), sb.length() > emptySize);
 }
 }

 return sb.length() > emptySize;
 }

Expand DownExpand Up@@ -268,7 +282,8 @@ private static int capacity(
 final String parentService,
 final String dbService,
 final String env,
 final String version) {
 final String version,
 final Map<String, String> customFields) {
 int len = INITIAL_CAPACITY;
 if (null != traceparent) {
 len += traceparent.length();
Expand All@@ -285,6 +300,18 @@ private static int capacity(
 if (null != version) {
 len += version.length();
 }

 // Add capacity for custom fields
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 if (entry.getKey() != null && entry.getValue() != null) {
 len += entry.getKey().length();
 len += entry.getValue().length();
 len += 4; // equals, comma, and two quotes
 }
 }
 }

 return len;
 }

Expand Down

43 changes: 43 additions & 0 deletions
...umentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenterContext.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
package datadog.trace.instrumentation.jdbc;

import java.util.HashMap;
import java.util.Map;

/**
 * Thread-local context system for custom SQL comment fields. This class provides functionality
 * similar to SLF4J's MDC but specifically for SQL comment injection. External users can add custom
 * key-value pairs that will be included in SQL comments.
 */
public class SQLCommenterContext {

 private static final ThreadLocal<Map<String, String>> contextHolder =
 new ThreadLocal<Map<String, String>>() {
 @Override
 protected Map<String, String> initialValue() {
 return new HashMap<>();
 }
 };

 /**
 * Gets a copy of the current context map.
 *
 * @return a copy of the current context map, or null if no context is set
 */
 public static Map<String, String> getCopyOfContextMap() {
 Map<String, String> contextMap = contextHolder.get();
 return contextMap.isEmpty() ? null : new HashMap<>(contextMap);
 }

 /**
 * Sets the context map for the current thread.
 *
 * @param contextMap the new context map to set
 */
 public static void setContextMap(Map<String, String> contextMap) {
 if (contextMap == null) {
 contextHolder.remove();
 } else {
 contextHolder.set(new HashMap<>(contextMap));
 }
 }
}

6 changes: 5 additions & 1 deletion
...ation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/StatementInstrumentation.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,11 @@ public Map<String, String> contextStore() {

 @Override
 public String[] helperClassNames() {
 return new String[] {packageName + ".JDBCDecorator", packageName + ".SQLCommenter"};
 return new String[] {
 packageName + ".JDBCDecorator",
 packageName + ".SQLCommenter",
 packageName + ".SQLCommenterContext"
 };
 }

 // prepend mode will prepend the SQL comment to the raw sql query
Expand Down

182 changes: 182 additions & 0 deletions
dd-java-agent/instrumentation/jdbc/src/test/groovy/SQLCommenterTest.groovy

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import datadog.trace.bootstrap.instrumentation.api.AgentTracer
import datadog.trace.bootstrap.instrumentation.api.Tags

import datadog.trace.instrumentation.jdbc.SQLCommenter
import datadog.trace.instrumentation.jdbc.SQLCommenterContext

import static datadog.trace.agent.test.utils.TraceUtils.runUnderTrace

Expand DownExpand Up@@ -145,4 +146,185 @@ class SQLCommenterTest extends AgentTestRunner {
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "mysql" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "postgres" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 }

 def "test SQL comment injection with custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields in context
 SQLCommenterContext.put("tenant_id", "abc123")
 SQLCommenterContext.put("request_id", "req-456")
 SQLCommenterContext.put("user_id", 789)

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.contains("user_id='789'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields using withSQLCommentFields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenterContext.withSQLCommentFields(
 ["tenant_id": "abc123", "request_id": "req-456"], {
 return SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )
 }
 )

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")

 // Context should be cleared after the block
 SQLCommenterContext.isEmpty()
 }

 def "test SQL comment injection with empty custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 then:
 // Should contain only standard fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields containing special characters"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with special characters that need URL encoding
 SQLCommenterContext.put("special_key", "value with spaces")
 SQLCommenterContext.put("unicode_key", "value_with_émojis_🎉")
 SQLCommenterContext.put("symbols_key", "value&with=symbols")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain URL-encoded custom fields (URLEncoder uses + for spaces)
 sqlWithComment.contains("special_key='value+with+spaces'")
 sqlWithComment.contains("unicode_key=") // Should be URL encoded
 sqlWithComment.contains("symbols_key='value%26with%3Dsymbols'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with null and empty custom field values"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with null and empty values
 SQLCommenterContext.put("null_key", null)
 SQLCommenterContext.put("empty_key", "")
 SQLCommenterContext.put("valid_key", "valid_value")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should not contain null or empty fields, but should contain valid field
 !sqlWithComment.contains("null_key")
 !sqlWithComment.contains("empty_key")
 sqlWithComment.contains("valid_key='valid_value'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: add SQLCommenter custom fields API with thread-local context by cgati · Pull Request #1 · mdg-private/dd-trace-java · GitHub
Skip to content
feat: add SQLCommenter custom fields API with thread-local context#1

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

 Draft

cgati
wants to merge
5
commits into

base:master
Choose a base branch

from

 Draft


feat: add SQLCommenter custom fields API with thread-local context
#1
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d6c47f2

feat: add SQLCommenter custom fields API with thread-local context


cgati Jul 17, 2025
b721eee

Remove reference to Kotlin code example


cgati Jul 18, 2025
d8a3837

Fix html-encoded comment


cgati Jul 18, 2025
75d5761

simplify capacity calculation


cgati Jul 18, 2025
5ca884f

simplify the api to getting and setting the context map


cgati Jul 18, 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


37 changes: 32 additions & 5 deletions
...t/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand DownExpand Up@@ -117,7 +118,9 @@ public static String inject(
 final String parentService = config.getServiceName();
 final String env = config.getEnv();
 final String version = config.getVersion();
 final int commentSize = capacity(traceParent, parentService, dbService, env, version);
 final Map<String, String> customFields = SQLCommenterContext.getCopyOfContextMap();
 final int commentSize =
 capacity(traceParent, parentService, dbService, env, version, customFields);
 StringBuilder sb = new StringBuilder(sql.length() + commentSize);
 boolean commentAdded = false;
 String peerService = peerServiceObj != null ? peerServiceObj.toString() : null;
Expand All@@ -137,7 +140,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);
 sb.append(CLOSE_COMMENT);
 } else {
 sb.append(OPEN_COMMENT);
Expand All@@ -152,7 +156,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);

 sb.append(CLOSE_COMMENT);
 sb.append(SPACE);
Expand DownExpand Up@@ -226,7 +231,8 @@ protected static boolean toComment(
 final String peerService,
 final String env,
 final String version,
 final String traceparent) {
 final String traceparent,
 final Map<String, String> customFields) {
 int emptySize = sb.length();

 append(sb, PARENT_SERVICE, parentService, false);
Expand All@@ -241,6 +247,14 @@ protected static boolean toComment(
 if (injectTrace) {
 append(sb, TRACEPARENT, traceparent, sb.length() > emptySize);
 }

 // Add custom fields from SQLCommenterContext
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 append(sb, encode(entry.getKey()), entry.getValue(), sb.length() > emptySize);
 }
 }

 return sb.length() > emptySize;
 }

Expand DownExpand Up@@ -268,7 +282,8 @@ private static int capacity(
 final String parentService,
 final String dbService,
 final String env,
 final String version) {
 final String version,
 final Map<String, String> customFields) {
 int len = INITIAL_CAPACITY;
 if (null != traceparent) {
 len += traceparent.length();
Expand All@@ -285,6 +300,18 @@ private static int capacity(
 if (null != version) {
 len += version.length();
 }

 // Add capacity for custom fields
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 if (entry.getKey() != null && entry.getValue() != null) {
 len += entry.getKey().length();
 len += entry.getValue().length();
 len += 4; // equals, comma, and two quotes
 }
 }
 }

 return len;
 }

Expand Down

43 changes: 43 additions & 0 deletions
...umentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenterContext.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
package datadog.trace.instrumentation.jdbc;

import java.util.HashMap;
import java.util.Map;

/**
 * Thread-local context system for custom SQL comment fields. This class provides functionality
 * similar to SLF4J's MDC but specifically for SQL comment injection. External users can add custom
 * key-value pairs that will be included in SQL comments.
 */
public class SQLCommenterContext {

 private static final ThreadLocal<Map<String, String>> contextHolder =
 new ThreadLocal<Map<String, String>>() {
 @Override
 protected Map<String, String> initialValue() {
 return new HashMap<>();
 }
 };

 /**
 * Gets a copy of the current context map.
 *
 * @return a copy of the current context map, or null if no context is set
 */
 public static Map<String, String> getCopyOfContextMap() {
 Map<String, String> contextMap = contextHolder.get();
 return contextMap.isEmpty() ? null : new HashMap<>(contextMap);
 }

 /**
 * Sets the context map for the current thread.
 *
 * @param contextMap the new context map to set
 */
 public static void setContextMap(Map<String, String> contextMap) {
 if (contextMap == null) {
 contextHolder.remove();
 } else {
 contextHolder.set(new HashMap<>(contextMap));
 }
 }
}

6 changes: 5 additions & 1 deletion
...ation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/StatementInstrumentation.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,11 @@ public Map<String, String> contextStore() {

 @Override
 public String[] helperClassNames() {
 return new String[] {packageName + ".JDBCDecorator", packageName + ".SQLCommenter"};
 return new String[] {
 packageName + ".JDBCDecorator",
 packageName + ".SQLCommenter",
 packageName + ".SQLCommenterContext"
 };
 }

 // prepend mode will prepend the SQL comment to the raw sql query
Expand Down

182 changes: 182 additions & 0 deletions
dd-java-agent/instrumentation/jdbc/src/test/groovy/SQLCommenterTest.groovy

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import datadog.trace.bootstrap.instrumentation.api.AgentTracer
import datadog.trace.bootstrap.instrumentation.api.Tags

import datadog.trace.instrumentation.jdbc.SQLCommenter
import datadog.trace.instrumentation.jdbc.SQLCommenterContext

import static datadog.trace.agent.test.utils.TraceUtils.runUnderTrace

Expand DownExpand Up@@ -145,4 +146,185 @@ class SQLCommenterTest extends AgentTestRunner {
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "mysql" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "postgres" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 }

 def "test SQL comment injection with custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields in context
 SQLCommenterContext.put("tenant_id", "abc123")
 SQLCommenterContext.put("request_id", "req-456")
 SQLCommenterContext.put("user_id", 789)

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.contains("user_id='789'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields using withSQLCommentFields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenterContext.withSQLCommentFields(
 ["tenant_id": "abc123", "request_id": "req-456"], {
 return SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )
 }
 )

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")

 // Context should be cleared after the block
 SQLCommenterContext.isEmpty()
 }

 def "test SQL comment injection with empty custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 then:
 // Should contain only standard fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields containing special characters"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with special characters that need URL encoding
 SQLCommenterContext.put("special_key", "value with spaces")
 SQLCommenterContext.put("unicode_key", "value_with_émojis_🎉")
 SQLCommenterContext.put("symbols_key", "value&with=symbols")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain URL-encoded custom fields (URLEncoder uses + for spaces)
 sqlWithComment.contains("special_key='value+with+spaces'")
 sqlWithComment.contains("unicode_key=") // Should be URL encoded
 sqlWithComment.contains("symbols_key='value%26with%3Dsymbols'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with null and empty custom field values"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with null and empty values
 SQLCommenterContext.put("null_key", null)
 SQLCommenterContext.put("empty_key", "")
 SQLCommenterContext.put("valid_key", "valid_value")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should not contain null or empty fields, but should contain valid field
 !sqlWithComment.contains("null_key")
 !sqlWithComment.contains("empty_key")
 sqlWithComment.contains("valid_key='valid_value'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat: add SQLCommenter custom fields API with thread-local context by cgati · Pull Request #1 · mdg-private/dd-trace-java · GitHub
Skip to content
feat: add SQLCommenter custom fields API with thread-local context#1

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

 Draft

cgati
wants to merge
5
commits into

base:master
Choose a base branch

from

 Draft


feat: add SQLCommenter custom fields API with thread-local context
#1
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d6c47f2

feat: add SQLCommenter custom fields API with thread-local context


cgati Jul 17, 2025
b721eee

Remove reference to Kotlin code example


cgati Jul 18, 2025
d8a3837

Fix html-encoded comment


cgati Jul 18, 2025
75d5761

simplify capacity calculation


cgati Jul 18, 2025
5ca884f

simplify the api to getting and setting the context map


cgati Jul 18, 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


37 changes: 32 additions & 5 deletions
...t/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand DownExpand Up@@ -117,7 +118,9 @@ public static String inject(
 final String parentService = config.getServiceName();
 final String env = config.getEnv();
 final String version = config.getVersion();
 final int commentSize = capacity(traceParent, parentService, dbService, env, version);
 final Map<String, String> customFields = SQLCommenterContext.getCopyOfContextMap();
 final int commentSize =
 capacity(traceParent, parentService, dbService, env, version, customFields);
 StringBuilder sb = new StringBuilder(sql.length() + commentSize);
 boolean commentAdded = false;
 String peerService = peerServiceObj != null ? peerServiceObj.toString() : null;
Expand All@@ -137,7 +140,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);
 sb.append(CLOSE_COMMENT);
 } else {
 sb.append(OPEN_COMMENT);
Expand All@@ -152,7 +156,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);

 sb.append(CLOSE_COMMENT);
 sb.append(SPACE);
Expand DownExpand Up@@ -226,7 +231,8 @@ protected static boolean toComment(
 final String peerService,
 final String env,
 final String version,
 final String traceparent) {
 final String traceparent,
 final Map<String, String> customFields) {
 int emptySize = sb.length();

 append(sb, PARENT_SERVICE, parentService, false);
Expand All@@ -241,6 +247,14 @@ protected static boolean toComment(
 if (injectTrace) {
 append(sb, TRACEPARENT, traceparent, sb.length() > emptySize);
 }

 // Add custom fields from SQLCommenterContext
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 append(sb, encode(entry.getKey()), entry.getValue(), sb.length() > emptySize);
 }
 }

 return sb.length() > emptySize;
 }

Expand DownExpand Up@@ -268,7 +282,8 @@ private static int capacity(
 final String parentService,
 final String dbService,
 final String env,
 final String version) {
 final String version,
 final Map<String, String> customFields) {
 int len = INITIAL_CAPACITY;
 if (null != traceparent) {
 len += traceparent.length();
Expand All@@ -285,6 +300,18 @@ private static int capacity(
 if (null != version) {
 len += version.length();
 }

 // Add capacity for custom fields
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 if (entry.getKey() != null && entry.getValue() != null) {
 len += entry.getKey().length();
 len += entry.getValue().length();
 len += 4; // equals, comma, and two quotes
 }
 }
 }

 return len;
 }

Expand Down

43 changes: 43 additions & 0 deletions
...umentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenterContext.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
package datadog.trace.instrumentation.jdbc;

import java.util.HashMap;
import java.util.Map;

/**
 * Thread-local context system for custom SQL comment fields. This class provides functionality
 * similar to SLF4J's MDC but specifically for SQL comment injection. External users can add custom
 * key-value pairs that will be included in SQL comments.
 */
public class SQLCommenterContext {

 private static final ThreadLocal<Map<String, String>> contextHolder =
 new ThreadLocal<Map<String, String>>() {
 @Override
 protected Map<String, String> initialValue() {
 return new HashMap<>();
 }
 };

 /**
 * Gets a copy of the current context map.
 *
 * @return a copy of the current context map, or null if no context is set
 */
 public static Map<String, String> getCopyOfContextMap() {
 Map<String, String> contextMap = contextHolder.get();
 return contextMap.isEmpty() ? null : new HashMap<>(contextMap);
 }

 /**
 * Sets the context map for the current thread.
 *
 * @param contextMap the new context map to set
 */
 public static void setContextMap(Map<String, String> contextMap) {
 if (contextMap == null) {
 contextHolder.remove();
 } else {
 contextHolder.set(new HashMap<>(contextMap));
 }
 }
}

6 changes: 5 additions & 1 deletion
...ation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/StatementInstrumentation.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,11 @@ public Map<String, String> contextStore() {

 @Override
 public String[] helperClassNames() {
 return new String[] {packageName + ".JDBCDecorator", packageName + ".SQLCommenter"};
 return new String[] {
 packageName + ".JDBCDecorator",
 packageName + ".SQLCommenter",
 packageName + ".SQLCommenterContext"
 };
 }

 // prepend mode will prepend the SQL comment to the raw sql query
Expand Down

182 changes: 182 additions & 0 deletions
dd-java-agent/instrumentation/jdbc/src/test/groovy/SQLCommenterTest.groovy

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import datadog.trace.bootstrap.instrumentation.api.AgentTracer
import datadog.trace.bootstrap.instrumentation.api.Tags

import datadog.trace.instrumentation.jdbc.SQLCommenter
import datadog.trace.instrumentation.jdbc.SQLCommenterContext

import static datadog.trace.agent.test.utils.TraceUtils.runUnderTrace

Expand DownExpand Up@@ -145,4 +146,185 @@ class SQLCommenterTest extends AgentTestRunner {
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "mysql" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "postgres" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 }

 def "test SQL comment injection with custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields in context
 SQLCommenterContext.put("tenant_id", "abc123")
 SQLCommenterContext.put("request_id", "req-456")
 SQLCommenterContext.put("user_id", 789)

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.contains("user_id='789'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields using withSQLCommentFields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenterContext.withSQLCommentFields(
 ["tenant_id": "abc123", "request_id": "req-456"], {
 return SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )
 }
 )

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")

 // Context should be cleared after the block
 SQLCommenterContext.isEmpty()
 }

 def "test SQL comment injection with empty custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 then:
 // Should contain only standard fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields containing special characters"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with special characters that need URL encoding
 SQLCommenterContext.put("special_key", "value with spaces")
 SQLCommenterContext.put("unicode_key", "value_with_émojis_🎉")
 SQLCommenterContext.put("symbols_key", "value&with=symbols")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain URL-encoded custom fields (URLEncoder uses + for spaces)
 sqlWithComment.contains("special_key='value+with+spaces'")
 sqlWithComment.contains("unicode_key=") // Should be URL encoded
 sqlWithComment.contains("symbols_key='value%26with%3Dsymbols'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with null and empty custom field values"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with null and empty values
 SQLCommenterContext.put("null_key", null)
 SQLCommenterContext.put("empty_key", "")
 SQLCommenterContext.put("valid_key", "valid_value")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should not contain null or empty fields, but should contain valid field
 !sqlWithComment.contains("null_key")
 !sqlWithComment.contains("empty_key")
 sqlWithComment.contains("valid_key='valid_value'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat: add SQLCommenter custom fields API with thread-local context by cgati · Pull Request #1 · mdg-private/dd-trace-java · GitHub
Skip to content
feat: add SQLCommenter custom fields API with thread-local context#1

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

 Draft

cgati
wants to merge
5
commits into

base:master
Choose a base branch

from

 Draft


feat: add SQLCommenter custom fields API with thread-local context
#1
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
d6c47f2

feat: add SQLCommenter custom fields API with thread-local context


cgati Jul 17, 2025
b721eee

Remove reference to Kotlin code example


cgati Jul 18, 2025
d8a3837

Fix html-encoded comment


cgati Jul 18, 2025
75d5761

simplify capacity calculation


cgati Jul 18, 2025
5ca884f

simplify the api to getting and setting the context map


cgati Jul 18, 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


37 changes: 32 additions & 5 deletions
...t/instrumentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenter.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand DownExpand Up@@ -117,7 +118,9 @@ public static String inject(
 final String parentService = config.getServiceName();
 final String env = config.getEnv();
 final String version = config.getVersion();
 final int commentSize = capacity(traceParent, parentService, dbService, env, version);
 final Map<String, String> customFields = SQLCommenterContext.getCopyOfContextMap();
 final int commentSize =
 capacity(traceParent, parentService, dbService, env, version, customFields);
 StringBuilder sb = new StringBuilder(sql.length() + commentSize);
 boolean commentAdded = false;
 String peerService = peerServiceObj != null ? peerServiceObj.toString() : null;
Expand All@@ -137,7 +140,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);
 sb.append(CLOSE_COMMENT);
 } else {
 sb.append(OPEN_COMMENT);
Expand All@@ -152,7 +156,8 @@ public static String inject(
 peerService,
 env,
 version,
 traceParent);
 traceParent,
 customFields);

 sb.append(CLOSE_COMMENT);
 sb.append(SPACE);
Expand DownExpand Up@@ -226,7 +231,8 @@ protected static boolean toComment(
 final String peerService,
 final String env,
 final String version,
 final String traceparent) {
 final String traceparent,
 final Map<String, String> customFields) {
 int emptySize = sb.length();

 append(sb, PARENT_SERVICE, parentService, false);
Expand All@@ -241,6 +247,14 @@ protected static boolean toComment(
 if (injectTrace) {
 append(sb, TRACEPARENT, traceparent, sb.length() > emptySize);
 }

 // Add custom fields from SQLCommenterContext
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 append(sb, encode(entry.getKey()), entry.getValue(), sb.length() > emptySize);
 }
 }

 return sb.length() > emptySize;
 }

Expand DownExpand Up@@ -268,7 +282,8 @@ private static int capacity(
 final String parentService,
 final String dbService,
 final String env,
 final String version) {
 final String version,
 final Map<String, String> customFields) {
 int len = INITIAL_CAPACITY;
 if (null != traceparent) {
 len += traceparent.length();
Expand All@@ -285,6 +300,18 @@ private static int capacity(
 if (null != version) {
 len += version.length();
 }

 // Add capacity for custom fields
 if (customFields != null) {
 for (Map.Entry<String, String> entry : customFields.entrySet()) {
 if (entry.getKey() != null && entry.getValue() != null) {
 len += entry.getKey().length();
 len += entry.getValue().length();
 len += 4; // equals, comma, and two quotes
 }
 }
 }

 return len;
 }

Expand Down

43 changes: 43 additions & 0 deletions
...umentation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/SQLCommenterContext.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
package datadog.trace.instrumentation.jdbc;

import java.util.HashMap;
import java.util.Map;

/**
 * Thread-local context system for custom SQL comment fields. This class provides functionality
 * similar to SLF4J's MDC but specifically for SQL comment injection. External users can add custom
 * key-value pairs that will be included in SQL comments.
 */
public class SQLCommenterContext {

 private static final ThreadLocal<Map<String, String>> contextHolder =
 new ThreadLocal<Map<String, String>>() {
 @Override
 protected Map<String, String> initialValue() {
 return new HashMap<>();
 }
 };

 /**
 * Gets a copy of the current context map.
 *
 * @return a copy of the current context map, or null if no context is set
 */
 public static Map<String, String> getCopyOfContextMap() {
 Map<String, String> contextMap = contextHolder.get();
 return contextMap.isEmpty() ? null : new HashMap<>(contextMap);
 }

 /**
 * Sets the context map for the current thread.
 *
 * @param contextMap the new context map to set
 */
 public static void setContextMap(Map<String, String> contextMap) {
 if (contextMap == null) {
 contextHolder.remove();
 } else {
 contextHolder.set(new HashMap<>(contextMap));
 }
 }
}

6 changes: 5 additions & 1 deletion
...ation/jdbc/src/main/java/datadog/trace/instrumentation/jdbc/StatementInstrumentation.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,7 +58,11 @@ public Map<String, String> contextStore() {

 @Override
 public String[] helperClassNames() {
 return new String[] {packageName + ".JDBCDecorator", packageName + ".SQLCommenter"};
 return new String[] {
 packageName + ".JDBCDecorator",
 packageName + ".SQLCommenter",
 packageName + ".SQLCommenterContext"
 };
 }

 // prepend mode will prepend the SQL comment to the raw sql query
Expand Down

182 changes: 182 additions & 0 deletions
dd-java-agent/instrumentation/jdbc/src/test/groovy/SQLCommenterTest.groovy

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@ import datadog.trace.bootstrap.instrumentation.api.AgentTracer
import datadog.trace.bootstrap.instrumentation.api.Tags

import datadog.trace.instrumentation.jdbc.SQLCommenter
import datadog.trace.instrumentation.jdbc.SQLCommenterContext

import static datadog.trace.agent.test.utils.TraceUtils.runUnderTrace

Expand DownExpand Up@@ -145,4 +146,185 @@ class SQLCommenterTest extends AgentTestRunner {
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "mysql" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 "SELECT * FROM foo" | "SqlCommenter" | "Test" | "my-service" | "postgres" | "h" | "n" | "TestVersion" | true | true | "00-00000000000000007fffffffffffffff-000000024cb016ea-00" | "testPeer" | "SELECT * FROM foo /*ddps='SqlCommenter',dddbs='my-service',ddh='h',dddb='n',ddprs='testPeer',dde='Test',ddpv='TestVersion',traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'*/"
 }

 def "test SQL comment injection with custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields in context
 SQLCommenterContext.put("tenant_id", "abc123")
 SQLCommenterContext.put("request_id", "req-456")
 SQLCommenterContext.put("user_id", 789)

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.contains("user_id='789'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields using withSQLCommentFields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenterContext.withSQLCommentFields(
 ["tenant_id": "abc123", "request_id": "req-456"], {
 return SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )
 }
 )

 then:
 // Should contain all standard fields plus custom fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("tenant_id='abc123'")
 sqlWithComment.contains("request_id='req-456'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")

 // Context should be cleared after the block
 SQLCommenterContext.isEmpty()
 }

 def "test SQL comment injection with empty custom fields"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 "00-00000000000000007fffffffffffffff-000000024cb016ea-00",
 true,
 true
 )

 then:
 // Should contain only standard fields
 sqlWithComment.contains("ddps='SqlCommenter'")
 sqlWithComment.contains("dddbs='my-service'")
 sqlWithComment.contains("ddh='h'")
 sqlWithComment.contains("dddb='n'")
 sqlWithComment.contains("dde='Test'")
 sqlWithComment.contains("ddpv='TestVersion'")
 sqlWithComment.contains("traceparent='00-00000000000000007fffffffffffffff-000000024cb016ea-00'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with custom fields containing special characters"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with special characters that need URL encoding
 SQLCommenterContext.put("special_key", "value with spaces")
 SQLCommenterContext.put("unicode_key", "value_with_émojis_🎉")
 SQLCommenterContext.put("symbols_key", "value&with=symbols")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should contain URL-encoded custom fields (URLEncoder uses + for spaces)
 sqlWithComment.contains("special_key='value+with+spaces'")
 sqlWithComment.contains("unicode_key=") // Should be URL encoded
 sqlWithComment.contains("symbols_key='value%26with%3Dsymbols'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }

 def "test SQL comment injection with null and empty custom field values"() {
 setup:
 injectSysConfig("dd.service", "SqlCommenter")
 injectSysConfig("dd.env", "Test")
 injectSysConfig("dd.version", "TestVersion")

 when:
 String sqlWithComment = ""

 // Set up custom fields with null and empty values
 SQLCommenterContext.put("null_key", null)
 SQLCommenterContext.put("empty_key", "")
 SQLCommenterContext.put("valid_key", "valid_value")

 sqlWithComment = SQLCommenter.inject(
 "SELECT * FROM foo",
 "my-service",
 "mysql",
 "h",
 "n",
 null,
 false,
 true
 )

 SQLCommenterContext.clear()

 then:
 // Should not contain null or empty fields, but should contain valid field
 !sqlWithComment.contains("null_key")
 !sqlWithComment.contains("empty_key")
 sqlWithComment.contains("valid_key='valid_value'")
 sqlWithComment.startsWith("SELECT * FROM foo /*")
 sqlWithComment.endsWith("*/")
 }
}
Loading