Skip to content

Commit decac55

Browse files
authored
Rename debugger symbol to symbol database (#8339)
debuggerSymbol -> SymbolDatabase make it less tight to debugger Remove unused config DD_SYMBOL_DATABASE_INCLUDES (should be third party includes)
1 parent 1083178 commit decac55

File tree

7 files changed

+48
-49
lines changed

7 files changed

+48
-49
lines changed

dd-java-agent/agent-debugger/src/main/java/com/datadog/debugger/agent/DebuggerAgent.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,15 +146,15 @@ private static void startDynamicInstrumentation(
146146
}
147147
configurationPoller = sco.configurationPoller(config);
148148
if (configurationPoller != null) {
149-
if (config.isDebuggerSymbolEnabled()) {
149+
if (config.isSymbolDatabaseEnabled()) {
150150
symDBEnablement =
151151
new SymDBEnablement(
152152
instrumentation,
153153
config,
154154
new SymbolAggregator(
155-
debuggerSink.getSymbolSink(), config.getDebuggerSymbolFlushThreshold()),
155+
debuggerSink.getSymbolSink(), config.getSymbolDatabaseFlushThreshold()),
156156
classNameFilter);
157-
if (config.isDebuggerSymbolForceUpload()) {
157+
if (config.isSymbolDatabaseForceUpload()) {
158158
symDBEnablement.startSymbolExtraction();
159159
}
160160
}
@@ -249,7 +249,7 @@ private static void subscribeConfigurationPoller(
249249
LOGGER.debug("Subscribing to Live Debugging...");
250250
configurationPoller.addListener(
251251
Product.LIVE_DEBUGGING, new DebuggerProductChangesListener(config, configurationUpdater));
252-
if (symDBEnablement != null && !config.isDebuggerSymbolForceUpload()) {
252+
if (symDBEnablement != null && !config.isSymbolDatabaseForceUpload()) {
253253
LOGGER.debug("Subscribing to Symbol DB...");
254254
configurationPoller.addListener(Product.LIVE_DEBUGGING_SYMBOL_DB, symDBEnablement);
255255
}

dd-java-agent/agent-debugger/src/main/java/com/datadog/debugger/sink/SymbolSink.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public SymbolSink(Config config) {
6363
this.version = TagsHelper.sanitize(config.getVersion());
6464
this.symbolUploader = symbolUploader;
6565
this.maxPayloadSize = maxPayloadSize;
66-
this.isCompressed = config.isDebuggerSymbolCompressed();
66+
this.isCompressed = config.isSymbolDatabaseCompressed();
6767
byte[] eventContent =
6868
String.format(
6969
EVENT_FORMAT, TagsHelper.sanitize(config.getServiceName()), config.getRuntimeId())

dd-java-agent/agent-debugger/src/test/java/com/datadog/debugger/sink/SymbolSinkTest.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public void testSimpleFlush() {
2323
SymbolUploaderMock symbolUploaderMock = new SymbolUploaderMock();
2424
Config config = mock(Config.class);
2525
when(config.getServiceName()).thenReturn("service1");
26-
when(config.isDebuggerSymbolCompressed()).thenReturn(false);
26+
when(config.isSymbolDatabaseCompressed()).thenReturn(false);
2727
SymbolSink symbolSink = new SymbolSink(config, symbolUploaderMock, MAX_SYMDB_UPLOAD_SIZE);
2828
symbolSink.addScope(Scope.builder(ScopeType.JAR, null, 0, 0).build());
2929
symbolSink.flush();
@@ -47,7 +47,7 @@ public void testMultiScopeFlush() {
4747
SymbolUploaderMock symbolUploaderMock = new SymbolUploaderMock();
4848
Config config = mock(Config.class);
4949
when(config.getServiceName()).thenReturn("service1");
50-
when(config.isDebuggerSymbolCompressed()).thenReturn(false);
50+
when(config.isSymbolDatabaseCompressed()).thenReturn(false);
5151
SymbolSink symbolSink = new SymbolSink(config, symbolUploaderMock, MAX_SYMDB_UPLOAD_SIZE);
5252
symbolSink.addScope(Scope.builder(ScopeType.JAR, "jar1.jar", 0, 0).build());
5353
symbolSink.addScope(Scope.builder(ScopeType.JAR, "jar2.jar", 0, 0).build());
@@ -64,7 +64,7 @@ public void testQueueFull() {
6464
SymbolUploaderMock symbolUploaderMock = new SymbolUploaderMock();
6565
Config config = mock(Config.class);
6666
when(config.getServiceName()).thenReturn("service1");
67-
when(config.isDebuggerSymbolCompressed()).thenReturn(false);
67+
when(config.isSymbolDatabaseCompressed()).thenReturn(false);
6868
SymbolSink symbolSink = new SymbolSink(config, symbolUploaderMock, MAX_SYMDB_UPLOAD_SIZE);
6969
for (int i = 0; i < SymbolSink.CAPACITY; i++) {
7070
symbolSink.addScope(Scope.builder(ScopeType.JAR, "jar1.jar", 0, 0).build());
@@ -88,7 +88,7 @@ public void splitByJarScopes() {
8888
SymbolUploaderMock symbolUploaderMock = new SymbolUploaderMock();
8989
Config config = mock(Config.class);
9090
when(config.getServiceName()).thenReturn("service1");
91-
when(config.isDebuggerSymbolCompressed()).thenReturn(false);
91+
when(config.isSymbolDatabaseCompressed()).thenReturn(false);
9292
SymbolSink symbolSink = new SymbolSink(config, symbolUploaderMock, 1024);
9393
final int NUM_JAR_SCOPES = 10;
9494
for (int i = 0; i < NUM_JAR_SCOPES; i++) {
@@ -111,7 +111,7 @@ public void splitTootManyJarScopes() {
111111
SymbolUploaderMock symbolUploaderMock = new SymbolUploaderMock();
112112
Config config = mock(Config.class);
113113
when(config.getServiceName()).thenReturn("service1");
114-
when(config.isDebuggerSymbolCompressed()).thenReturn(false);
114+
when(config.isSymbolDatabaseCompressed()).thenReturn(false);
115115
SymbolSink symbolSink = new SymbolSink(config, symbolUploaderMock, 2048);
116116
final int NUM_JAR_SCOPES = 21;
117117
for (int i = 0; i < NUM_JAR_SCOPES; i++) {
@@ -136,7 +136,7 @@ public void splitByClassScopes() {
136136
SymbolUploaderMock symbolUploaderMock = new SymbolUploaderMock();
137137
Config config = mock(Config.class);
138138
when(config.getServiceName()).thenReturn("service1");
139-
when(config.isDebuggerSymbolCompressed()).thenReturn(false);
139+
when(config.isSymbolDatabaseCompressed()).thenReturn(false);
140140
SymbolSink symbolSink = new SymbolSink(config, symbolUploaderMock, 1024);
141141
final int NUM_CLASS_SCOPES = 10;
142142
List<Scope> classScopes = new ArrayList<>();
@@ -178,7 +178,7 @@ public void splitByClassScopesImpossible() {
178178
SymbolUploaderMock symbolUploaderMock = new SymbolUploaderMock();
179179
Config config = mock(Config.class);
180180
when(config.getServiceName()).thenReturn("service1");
181-
when(config.isDebuggerSymbolCompressed()).thenReturn(false);
181+
when(config.isSymbolDatabaseCompressed()).thenReturn(false);
182182
SymbolSink symbolSink = new SymbolSink(config, symbolUploaderMock, 1);
183183
final int NUM_CLASS_SCOPES = 10;
184184
List<Scope> classScopes = new ArrayList<>();

dd-java-agent/agent-debugger/src/test/java/com/datadog/debugger/symbol/SymDBEnablementTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public void before() {
5050
when(instr.isModifiableClass(any())).thenReturn(true);
5151
config = mock(Config.class);
5252
when(config.getThirdPartyIncludes()).thenReturn(Collections.singleton("com.datadog.debugger"));
53-
when(config.isDebuggerSymbolEnabled()).thenReturn(true);
53+
when(config.isSymbolDatabaseEnabled()).thenReturn(true);
5454
symbolSink = mock(SymbolSink.class);
5555
}
5656

dd-trace-api/src/main/java/datadog/trace/api/ConfigDefaults.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -186,10 +186,10 @@ public final class ConfigDefaults {
186186
static final boolean DEFAULT_DYNAMIC_INSTRUMENTATION_INSTRUMENT_THE_WORLD = false;
187187
static final int DEFAULT_DYNAMIC_INSTRUMENTATION_CAPTURE_TIMEOUT = 100; // milliseconds
188188
static final boolean DEFAULT_DYNAMIC_INSTRUMENTATION_HOIST_LOCALVARS_ENABLED = false;
189-
static final boolean DEFAULT_DEBUGGER_SYMBOL_ENABLED = true;
190-
static final boolean DEFAULT_DEBUGGER_SYMBOL_FORCE_UPLOAD = false;
191-
static final int DEFAULT_DEBUGGER_SYMBOL_FLUSH_THRESHOLD = 100; // nb of classes
192-
static final boolean DEFAULT_DEBUGGER_SYMBOL_COMPRESSED = true;
189+
static final boolean DEFAULT_SYMBOL_DATABASE_ENABLED = true;
190+
static final boolean DEFAULT_SYMBOL_DATABASE_FORCE_UPLOAD = false;
191+
static final int DEFAULT_SYMBOL_DATABASE_FLUSH_THRESHOLD = 100; // nb of classes
192+
static final boolean DEFAULT_SYMBOL_DATABASE_COMPRESSED = true;
193193
static final boolean DEFAULT_DEBUGGER_EXCEPTION_ENABLED = false;
194194
static final int DEFAULT_DEBUGGER_MAX_EXCEPTION_PER_SECOND = 100;
195195
static final boolean DEFAULT_DEBUGGER_EXCEPTION_ONLY_LOCAL_ROOT = false;

dd-trace-api/src/main/java/datadog/trace/api/config/DebuggerConfig.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,10 @@ public final class DebuggerConfig {
4040
"dynamic.instrumentation.redacted.types";
4141
public static final String DYNAMIC_INSTRUMENTATION_HOIST_LOCALVARS_ENABLED =
4242
"dynamic.instrumentation.hoist.localvars.enabled";
43-
public static final String DEBUGGER_SYMBOL_ENABLED = "symbol.database.upload.enabled";
44-
public static final String DEBUGGER_SYMBOL_FORCE_UPLOAD = "internal.force.symbol.database.upload";
45-
public static final String DEBUGGER_SYMBOL_INCLUDES = "symbol.database.includes";
46-
public static final String DEBUGGER_SYMBOL_FLUSH_THRESHOLD = "symbol.database.flush.threshold";
47-
public static final String DEBUGGER_SYMBOL_COMPRESSED = "symbol.database.compressed";
43+
public static final String SYMBOL_DATABASE_ENABLED = "symbol.database.upload.enabled";
44+
public static final String SYMBOL_DATABASE_FORCE_UPLOAD = "internal.force.symbol.database.upload";
45+
public static final String SYMBOL_DATABASE_FLUSH_THRESHOLD = "symbol.database.flush.threshold";
46+
public static final String SYMBOL_DATABASE_COMPRESSED = "symbol.database.compressed";
4847
public static final String DEBUGGER_EXCEPTION_ENABLED = "exception.debugging.enabled";
4948
public static final String EXCEPTION_REPLAY_ENABLED = "exception.replay.enabled";
5049
public static final String DEBUGGER_MAX_EXCEPTION_PER_SECOND =

internal-api/src/main/java/datadog/trace/api/Config.java

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -410,11 +410,10 @@ public static String getHostName() {
410410
private final Set<String> dynamicInstrumentationRedactionExcludedIdentifiers;
411411
private final String dynamicInstrumentationRedactedTypes;
412412
private final boolean dynamicInstrumentationHoistLocalVarsEnabled;
413-
private final boolean debuggerSymbolEnabled;
414-
private final boolean debuggerSymbolForceUpload;
415-
private final String debuggerSymbolIncludes;
416-
private final int debuggerSymbolFlushThreshold;
417-
private final boolean debuggerSymbolCompressed;
413+
private final boolean symbolDatabaseEnabled;
414+
private final boolean symbolDatabaseForceUpload;
415+
private final int symbolDatabaseFlushThreshold;
416+
private final boolean symbolDatabaseCompressed;
418417
private final boolean debuggerExceptionEnabled;
419418
private final int debuggerMaxExceptionPerSecond;
420419
@Deprecated private final boolean debuggerExceptionOnlyLocalRoot;
@@ -1617,17 +1616,16 @@ PROFILING_DATADOG_PROFILER_ENABLED, isDatadogProfilerSafeInCurrentEnvironment())
16171616
configProvider.getBoolean(
16181617
DYNAMIC_INSTRUMENTATION_HOIST_LOCALVARS_ENABLED,
16191618
DEFAULT_DYNAMIC_INSTRUMENTATION_HOIST_LOCALVARS_ENABLED);
1620-
debuggerSymbolEnabled =
1621-
configProvider.getBoolean(DEBUGGER_SYMBOL_ENABLED, DEFAULT_DEBUGGER_SYMBOL_ENABLED);
1622-
debuggerSymbolForceUpload =
1619+
symbolDatabaseEnabled =
1620+
configProvider.getBoolean(SYMBOL_DATABASE_ENABLED, DEFAULT_SYMBOL_DATABASE_ENABLED);
1621+
symbolDatabaseForceUpload =
16231622
configProvider.getBoolean(
1624-
DEBUGGER_SYMBOL_FORCE_UPLOAD, DEFAULT_DEBUGGER_SYMBOL_FORCE_UPLOAD);
1625-
debuggerSymbolIncludes = configProvider.getString(DEBUGGER_SYMBOL_INCLUDES, null);
1626-
debuggerSymbolFlushThreshold =
1623+
SYMBOL_DATABASE_FORCE_UPLOAD, DEFAULT_SYMBOL_DATABASE_FORCE_UPLOAD);
1624+
symbolDatabaseFlushThreshold =
16271625
configProvider.getInteger(
1628-
DEBUGGER_SYMBOL_FLUSH_THRESHOLD, DEFAULT_DEBUGGER_SYMBOL_FLUSH_THRESHOLD);
1629-
debuggerSymbolCompressed =
1630-
configProvider.getBoolean(DEBUGGER_SYMBOL_COMPRESSED, DEFAULT_DEBUGGER_SYMBOL_COMPRESSED);
1626+
SYMBOL_DATABASE_FLUSH_THRESHOLD, DEFAULT_SYMBOL_DATABASE_FLUSH_THRESHOLD);
1627+
symbolDatabaseCompressed =
1628+
configProvider.getBoolean(SYMBOL_DATABASE_COMPRESSED, DEFAULT_SYMBOL_DATABASE_COMPRESSED);
16311629
debuggerExceptionEnabled =
16321630
configProvider.getBoolean(
16331631
DEBUGGER_EXCEPTION_ENABLED,
@@ -3109,20 +3107,20 @@ public int getDynamicInstrumentationCaptureTimeout() {
31093107
return dynamicInstrumentationCaptureTimeout;
31103108
}
31113109

3112-
public boolean isDebuggerSymbolEnabled() {
3113-
return debuggerSymbolEnabled;
3110+
public boolean isSymbolDatabaseEnabled() {
3111+
return symbolDatabaseEnabled;
31143112
}
31153113

3116-
public boolean isDebuggerSymbolForceUpload() {
3117-
return debuggerSymbolForceUpload;
3114+
public boolean isSymbolDatabaseForceUpload() {
3115+
return symbolDatabaseForceUpload;
31183116
}
31193117

3120-
public int getDebuggerSymbolFlushThreshold() {
3121-
return debuggerSymbolFlushThreshold;
3118+
public int getSymbolDatabaseFlushThreshold() {
3119+
return symbolDatabaseFlushThreshold;
31223120
}
31233121

3124-
public boolean isDebuggerSymbolCompressed() {
3125-
return debuggerSymbolCompressed;
3122+
public boolean isSymbolDatabaseCompressed() {
3123+
return symbolDatabaseCompressed;
31263124
}
31273125

31283126
public boolean isDebuggerExceptionEnabled() {
@@ -4532,13 +4530,15 @@ public String toString() {
45324530
+ ", debuggerRedactTypes="
45334531
+ dynamicInstrumentationRedactedTypes
45344532
+ ", debuggerSymbolEnabled="
4535-
+ debuggerSymbolEnabled
4533+
+ symbolDatabaseEnabled
45364534
+ ", debuggerSymbolForceUpload="
4537-
+ debuggerSymbolForceUpload
4535+
+ symbolDatabaseForceUpload
45384536
+ ", debuggerSymbolFlushThreshold="
4539-
+ debuggerSymbolFlushThreshold
4540-
+ ", debuggerSymbolIncludes="
4541-
+ debuggerSymbolIncludes
4537+
+ symbolDatabaseFlushThreshold
4538+
+ ", thirdPartyIncludes="
4539+
+ debuggerThirdPartyIncludes
4540+
+ ", thirdPartyExcludes="
4541+
+ debuggerThirdPartyExcludes
45424542
+ ", debuggerExceptionEnabled="
45434543
+ debuggerExceptionEnabled
45444544
+ ", debuggerCodeOriginEnabled="

0 commit comments

Comments
 (0)