allow setting profiling-traces-dir-path independently from cache dir using external options

Author: lbloder

sentry/api/sentry.api

@@ -491,6 +491,7 @@ public final class io/sentry/ExternalOptions {
 	public fun getPrintUncaughtStackTrace ()Ljava/lang/Boolean;
 	public fun getProfileSessionSampleRate ()Ljava/lang/Double;
 	public fun getProfilesSampleRate ()Ljava/lang/Double;
+	public fun getProfilingTracesDirPath ()Ljava/lang/String;
 	public fun getProguardUuid ()Ljava/lang/String;
 	public fun getProxy ()Lio/sentry/SentryOptions$Proxy;
 	public fun getRelease ()Ljava/lang/String;
@@ -533,6 +534,7 @@ public final class io/sentry/ExternalOptions {
 	public fun setPrintUncaughtStackTrace (Ljava/lang/Boolean;)V
 	public fun setProfileSessionSampleRate (Ljava/lang/Double;)V
 	public fun setProfilesSampleRate (Ljava/lang/Double;)V
+	public fun setProfilingTracesDirPath (Ljava/lang/String;)V
 	public fun setProguardUuid (Ljava/lang/String;)V
 	public fun setProxy (Lio/sentry/SentryOptions$Proxy;)V
 	public fun setRelease (Ljava/lang/String;)V
@@ -3479,6 +3481,7 @@ public class io/sentry/SentryOptions {
 	public fun setProfileSessionSampleRate (Ljava/lang/Double;)V
 	public fun setProfilesSampleRate (Ljava/lang/Double;)V
 	public fun setProfilesSampler (Lio/sentry/SentryOptions$ProfilesSamplerCallback;)V
+	public fun setProfilingTracesDirPath (Ljava/lang/String;)V
 	public fun setProfilingTracesHz (I)V
 	public fun setProguardUuid (Ljava/lang/String;)V
 	public fun setProxy (Lio/sentry/SentryOptions$Proxy;)V

sentry/src/main/java/io/sentry/ExternalOptions.java

@@ -57,6 +57,7 @@ public final class ExternalOptions {
   private @Nullable Boolean captureOpenTelemetryEvents;
 
   private @Nullable Double profileSessionSampleRate;
+  private @Nullable String profilingTracesDirPath;
 
   private @Nullable SentryOptions.Cron cron;
 
@@ -207,6 +208,8 @@ public final class ExternalOptions {
     options.setProfileSessionSampleRate(
         propertiesProvider.getDoubleProperty("profile-session-sample-rate"));
 
+    options.setProfilingTracesDirPath(propertiesProvider.getProperty("profiling-traces-dir-path"));
+
     return options;
   }
 
@@ -543,4 +546,12 @@ public void setEnableLogs(final @Nullable Boolean enableLogs) {
   public void setProfileSessionSampleRate(@Nullable Double profileSessionSampleRate) {
     this.profileSessionSampleRate = profileSessionSampleRate;
   }
+
+  public @Nullable String getProfilingTracesDirPath() {
+    return profilingTracesDirPath;
+  }
+
+  public void setProfilingTracesDirPath(@Nullable String profilingTracesDirPath) {
+    this.profilingTracesDirPath = profilingTracesDirPath;
+  }
 }

sentry/src/main/java/io/sentry/Sentry.java

@@ -666,11 +666,16 @@ private static void initConfigurations(final @NotNull SentryOptions options) {
       options.getBackpressureMonitor().start();
     }
 
-    // TODO: make this configurable
-    if (options.isContinuousProfilingEnabled() && profilingTracesDirPath != null) {
+    if (options.isContinuousProfilingEnabled()
+        && profilingTracesDirPath != null
+        && options.getContinuousProfiler() == NoOpContinuousProfiler.getInstance()) {
       final IContinuousProfiler continuousProfiler =
           ProfilingServiceLoader.loadContinuousProfiler(
-              new SystemOutLogger(), profilingTracesDirPath, 10, options.getExecutorService());
+              new SystemOutLogger(),
+              profilingTracesDirPath,
+              options.getProfilingTracesHz(),
+              options.getExecutorService());
+
       options.setContinuousProfiler(continuousProfiler);
     }
 

sentry/src/main/java/io/sentry/SentryOptions.java

@@ -578,6 +578,8 @@ public class SentryOptions {
 
   private @NotNull ISocketTagger socketTagger = NoOpSocketTagger.getInstance();
 
+  private @Nullable String profilingTracesDirPath;
+
   /**
    * Adds an event processor
    *
@@ -2026,14 +2028,25 @@ public void setStartProfilerOnAppStart(final boolean startProfilerOnAppStart) {
    * @return the profiling traces dir. path or null if not set
    */
   public @Nullable String getProfilingTracesDirPath() {
+    if (profilingTracesDirPath != null && !profilingTracesDirPath.isEmpty()) {
+      return dsnHash != null
+          ? new File(profilingTracesDirPath, dsnHash).getAbsolutePath()
+          : profilingTracesDirPath;
+    }
+
     final String cacheDirPath = getCacheDirPath();
+
     if (cacheDirPath == null) {
-      // TODO: Should we add ExternalOptions to let users define the tracesDirPath?
-      return new File(".", "profiling_traces").getAbsolutePath();
+      return null;
     }
+
     return new File(cacheDirPath, "profiling_traces").getAbsolutePath();
   }
 
+  public void setProfilingTracesDirPath(final @Nullable String profilingTracesDirPath) {
+    this.profilingTracesDirPath = profilingTracesDirPath;
+  }
+
   /**
    * Returns a list of origins to which `sentry-trace` header should be sent in HTTP integrations.
    *
@@ -3223,6 +3236,10 @@ public void merge(final @NotNull ExternalOptions options) {
     if (options.getProfileSessionSampleRate() != null) {
       setProfileSessionSampleRate(options.getProfileSessionSampleRate());
     }
+
+    if (options.getProfilingTracesDirPath() != null) {
+      setProfilingTracesDirPath(options.getProfilingTracesDirPath());
+    }
   }
 
   private @NotNull SdkVersion createSdkVersion() {

sentry/src/test/java/io/sentry/ExternalOptionsTest.kt

@@ -383,6 +383,13 @@ class ExternalOptionsTest {
     }
   }
 
+  @Test
+  fun `creates options with profilingTracesDirPath set to profile_traces`() {
+    withPropertiesFile("profiling-traces-dir-path=profile_traces") { options ->
+      assertTrue(options.profilingTracesDirPath == "profile_traces")
+    }
+  }
+
   private fun withPropertiesFile(
     textLines: List<String> = emptyList(),
     logger: ILogger = mock(),

sentry/src/test/java/io/sentry/SentryOptionsTest.kt

@@ -408,7 +408,9 @@ class SentryOptionsTest {
     externalOptions.isGlobalHubMode = true
     externalOptions.isEnableLogs = true
     externalOptions.profileSessionSampleRate = 0.8
+    externalOptions.profilingTracesDirPath = "/profiling-traces"
 
+    val hash = StringUtils.calculateStringHash(externalOptions.dsn, mock())
     val options = SentryOptions()
 
     options.merge(externalOptions)
@@ -463,6 +465,7 @@ class SentryOptionsTest {
     assertTrue(options.isGlobalHubMode!!)
     assertTrue(options.logs.isEnabled!!)
     assertEquals(0.8, options.profileSessionSampleRate)
+    assertEquals("/profiling-traces${File.separator}${hash}", options.profilingTracesDirPath)
   }
 
   @Test
@@ -534,6 +537,23 @@ class SentryOptionsTest {
     )
   }
 
+  @Test
+  fun `when cacheDirPath and profilingTracesDirPath are set, profilingTracesDirPath takes precedence`() {
+    val dsn = "http://key@localhost/proj"
+    val hash = StringUtils.calculateStringHash(dsn, mock())
+    val options =
+      SentryOptions().apply {
+        setDsn(dsn)
+        cacheDirPath = "${File.separator}test"
+        profilingTracesDirPath = "${File.separator}test-profiles"
+      }
+
+    assertEquals(
+      "${File.separator}test-profiles${File.separator}${hash}",
+      options.profilingTracesDirPath,
+    )
+  }
+
   @Test
   fun `getCacheDirPathWithoutDsn does not contain dsn hash`() {
     val dsn = "http://key@localhost/proj"