Add SymDB report for any jar scanning failures

jpbempel · jpbempel · commit a2ffb7653c75 · 2025-01-29T14:48:57.000+01:00
Any bail out when resolving or scanning for jars will be reported
into SymDBReport and logged as a single INFO log line at the end
of SYMDB extraction process from SymDB enablement
diff --git a/dd-java-agent/agent-debugger/src/main/java/com/datadog/debugger/symbol/JarScanner.java b/dd-java-agent/agent-debugger/src/main/java/com/datadog/debugger/symbol/JarScanner.java
@@ -19,11 +19,12 @@ public class JarScanner {
   private static final String SPRING_CLASSES_PREFIX = "BOOT-INF/classes/";
   private static final String SPRING_DEPS_PREFIX = "BOOT-INF/lib/";
 
-  public static Path extractJarPath(Class<?> clazz) throws URISyntaxException {
-    return extractJarPath(clazz.getProtectionDomain());
+  public static Path extractJarPath(Class<?> clazz, SymDBReport symDBReport)
+      throws URISyntaxException {
+    return extractJarPath(clazz.getProtectionDomain(), symDBReport);
   }
 
-  public static Path extractJarPath(ProtectionDomain protectionDomain) throws URISyntaxException {
+  public static Path extractJarPath(ProtectionDomain protectionDomain, SymDBReport symDBReport) {
     if (protectionDomain == null) {
       return null;
     }
@@ -50,6 +51,9 @@ public static Path extractJarPath(ProtectionDomain protectionDomain) throws URIS
     } else if (locationStr.startsWith(FILE_PREFIX)) {
       return getPathFromPrefixedFileName(locationStr, FILE_PREFIX, locationStr.length());
     }
+    if (symDBReport != null) {
+      symDBReport.addLocationError(locationStr);
+    }
     return null;
   }
 
diff --git a/dd-java-agent/agent-debugger/src/main/java/com/datadog/debugger/symbol/SymDBEnablement.java b/dd-java-agent/agent-debugger/src/main/java/com/datadog/debugger/symbol/SymDBEnablement.java
@@ -119,7 +119,9 @@ public void startSymbolExtraction() {
         symbolExtractionTransformer =
             new SymbolExtractionTransformer(symbolAggregator, classNameFilter);
         instrumentation.addTransformer(symbolExtractionTransformer);
-        extractSymbolForLoadedClasses();
+        SymDBReport symDBReport = new SymDBReport();
+        extractSymbolForLoadedClasses(symDBReport);
+        symDBReport.report();
         lastUploadTimestamp = System.currentTimeMillis();
       } catch (Throwable ex) {
         // catch all Throwables because LinkageError is possible (duplicate class definition)
@@ -130,7 +132,7 @@ public void startSymbolExtraction() {
     }
   }
 
-  private void extractSymbolForLoadedClasses() {
+  private void extractSymbolForLoadedClasses(SymDBReport symDBReport) {
     Class<?>[] classesToExtract;
     try {
       classesToExtract =
@@ -148,19 +150,21 @@ private void extractSymbolForLoadedClasses() {
     for (Class<?> clazz : classesToExtract) {
       Path jarPath;
       try {
-        jarPath = JarScanner.extractJarPath(clazz);
+        jarPath = JarScanner.extractJarPath(clazz, symDBReport);
       } catch (URISyntaxException e) {
         throw new RuntimeException(e);
       }
       if (jarPath == null) {
         continue;
       }
       if (!Files.exists(jarPath)) {
+        symDBReport.addMissingJar(jarPath.toString());
         continue;
       }
       File jarPathFile = jarPath.toFile();
       if (jarPathFile.isDirectory()) {
         // we are not supporting class directories (classpath) but only jar files
+        symDBReport.addDirectoryJar(jarPath.toString());
         continue;
       }
       if (alreadyScannedJars.contains(jarPath.toString())) {
@@ -178,6 +182,7 @@ private void extractSymbolForLoadedClasses() {
         }
         alreadyScannedJars.add(jarPath.toString());
       } catch (IOException e) {
+        symDBReport.addIOException(jarPath.toString(), e);
         throw new RuntimeException(e);
       }
     }
diff --git a/dd-java-agent/agent-debugger/src/main/java/com/datadog/debugger/symbol/SymDBReport.java b/dd-java-agent/agent-debugger/src/main/java/com/datadog/debugger/symbol/SymDBReport.java
@@ -0,0 +1,49 @@
+package com.datadog.debugger.symbol;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class SymDBReport {
+  private static final Logger LOGGER = LoggerFactory.getLogger(SymDBReport.class);
+
+  private final Set<String> missingJars = new HashSet<>();
+  private final Set<String> directoryJars = new HashSet<>();
+  private final Map<String, String> ioExceptions = new HashMap<>();
+  private final List<String> locationErrors = new ArrayList<>();
+
+  public void addMissingJar(String jarPath) {
+    missingJars.add(jarPath);
+  }
+
+  public void addDirectoryJar(String jarPath) {
+    directoryJars.add(jarPath);
+  }
+
+  public void addIOException(String jarPath, IOException e) {
+    ioExceptions.put(jarPath, e.toString());
+  }
+
+  public void addLocationError(String locationStr) {
+    locationErrors.add(locationStr);
+  }
+
+  public void report() {
+    String content =
+        "== SymDB Report == Location errors:"
+            + locationErrors
+            + " Missing jars: "
+            + missingJars
+            + " Directory jars: "
+            + directoryJars
+            + " IOExceptions: "
+            + ioExceptions;
+    LOGGER.info(content);
+  }
+}
diff --git a/dd-java-agent/agent-debugger/src/main/java/com/datadog/debugger/symbol/SymbolAggregator.java b/dd-java-agent/agent-debugger/src/main/java/com/datadog/debugger/symbol/SymbolAggregator.java
@@ -43,7 +43,7 @@ public void parseClass(
       String className, byte[] classfileBuffer, ProtectionDomain protectionDomain) {
     try {
       String jarName = "DEFAULT";
-      Path jarPath = JarScanner.extractJarPath(protectionDomain);
+      Path jarPath = JarScanner.extractJarPath(protectionDomain, null);
       if (jarPath != null && Files.exists(jarPath)) {
         LOGGER.debug("jarpath: {}", jarPath);
         jarName = jarPath.toString();
diff --git a/dd-java-agent/agent-debugger/src/test/java/com/datadog/debugger/symbol/JarScannerTest.java b/dd-java-agent/agent-debugger/src/test/java/com/datadog/debugger/symbol/JarScannerTest.java
@@ -22,10 +22,10 @@ public void extractJarPathFromJar()
     URL jarUrl = new URL("jar:file:" + jarFileUrl.getFile() + "!/");
     URLClassLoader urlClassLoader = new URLClassLoader(new URL[] {jarUrl}, null);
     Class<?> testClass = urlClassLoader.loadClass(CLASS_NAME);
-    assertEquals(jarFileUrl.getFile(), JarScanner.extractJarPath(testClass).toString());
+    assertEquals(jarFileUrl.getFile(), JarScanner.extractJarPath(testClass, null).toString());
     assertEquals(
         jarFileUrl.getFile(),
-        JarScanner.extractJarPath(testClass.getProtectionDomain()).toString());
+        JarScanner.extractJarPath(testClass.getProtectionDomain(), null).toString());
   }
 
   @Test
@@ -34,7 +34,7 @@ public void extractJarPathFromFile() throws ClassNotFoundException, URISyntaxExc
     URL jarFileUrl = getClass().getResource("/debugger-symbol.jar");
     URLClassLoader urlClassLoader = new URLClassLoader(new URL[] {jarFileUrl}, null);
     Class<?> testClass = urlClassLoader.loadClass(CLASS_NAME);
-    assertEquals(jarFileUrl.getFile(), JarScanner.extractJarPath(testClass).toString());
+    assertEquals(jarFileUrl.getFile(), JarScanner.extractJarPath(testClass, null).toString());
   }
 
   @Test
@@ -45,6 +45,7 @@ public void extractJarPathFromNestedJar() throws URISyntaxException {
         .thenReturn("jar:nested:" + jarFileUrl.getFile() + "/!BOOT-INF/classes/!");
     CodeSource codeSource = new CodeSource(mockLocation, (Certificate[]) null);
     ProtectionDomain protectionDomain = new ProtectionDomain(codeSource, null);
-    assertEquals(jarFileUrl.getFile(), JarScanner.extractJarPath(protectionDomain).toString());
+    assertEquals(
+        jarFileUrl.getFile(), JarScanner.extractJarPath(protectionDomain, null).toString());
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -19,11 +19,12 @@ public class JarScanner {`
`19`	`19`	`private static final String SPRING_CLASSES_PREFIX = "BOOT-INF/classes/";`
`20`	`20`	`private static final String SPRING_DEPS_PREFIX = "BOOT-INF/lib/";`
`21`	`21`
`22`		`- public static Path extractJarPath(Class<?> clazz) throws URISyntaxException {`
`23`		`- return extractJarPath(clazz.getProtectionDomain());`
	`22`	`+ public static Path extractJarPath(Class<?> clazz, SymDBReport symDBReport)`
	`23`	`+ throws URISyntaxException {`
	`24`	`+ return extractJarPath(clazz.getProtectionDomain(), symDBReport);`
`24`	`25`	`}`
`25`	`26`
`26`		`- public static Path extractJarPath(ProtectionDomain protectionDomain) throws URISyntaxException {`
	`27`	`+ public static Path extractJarPath(ProtectionDomain protectionDomain, SymDBReport symDBReport) {`
`27`	`28`	`if (protectionDomain == null) {`
`28`	`29`	`return null;`
`29`	`30`	`}`
`@@ -50,6 +51,9 @@ public static Path extractJarPath(ProtectionDomain protectionDomain) throws URIS`
`50`	`51`	`} else if (locationStr.startsWith(FILE_PREFIX)) {`
`51`	`52`	`return getPathFromPrefixedFileName(locationStr, FILE_PREFIX, locationStr.length());`
`52`	`53`	`}`
	`54`	`+ if (symDBReport != null) {`
	`55`	`+ symDBReport.addLocationError(locationStr);`
	`56`	`+ }`
`53`	`57`	`return null;`
`54`	`58`	`}`
`55`	`59`
Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,9 @@ public void startSymbolExtraction() {`
`119`	`119`	`symbolExtractionTransformer =`
`120`	`120`	`new SymbolExtractionTransformer(symbolAggregator, classNameFilter);`
`121`	`121`	`instrumentation.addTransformer(symbolExtractionTransformer);`
`122`		`- extractSymbolForLoadedClasses();`
	`122`	`+ SymDBReport symDBReport = new SymDBReport();`
	`123`	`+ extractSymbolForLoadedClasses(symDBReport);`
	`124`	`+ symDBReport.report();`
`123`	`125`	`lastUploadTimestamp = System.currentTimeMillis();`
`124`	`126`	`} catch (Throwable ex) {`
`125`	`127`	`// catch all Throwables because LinkageError is possible (duplicate class definition)`
`@@ -130,7 +132,7 @@ public void startSymbolExtraction() {`
`130`	`132`	`}`
`131`	`133`	`}`
`132`	`134`
`133`		`- private void extractSymbolForLoadedClasses() {`
	`135`	`+ private void extractSymbolForLoadedClasses(SymDBReport symDBReport) {`
`134`	`136`	`Class<?>[] classesToExtract;`
`135`	`137`	`try {`
`136`	`138`	`classesToExtract =`
`@@ -148,19 +150,21 @@ private void extractSymbolForLoadedClasses() {`
`148`	`150`	`for (Class<?> clazz : classesToExtract) {`
`149`	`151`	`Path jarPath;`
`150`	`152`	`try {`
`151`		`- jarPath = JarScanner.extractJarPath(clazz);`
	`153`	`+ jarPath = JarScanner.extractJarPath(clazz, symDBReport);`
`152`	`154`	`} catch (URISyntaxException e) {`
`153`	`155`	`throw new RuntimeException(e);`
`154`	`156`	`}`
`155`	`157`	`if (jarPath == null) {`
`156`	`158`	`continue;`
`157`	`159`	`}`
`158`	`160`	`if (!Files.exists(jarPath)) {`
	`161`	`+ symDBReport.addMissingJar(jarPath.toString());`
`159`	`162`	`continue;`
`160`	`163`	`}`
`161`	`164`	`File jarPathFile = jarPath.toFile();`
`162`	`165`	`if (jarPathFile.isDirectory()) {`
`163`	`166`	`// we are not supporting class directories (classpath) but only jar files`
	`167`	`+ symDBReport.addDirectoryJar(jarPath.toString());`
`164`	`168`	`continue;`
`165`	`169`	`}`
`166`	`170`	`if (alreadyScannedJars.contains(jarPath.toString())) {`
`@@ -178,6 +182,7 @@ private void extractSymbolForLoadedClasses() {`
`178`	`182`	`}`
`179`	`183`	`alreadyScannedJars.add(jarPath.toString());`
`180`	`184`	`} catch (IOException e) {`
	`185`	`+ symDBReport.addIOException(jarPath.toString(), e);`
`181`	`186`	`throw new RuntimeException(e);`
`182`	`187`	`}`
`183`	`188`	`}`