Add support for DBM comment injection with MongoDB #9589
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -50,6 +50,10 @@ out/ | |
| ########## | ||
| .cursor | ||
|
|
||
| # Vim # | ||
| ####### | ||
| *.sw[nop] | ||
|
|
||
| # Others # | ||
| ########## | ||
| /logs/* | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| package datadog.trace.bootstrap.instrumentation.dbm; | ||
|
|
||
| import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activeSpan; | ||
|
|
||
| import datadog.trace.api.BaseHash; | ||
| import datadog.trace.api.Config; | ||
| import datadog.trace.bootstrap.instrumentation.api.AgentSpan; | ||
| import datadog.trace.bootstrap.instrumentation.api.Tags; | ||
| import java.io.UnsupportedEncodingException; | ||
| import java.net.URLEncoder; | ||
| import java.nio.charset.StandardCharsets; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** Shared database comment builder for generating trace context comments for SQL DBs and MongoDB */ | ||
| public class SharedDBCommenter { | ||
| private static final Logger log = LoggerFactory.getLogger(SharedDBCommenter.class); | ||
| private static final String UTF8 = StandardCharsets.UTF_8.toString(); | ||
|
|
||
| private static final char EQUALS = '='; | ||
| private static final char COMMA = ','; | ||
| private static final char QUOTE = '\''; | ||
|
|
||
| // Injected fields. When adding a new one, be sure to update this and the methods below. | ||
| private static final String PARENT_SERVICE = encode("ddps"); | ||
| private static final String DATABASE_SERVICE = encode("dddbs"); | ||
| private static final String DD_HOSTNAME = encode("ddh"); | ||
| private static final String DD_DB_NAME = encode("dddb"); | ||
| private static final String DD_PEER_SERVICE = "ddprs"; | ||
| private static final String DD_ENV = encode("dde"); | ||
| private static final String DD_VERSION = encode("ddpv"); | ||
| private static final String TRACEPARENT = encode("traceparent"); | ||
| private static final String DD_SERVICE_HASH = encode("ddsh"); | ||
|
|
||
| // Used by SQLCommenter and MongoCommentInjector to avoid duplicate comment injection | ||
| public static boolean containsTraceComment(String commentContent) { | ||
| return commentContent.contains(PARENT_SERVICE + "=") | ||
| || commentContent.contains(DATABASE_SERVICE + "=") | ||
| || commentContent.contains(DD_HOSTNAME + "=") | ||
| || commentContent.contains(DD_DB_NAME + "=") | ||
| || commentContent.contains(DD_PEER_SERVICE + "=") | ||
| || commentContent.contains(DD_ENV + "=") | ||
| || commentContent.contains(DD_VERSION + "=") | ||
| || commentContent.contains(TRACEPARENT + "=") | ||
| || commentContent.contains(DD_SERVICE_HASH + "="); | ||
| } | ||
|
|
||
| // Build database comment content without comment delimiters such as /* */ | ||
| public static String buildComment( | ||
| String dbService, String dbType, String hostname, String dbName, String traceParent) { | ||
|
|
||
| Config config = Config.get(); | ||
| StringBuilder sb = new StringBuilder(); | ||
|
|
||
| int initSize = 0; // No initial content for pure comment | ||
| append(sb, PARENT_SERVICE, config.getServiceName(), initSize); | ||
| append(sb, DATABASE_SERVICE, dbService, initSize); | ||
| append(sb, DD_HOSTNAME, hostname, initSize); | ||
| append(sb, DD_DB_NAME, dbName, initSize); | ||
| append(sb, DD_PEER_SERVICE, getPeerService(), initSize); | ||
| append(sb, DD_ENV, config.getEnv(), initSize); | ||
| append(sb, DD_VERSION, config.getVersion(), initSize); | ||
| append(sb, TRACEPARENT, traceParent, initSize); | ||
|
|
||
| if (config.isDbmInjectSqlBaseHash() && config.isExperimentalPropagateProcessTagsEnabled()) { | ||
| append(sb, DD_SERVICE_HASH, BaseHash.getBaseHashStr(), initSize); | ||
| } | ||
|
|
||
| return sb.length() > 0 ? sb.toString() : null; | ||
| } | ||
|
|
||
| private static String getPeerService() { | ||
| AgentSpan span = activeSpan(); | ||
| Object peerService = null; | ||
| if (span != null) { | ||
| peerService = span.getTag(Tags.PEER_SERVICE); | ||
| } | ||
| return peerService != null ? peerService.toString() : null; | ||
| } | ||
|
|
||
| private static String encode(String val) { | ||
| try { | ||
| return URLEncoder.encode(val, UTF8); | ||
| } catch (UnsupportedEncodingException exe) { | ||
| if (log.isDebugEnabled()) { | ||
| log.debug("exception thrown while encoding comment key {}", val, exe); | ||
| } | ||
| } | ||
| return val; | ||
| } | ||
|
|
||
| private static void append(StringBuilder sb, String key, String value, int initSize) { | ||
| if (null == value || value.isEmpty()) { | ||
| return; | ||
| } | ||
| String encodedValue; | ||
| try { | ||
| encodedValue = URLEncoder.encode(value, UTF8); | ||
| } catch (UnsupportedEncodingException e) { | ||
| encodedValue = value; | ||
| } | ||
| if (sb.length() > initSize) { | ||
| sb.append(COMMA); | ||
| } | ||
| sb.append(key).append(EQUALS).append(QUOTE).append(encodedValue).append(QUOTE); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know you only moved that code, but I wonder after how many "contains" does a precompiled regex becomes more performant.