Skip to content
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.

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

Add host and db name to tags injected in SQL comments #6778

Merged
merged 2 commits into from
Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@ public class SQLCommenterBenchmark {

private static final String traceParent =
"00-00000000000000007fffffffffffffff-000000024cb016ea-01";
private static final String injectionMode = "full";
private static final String dbService = "users-db";
private static final String hostname = "my-host";
private static final String dbName = "credit-card-numbers";
private static final String parentService = "parent";
private static final String env = "env";
private static final String version = "version";
Expand All @@ -26,6 +27,14 @@ public class SQLCommenterBenchmark {
public void testToComment() {
StringBuilder stringBuilder = new StringBuilder();
SQLCommenter.toComment(
stringBuilder, injectTrace, parentService, dbService, env, version, traceParent);
stringBuilder,
injectTrace,
parentService,
dbService,
hostname,
dbName,
env,
version,
traceParent);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,21 @@ public static String onEnter(
JDBCDecorator.parseDBInfo(
connection, InstrumentationContext.get(Connection.class, DBInfo.class));
if (dbInfo.getType().equals("sqlserver")) {
sql = SQLCommenter.append(sql, DECORATE.getDbService(dbInfo), dbInfo.getType());
sql =
SQLCommenter.append(
sql,
DECORATE.getDbService(dbInfo),
dbInfo.getType(),
dbInfo.getHost(),
dbInfo.getDb());
} else {
sql = SQLCommenter.prepend(sql, DECORATE.getDbService(dbInfo), dbInfo.getType());
sql =
SQLCommenter.prepend(
sql,
DECORATE.getDbService(dbInfo),
dbInfo.getType(),
dbInfo.getHost(),
dbInfo.getDb());
}
return inputSql;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ public class SQLCommenter {
private static final String UTF8 = StandardCharsets.UTF_8.toString();
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_ENV = encode("dde");
private static final String DD_VERSION = encode("ddpv");
private static final String TRACEPARENT = encode("traceparent");
Expand All @@ -24,18 +26,30 @@ public class SQLCommenter {
private static final String CLOSE_COMMENT = "*/";
private static final int INITIAL_CAPACITY = computeInitialCapacity();

public static String append(final String sql, final String dbService, final String dbType) {
return inject(sql, dbService, dbType, null, false, true);
public static String append(
final String sql,
final String dbService,
final String dbType,
final String hostname,
final String dbName) {
return inject(sql, dbService, dbType, hostname, dbName, null, false, true);
}

public static String prepend(final String sql, final String dbService, final String dbType) {
return inject(sql, dbService, dbType, null, false, false);
public static String prepend(
final String sql,
final String dbService,
final String dbType,
final String hostname,
final String dbName) {
return inject(sql, dbService, dbType, hostname, dbName, null, false, false);
}

public static String inject(
final String sql,
final String dbService,
final String dbType,
final String hostname,
final String dbName,
final String traceParent,
final boolean injectTrace,
final boolean appendComment) {
Expand Down Expand Up @@ -72,12 +86,30 @@ public static String inject(
sb.append(SPACE);
sb.append(OPEN_COMMENT);
commentAdded =
toComment(sb, injectTrace, parentService, dbService, env, version, traceParent);
toComment(
sb,
injectTrace,
parentService,
dbService,
hostname,
dbName,
env,
version,
traceParent);
sb.append(CLOSE_COMMENT);
} else {
sb.append(OPEN_COMMENT);
commentAdded =
toComment(sb, injectTrace, parentService, dbService, env, version, traceParent);
toComment(
sb,
injectTrace,
parentService,
dbService,
hostname,
dbName,
env,
version,
traceParent);
sb.append(CLOSE_COMMENT);
sb.append(SPACE);
sb.append(sql);
Expand Down Expand Up @@ -106,6 +138,10 @@ private static boolean hasDDComment(String sql, final boolean appendComment) {
found = true;
} else if (hasMatchingSubstring(sql, startIdx, DATABASE_SERVICE)) {
found = true;
} else if (hasMatchingSubstring(sql, startIdx, DD_HOSTNAME)) {
found = true;
} else if (hasMatchingSubstring(sql, startIdx, DD_DB_NAME)) {
found = true;
} else if (hasMatchingSubstring(sql, startIdx, DD_ENV)) {
found = true;
} else if (hasMatchingSubstring(sql, startIdx, DD_VERSION)) {
Expand Down Expand Up @@ -141,12 +177,16 @@ protected static boolean toComment(
final boolean injectTrace,
final String parentService,
final String dbService,
final String hostname,
final String dbName,
final String env,
final String version,
final String traceparent) {
int emptySize = sb.length();
append(sb, PARENT_SERVICE, parentService, false);
append(sb, DATABASE_SERVICE, dbService, sb.length() > emptySize);
append(sb, DD_HOSTNAME, hostname, sb.length() > emptySize);
append(sb, DD_DB_NAME, dbName, sb.length() > emptySize);
append(sb, DD_ENV, env, sb.length() > emptySize);
append(sb, DD_VERSION, version, sb.length() > emptySize);
if (injectTrace) {
Expand Down Expand Up @@ -203,6 +243,8 @@ private static int computeInitialCapacity() {
int tagKeysLen =
PARENT_SERVICE.length()
+ DATABASE_SERVICE.length()
+ DD_HOSTNAME.length()
+ DD_DB_NAME.length()
+ DD_ENV.length()
+ DD_VERSION.length()
+ TRACEPARENT.length();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@ public static AgentScope onEnter(
sql,
span.getServiceName(),
dbInfo.getType(),
dbInfo.getHost(),
dbInfo.getDb(),
traceParent,
injectTraceContext,
appendComment);
Expand Down
Loading
Loading