Autoinstall Profiler

CHANGELOG.md

@@ -5,6 +5,8 @@
 ### Features
 
 - add option to ignore source bundle upload failures ([#209](https://github.com/getsentry/sentry-maven-plugin/pull/209))
+- Autoinstall Profiler ([#222](https://github.com/getsentry/sentry-maven-plugin/pull/222))
+  - enable with `<installProfiler>true</installProfiler>`
 
 ### Dependencies
 

examples/sentry-maven-plugin-example/pom.xml

@@ -51,6 +51,8 @@
                     <additionalSourceDirsForSourceContext>
                         <value>src/main/extra_param</value>
                     </additionalSourceDirsForSourceContext>
+                    <!-- enable auto-installation of sentry-async-profiler for the profiling example below -->
+                    <installProfiler>true</installProfiler>
                 </configuration>
                 <executions>
                     <execution>

examples/sentry-maven-plugin-example/src/main/java/io/sentry/samples/maven/SampleApplication.java

@@ -5,6 +5,7 @@
 import io.sentry.Hint;
 import io.sentry.ISpan;
 import io.sentry.ITransaction;
+import io.sentry.ProfileLifecycle;
 import io.sentry.Sentry;
 import io.sentry.SentryEvent;
 import io.sentry.SentryLevel;
@@ -83,6 +84,11 @@ public static void main(String[] args) throws InterruptedException {
                     // Set what percentage of traces should be collected
                     options.setTracesSampleRate(1.0); // set 0.5 to send 50% of traces
 
+                    // Profiling configuration options
+                    // Set ProfileLifecycle and ProfileSessionSampleRate
+                    options.setProfileLifecycle(ProfileLifecycle.TRACE);
+                    options.setProfileSessionSampleRate(1.0);
+
                     // Determine traces sample rate based on the sampling context
                     options.setTracesSampler(
                             context -> {

src/main/java/io/sentry/ExtensionConfigurationHolderMojo.java

@@ -1,5 +1,6 @@
 package io.sentry;
 
+import static io.sentry.config.PluginConfig.DEFAULT_INSTALL_PROFILER_STRING;
 import static io.sentry.config.PluginConfig.DEFAULT_SKIP_AUTO_INSTALL_STRING;
 import static io.sentry.config.PluginConfig.DEFAULT_SKIP_TELEMETRY_STRING;
 
@@ -21,6 +22,10 @@ public class ExtensionConfigurationHolderMojo extends AbstractMojo {
   @Parameter(defaultValue = DEFAULT_SKIP_TELEMETRY_STRING)
   private boolean skipTelemetry;
 
+  @SuppressWarnings("UnusedVariable")
+  @Parameter(defaultValue = DEFAULT_INSTALL_PROFILER_STRING)
+  private boolean installProfiler;
+
   @Override
   public void execute() throws MojoExecutionException, MojoFailureException {}
 }

src/main/java/io/sentry/SentryInstallerLifecycleParticipant.java

@@ -6,6 +6,7 @@
 import static io.sentry.autoinstall.jdbc.JdbcInstallStrategy.SENTRY_JDBC_ID;
 import static io.sentry.autoinstall.log4j2.Log4j2InstallStrategy.SENTRY_LOG4J2_ID;
 import static io.sentry.autoinstall.logback.LogbackInstallStrategy.SENTRY_LOGBACK_ID;
+import static io.sentry.autoinstall.profiler.ProfilerInstallStrategy.SENTRY_ASYNC_PROFILER_ID;
 import static io.sentry.autoinstall.quartz.QuartzInstallStrategy.SENTRY_QUARTZ_ID;
 import static io.sentry.autoinstall.spring.Spring5InstallStrategy.SENTRY_SPRING_5_ID;
 import static io.sentry.autoinstall.spring.Spring6InstallStrategy.SENTRY_SPRING_6_ID;
@@ -22,6 +23,7 @@
 import io.sentry.autoinstall.jdbc.JdbcInstallStrategy;
 import io.sentry.autoinstall.log4j2.Log4j2InstallStrategy;
 import io.sentry.autoinstall.logback.LogbackInstallStrategy;
+import io.sentry.autoinstall.profiler.ProfilerInstallStrategy;
 import io.sentry.autoinstall.quartz.QuartzInstallStrategy;
 import io.sentry.autoinstall.spring.*;
 import io.sentry.config.ConfigParser;
@@ -64,7 +66,8 @@ public class SentryInstallerLifecycleParticipant extends AbstractMavenLifecycleP
               GraphqlInstallStrategy.class,
               Graphql22InstallStrategy.class,
               JdbcInstallStrategy.class,
-              QuartzInstallStrategy.class)
+              QuartzInstallStrategy.class,
+              ProfilerInstallStrategy.class)
           .collect(Collectors.toList());
 
   @Inject @NotNull ArtifactResolver resolver;
@@ -125,6 +128,7 @@ public void afterProjectsRead(final @NotNull MavenSession session)
         autoInstallState.setInstallGraphql(shouldInstallGraphQL(resolvedArtifacts));
         autoInstallState.setInstallJdbc(!isModuleAvailable(resolvedArtifacts, SENTRY_JDBC_ID));
         autoInstallState.setInstallQuartz(!isModuleAvailable(resolvedArtifacts, SENTRY_QUARTZ_ID));
+        autoInstallState.setInstallProfiler(shouldInstallProfiler(resolvedArtifacts, pluginConfig));
 
         for (final @NotNull Class<? extends AbstractIntegrationInstaller> installerClass :
             installers) {
@@ -160,6 +164,12 @@ private boolean shouldInstallGraphQL(final @NotNull List<Artifact> resolvedArtif
         || isModuleAvailable(resolvedArtifacts, SENTRY_GRAPHQL_22_ID));
   }
 
+  private boolean shouldInstallProfiler(
+      final @NotNull List<Artifact> resolvedArtifacts, final @NotNull PluginConfig pluginConfig) {
+    return pluginConfig.isInstallProfiler()
+        && !(isModuleAvailable(resolvedArtifacts, SENTRY_ASYNC_PROFILER_ID));
+  }
+
   public static boolean isModuleAvailable(
       final @NotNull List<Artifact> resolvedArtifacts, final @NotNull String artifactId) {
     return resolvedArtifacts.stream()

src/main/java/io/sentry/autoinstall/AbstractIntegrationInstaller.java

@@ -32,6 +32,18 @@ public abstract class AbstractIntegrationInstaller {
 
   protected abstract @NotNull String sentryModuleId();
 
+  protected @NotNull String skippedInstallMessage(
+      final @NotNull List<Artifact> resolvedArtifacts,
+      final @NotNull AutoInstallState autoInstallState) {
+    return sentryModuleId() + " won't be installed because it was already installed directly";
+  }
+
+  protected boolean shouldLogSkippedInstallMessage(
+      final @NotNull List<Artifact> resolvedArtifacts,
+      final @NotNull AutoInstallState autoInstallState) {
+    return true;
+  }
+
   protected AbstractIntegrationInstaller(final @NotNull org.slf4j.Logger logger) {
     this.logger = logger;
   }
@@ -41,8 +53,9 @@ public void install(
       final @NotNull List<Artifact> resolvedArtifacts,
       final @NotNull AutoInstallState autoInstallState) {
     if (!shouldInstallModule(autoInstallState)) {
-      logger.info(
-          sentryModuleId() + " won't be installed because it was already installed directly");
+      if (shouldLogSkippedInstallMessage(resolvedArtifacts, autoInstallState)) {
+        logger.info(skippedInstallMessage(resolvedArtifacts, autoInstallState));
+      }
       return;
     }
 
@@ -92,7 +105,7 @@ public void install(
                   + " won't be installed because the current version ("
                   + sentrySemVersion
                   + ") is lower than the minimum supported sentry version "
-                  + sentryVersion);
+                  + minSupportedSentryVersion());
           return;
         }
       } catch (IllegalArgumentException ex) {

src/main/java/io/sentry/autoinstall/AutoInstallState.java

@@ -12,6 +12,7 @@ public class AutoInstallState {
   private boolean installGraphql = false;
 
   private boolean installQuartz = false;
+  private boolean installProfiler = false;
 
   public AutoInstallState(final @NotNull String sentryVersion) {
     this.sentryVersion = sentryVersion;
@@ -72,4 +73,12 @@ public boolean isInstallQuartz() {
   public void setInstallQuartz(boolean installQuartz) {
     this.installQuartz = installQuartz;
   }
+
+  public boolean isInstallProfiler() {
+    return installProfiler;
+  }
+
+  public void setInstallProfiler(boolean installProfiler) {
+    this.installProfiler = installProfiler;
+  }
 }

src/main/java/io/sentry/autoinstall/profiler/ProfilerInstallStrategy.java

@@ -0,0 +1,63 @@
+package io.sentry.autoinstall.profiler;
+
+import static io.sentry.Constants.SENTRY_GROUP_ID;
+
+import io.sentry.autoinstall.AbstractIntegrationInstaller;
+import io.sentry.autoinstall.AutoInstallState;
+import io.sentry.semver.Version;
+import java.util.List;
+import org.eclipse.aether.artifact.Artifact;
+import org.eclipse.aether.artifact.DefaultArtifact;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class ProfilerInstallStrategy extends AbstractIntegrationInstaller {
+  public static final @NotNull String SENTRY_ASYNC_PROFILER_ID = "sentry-async-profiler";
+
+  public ProfilerInstallStrategy() {
+    this(LoggerFactory.getLogger(ProfilerInstallStrategy.class));
+  }
+
+  public ProfilerInstallStrategy(final @NotNull Logger logger) {
+    super(logger);
+  }
+
+  @Override
+  protected @Nullable Artifact findThirdPartyDependency(
+      final @NotNull List<Artifact> resolvedArtifacts) {
+    // Return a dummy artifact as there are no third-party dependencies required
+    return new DefaultArtifact("dummy:dummy:1.0.0");
+  }
+
+  @Override
+  protected boolean shouldInstallModule(final @NotNull AutoInstallState autoInstallState) {
+    return autoInstallState.isInstallProfiler();
+  }
+
+  @Override
+  protected boolean shouldLogSkippedInstallMessage(
+      final @NotNull List<Artifact> resolvedArtifacts,
+      final @NotNull AutoInstallState autoInstallState) {
+    return isSentryAsyncProfilerAvailable(resolvedArtifacts);
+  }
+
+  private boolean isSentryAsyncProfilerAvailable(final @NotNull List<Artifact> resolvedArtifacts) {
+    return resolvedArtifacts.stream()
+        .anyMatch(
+            (dep) ->
+                dep.getGroupId().equals(SENTRY_GROUP_ID)
+                    && dep.getArtifactId().equals(SENTRY_ASYNC_PROFILER_ID));
+  }
+
+  @Override
+  protected @NotNull Version minSupportedSentryVersion() {
+    return Version.create(8, 23, 0);
+  }
+
+  @Override
+  protected @NotNull String sentryModuleId() {
+    return SENTRY_ASYNC_PROFILER_ID;
+  }
+}

src/main/java/io/sentry/config/ConfigParser.java

@@ -28,6 +28,7 @@ public class ConfigParser {
   private static final @NotNull String AUTH_TOKEN_OPTION = "authToken";
   private static final @NotNull String ADDITIONAL_SOURCE_DIRS_FOR_SOURCE_CONTEXT =
       "additionalSourceDirsForSourceContext";
+  private static final @NotNull String INSTALL_PROFILER_FLAG = "installProfiler";
 
   public @NotNull PluginConfig parseConfig(final @NotNull MavenProject project) {
     final @NotNull PluginConfig pluginConfig = new PluginConfig();
@@ -101,6 +102,10 @@ public class ConfigParser {
               : Arrays.stream(dom.getChild(ADDITIONAL_SOURCE_DIRS_FOR_SOURCE_CONTEXT).getChildren())
                   .map(Xpp3Dom::getValue)
                   .collect(Collectors.joining(",")));
+
+      pluginConfig.setInstallProfiler(
+          dom.getChild(INSTALL_PROFILER_FLAG) != null
+              && Boolean.parseBoolean(dom.getChild(INSTALL_PROFILER_FLAG).getValue()));
     }
 
     return pluginConfig;

src/main/java/io/sentry/config/PluginConfig.java

@@ -24,6 +24,8 @@ public class PluginConfig {
   public static final @NotNull String DEFAULT_SKIP_VALIDATE_SDK_DEPENDENCY_VERSIONS_STRING =
       "false";
   public static final @NotNull String DEFAULT_ADDITIONAL_SOURCE_DIRS_FOR_SOURCE_CONTEXT = "";
+  public static final boolean DEFAULT_INSTALL_PROFILER = false;
+  public static final @NotNull String DEFAULT_INSTALL_PROFILER_STRING = "false";
 
   private boolean skip = DEFAULT_SKIP;
   private boolean skipAutoInstall = DEFAULT_SKIP_AUTO_INSTALL;
@@ -36,6 +38,7 @@ public class PluginConfig {
   private boolean skipValidateSdkDependencyVersions = DEFAULT_SKIP_VALIDATE_SDK_DEPENDENCY_VERSIONS;
   private @NotNull String additionalSourceDirsForSourceContext =
       DEFAULT_ADDITIONAL_SOURCE_DIRS_FOR_SOURCE_CONTEXT;
+  private boolean installProfiler = DEFAULT_INSTALL_PROFILER;
 
   private @Nullable String org;
   private @Nullable String project;
@@ -100,6 +103,10 @@ public void setSkipValidateSdkDependencyVersions(
     this.skipValidateSdkDependencyVersions = skipValidateSdkDependencyVersions;
   }
 
+  public void setInstallProfiler(final boolean installProfiler) {
+    this.installProfiler = installProfiler;
+  }
+
   public boolean isSkipAutoInstall() {
     return skipAutoInstall || skip;
   }
@@ -124,6 +131,10 @@ public boolean isSkipValidateSdkDependencyVersions() {
     return skipValidateSdkDependencyVersions;
   }
 
+  public boolean isInstallProfiler() {
+    return installProfiler;
+  }
+
   public @Nullable String getOrg() {
     return org;
   }