Fix profiling init for Spring and Spring Boot w Agent auto-init by lbloder · Pull Request #4815 · getsentry/sentry-java

lbloder · 2025-10-20T08:53:19Z

📜 Description

Add @Configuration classes to initialize the profiler when running in OTEL Agent auto-init mode.

💡 Motivation and Context

Fixes #4855

💚 How did you test it?

📝 Checklist

I added GH Issue ID & Linear ID
I added tests to verify the changes.
No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
I updated the docs if needed.
I updated the wizard if needed.
Review from the native team if needed.
No breaking change or entry added to the changelog.
No breaking change for hybrid SDKs or communicated to hybrid SDKs.

🔮 Next steps

…options, add configuration class to load the profiler and converter after spring boot starts in agent mode

lbloder · 2025-10-20T08:57:55Z

...oot-jakarta/src/main/java/io/sentry/spring/boot/jakarta/SentryProfilerAutoConfiguration.java

+import org.springframework.context.annotation.Import;
+
+@Configuration(proxyBeanMethods = false)
+@ConditionalOnClass(name = {"io.sentry.opentelemetry.agent.AgentMarker"})


Make it conditional on the async profiler class too?

Sounds good, I see no reason to run this if profiler isn't there.

What might become an issue is, if we ever have a second IContinuousProfiler implementation, we also have to update the condition

github-actions · 2025-10-20T09:04:58Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	312.08 ms	354.88 ms	42.79 ms
Size	1.58 MiB	2.12 MiB	553.75 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`806307f`	357.85 ms	424.64 ms	66.79 ms
`ee747ae`	554.98 ms	611.50 ms	56.52 ms
`17a0955`	372.53 ms	446.70 ms	74.17 ms
`2124a46`	319.19 ms	415.04 ms	95.85 ms
`9fbb112`	404.51 ms	475.65 ms	71.14 ms
`b6702b0`	395.86 ms	409.98 ms	14.12 ms
`ee747ae`	357.79 ms	421.84 ms	64.05 ms
`27d7cf8`	314.17 ms	347.00 ms	32.83 ms
`9fbb112`	361.43 ms	427.57 ms	66.14 ms
`96449e8`	361.30 ms	423.39 ms	62.09 ms

App size

Revision	Plain	With Sentry	Diff
`806307f`	1.58 MiB	2.10 MiB	533.42 KiB
`ee747ae`	1.58 MiB	2.10 MiB	530.95 KiB
`17a0955`	1.58 MiB	2.10 MiB	533.20 KiB
`2124a46`	1.58 MiB	2.12 MiB	551.51 KiB
`9fbb112`	1.58 MiB	2.11 MiB	539.18 KiB
`b6702b0`	1.58 MiB	2.12 MiB	551.79 KiB
`ee747ae`	1.58 MiB	2.10 MiB	530.95 KiB
`27d7cf8`	1.58 MiB	2.12 MiB	549.42 KiB
`9fbb112`	1.58 MiB	2.11 MiB	539.18 KiB
`96449e8`	1.58 MiB	2.11 MiB	539.35 KiB

Previous results on branch: feat/profiling-w-spring-otel-agent

Startup times

Revision	Plain	With Sentry	Diff
`b59fc8e`	399.24 ms	444.62 ms	45.38 ms
`c4729d6`	315.52 ms	362.84 ms	47.32 ms
`c773a3a`	406.73 ms	491.63 ms	84.90 ms
`3d7551b`	388.73 ms	462.98 ms	74.24 ms
`db75a56`	331.37 ms	402.82 ms	71.45 ms
`d76029f`	339.65 ms	357.82 ms	18.17 ms
`913e482`	313.91 ms	378.00 ms	64.09 ms
`30b9948`	314.20 ms	354.71 ms	40.51 ms
`3832729`	297.73 ms	353.21 ms	55.48 ms
`2b6b804`	312.35 ms	370.80 ms	58.45 ms

App size

Revision	Plain	With Sentry	Diff
`b59fc8e`	1.58 MiB	2.11 MiB	539.90 KiB
`c4729d6`	1.58 MiB	2.12 MiB	548.31 KiB
`c773a3a`	1.58 MiB	2.12 MiB	549.51 KiB
`3d7551b`	1.58 MiB	2.12 MiB	552.68 KiB
`db75a56`	1.58 MiB	2.12 MiB	551.94 KiB
`d76029f`	1.58 MiB	2.12 MiB	549.52 KiB
`913e482`	1.58 MiB	2.12 MiB	552.67 KiB
`30b9948`	1.58 MiB	2.12 MiB	551.90 KiB
`3832729`	1.58 MiB	2.12 MiB	551.94 KiB
`2b6b804`	1.58 MiB	2.12 MiB	551.86 KiB

lbloder · 2025-10-20T09:08:37Z

sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/SentryProfilerConfiguration.java

+
+  @Bean
+  @ConditionalOnMissingBean(name = "sentryOpenTelemetryProfilerConfiguration")
+  public IContinuousProfiler sentryOpenTelemetryProfilerConfiguration() {


Extract init into util to streamline initialization code

lbloder · 2025-10-20T09:08:41Z

sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/SentryProfilerConfiguration.java

+
+  @Bean
+  @ConditionalOnMissingBean(name = "sentryOpenTelemetryProfilerConverterConfiguration")
+  public IProfileConverter sentryOpenTelemetryProfilerConverterConfiguration() {


Extract init into util to streamline initialization code

lbloder · 2025-11-03T07:43:05Z

@sentry review

lbloder · 2025-11-03T07:43:11Z

@cursor review

sentry-async-profiler/src/test/java/io/sentry/asyncprofiler/init/AsyncProfilerInitUtilTest.kt

adinauer · 2025-11-04T08:16:07Z

sentry-async-profiler/src/test/java/io/sentry/asyncprofiler/init/AsyncProfilerInitUtilTest.kt

+  }
+
+  @Test
+  fun `initialize converter returns no-op converter if converter already initialized`() {


m should it simply return the existing one instead of noop that potentially causes profiling to break?

sentry-spring-7/src/main/java/io/sentry/spring7/SentryProfilerConfiguration.java

adinauer · 2025-11-04T08:35:03Z

sentry-spring-7/src/main/java/io/sentry/spring7/SentryProfilerConfiguration.java

+
+  @Bean
+  @ConditionalOnMissingBean(name = "sentryOpenTelemetryProfilerConfiguration")
+  public IContinuousProfiler sentryOpenTelemetryProfilerConfiguration() {


Is there an expected order to these bean evaluations?

Thought about that again, and came to the conclusion that no, the order does not matter.

It doesn't matter if the Profiler or the Converter are created first as they have no direct dependency to each other.

Initially I was worried, that this needs to run after the original SentryAutoConfiguration, but based on the following scenarios it should not matter:
a) No Agent -> Configuration does not run at all, as we depend on the AgentMarker
b) Agent with AutoInit -> Sentry init happened through Agent and we set the profiler on the options. SentryAutoConfiguration shouldn't run at all as the dsn config should be done by OTEL. (caveat misconfiguration by also setting the dsn in application.properties)
c1) Agent without AutoInit and AutoConfiguration runs before SentryProfilerConfiguration -> Sentry is enabled and profiler is already set if profiling is enabled, thus nothing happens.
c2) Agent without AutoInit and SentryAutoConfiguration runs after SentryProfilerConfiguration -> Sentry is not yet enabled, thus SentryProfilerConfiguration does nothing and SentryAutoConfiguration configures profiler afterwards.

WDYT?

adinauer · 2025-11-04T08:36:19Z

sentry-spring-boot-4/src/test/kotlin/io/sentry/spring/boot4/SentryAutoConfigurationTest.kt

+    contextRunner
+      .withPropertyValues(
+        "sentry.dsn=http://key@localhost/proj",
+        "sentry.traces-sample-rate=1.0",


Should this also have "sentry.profile-session-sample-rate=1.0",?

adinauer · 2025-11-04T09:01:13Z

sentry-spring-boot-4/src/test/kotlin/io/sentry/spring/boot4/SentryAutoConfigurationTest.kt

+        "debug=true",
+      )
+      .run {
+        assertThat(it).hasSingleBean(IContinuousProfiler::class.java)


Is this currently simply asserting it has noop instances?

adinauer · 2025-11-04T09:01:48Z

...oot-jakarta/src/main/java/io/sentry/spring/boot/jakarta/SentryProfilerAutoConfiguration.java

+import org.springframework.context.annotation.Import;
+
+@Configuration(proxyBeanMethods = false)
+@ConditionalOnClass(name = {"io.sentry.opentelemetry.agent.AgentMarker"})


Sounds good, I see no reason to run this if profiler isn't there.

adinauer · 2025-11-04T10:06:48Z

sentry/src/main/java/io/sentry/util/InitUtil.java

    return previousOptions.getInitPriority().ordinal() <= newOptions.getInitPriority().ordinal();
  }
+
+  public static IContinuousProfiler initializeProfiler(@NotNull SentryOptions options) {


m should we instead check if options already have a profiler / converter set (that's not noop) and return that?
IMO that makes it easier to reason about SDK init.
Looking at the tests it seems we're potentially replacing a working profiler / converter with noop (if misusing this util).

…Configuration.java Co-authored-by: Alexander Dinauer <adinauer@users.noreply.github.com>

…ve tests

…ntry/sentry-java into feat/profiling-w-spring-otel-agent

sentry-spring-boot-4/src/test/kotlin/io/sentry/spring/boot4/SentryAutoConfigurationTest.kt

…oke ProfilerAutoConfig

# Conflicts: # CHANGELOG.md

adinauer

LGTM

cursor · 2025-11-10T13:47:18Z

sentry-spring-7/src/main/java/io/sentry/spring7/SentryProfilerConfiguration.java

+      return InitUtil.initializeProfiler(options);
+    } else {
+      return profiler;
+    }


Bug: NoOp Profiler Overwrites Custom Configuration

When Sentry.isEnabled() returns false, the method creates and returns a new NoOpContinuousProfiler instance instead of returning the profiler already stored in options. This can inadvertently overwrite a custom profiler that was configured through OptionsConfiguration, as the bean will always return a fresh NoOp instance rather than preserving existing configuration.

cursor · 2025-11-10T13:47:18Z

sentry-spring-7/src/main/java/io/sentry/spring7/SentryProfilerConfiguration.java

+      return InitUtil.initializeProfileConverter(options);
+    } else {
+      return converter;
+    }


Bug: Custom Configuration Unexpectedly Overwritten

When Sentry.isEnabled() returns false, the method creates and returns a new NoOpProfileConverter instance instead of returning the converter already stored in options. This can inadvertently overwrite a custom converter that was configured through OptionsConfiguration, as the bean will always return a fresh NoOp instance rather than preserving existing configuration.

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

# Conflicts: # CHANGELOG.md

cursor · 2025-11-10T15:08:30Z

sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/SentryProfilerConfiguration.java

+      return InitUtil.initializeProfiler(options);
+    } else {
+      return profiler;
+    }


Bug: Sentry profiler: Custom configuration discarded.

When Sentry is disabled, the method returns a new NoOpContinuousProfiler instance instead of the existing profiler from options. This is inconsistent with sentry-spring/SentryProfilerConfiguration.java which returns options.getContinuousProfiler(). If options already has a configured profiler (e.g., set via custom configuration), returning a NoOp instance would discard it and potentially break profiling functionality. The unused local variable profiler suggests this was meant to be options.getContinuousProfiler().

cursor · 2025-11-10T15:08:30Z

sentry-spring-jakarta/src/main/java/io/sentry/spring/jakarta/SentryProfilerConfiguration.java

+      return InitUtil.initializeProfileConverter(options);
+    } else {
+      return converter;
+    }


Bug: Sentry Disabled: Configured Converter Ignored

When Sentry is disabled, the method returns a new NoOpProfileConverter instance instead of the existing converter from options. This is inconsistent with sentry-spring/SentryProfilerConfiguration.java which returns options.getProfilerConverter(). If options already has a configured converter, returning a NoOp instance would discard it and potentially break profile conversion. The unused local variable converter suggests this was meant to be options.getProfilerConverter().

# Conflicts: # CHANGELOG.md

also load converter at sentry initialization time and hold in sentry-…

a4ce01a

…options, add configuration class to load the profiler and converter after spring boot starts in agent mode

lbloder commented Oct 20, 2025

View reviewed changes

lbloder added 7 commits October 20, 2025 15:24

use InitUtil to initialize profiler and converter

39225ff

add new configuration class to spring and spring4 variants

40395fb

add tests for profiler and converter init

f8f253f

format code

c02c3dd

add test for auto profiler config

d180c19

bump api

5e75584

Merge branch 'main' into feat/profiling-w-spring-otel-agent

dde02b9

lbloder mentioned this pull request Nov 3, 2025

JVM Profiling Follow ups #4778

Open

19 tasks

sentry bot reviewed Nov 3, 2025

View reviewed changes

sentry-async-profiler/src/test/java/io/sentry/asyncprofiler/init/AsyncProfilerInitUtilTest.kt Show resolved Hide resolved

sentry-async-profiler/src/test/java/io/sentry/asyncprofiler/init/AsyncProfilerInitUtilTest.kt Outdated Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

lbloder added 3 commits November 3, 2025 09:30

add missing package to test, adapt log statement

0514903

add changelog entry, improve logs

2cb26e1

Merge branch 'main' into feat/profiling-w-spring-otel-agent

737c147

lbloder marked this pull request as ready for review November 3, 2025 13:29

lbloder requested review from adinauer, lcian, markushi, romtsn and stefanosiano as code owners November 3, 2025 13:29

This comment was marked as outdated.

Sign in to view

adinauer reviewed Nov 4, 2025

View reviewed changes

lbloder and others added 2 commits November 4, 2025 12:22

Update sentry-spring-7/src/main/java/io/sentry/spring7/SentryProfiler…

41d2c6a

…Configuration.java Co-authored-by: Alexander Dinauer <adinauer@users.noreply.github.com>

Format code

87071dd

This comment was marked as outdated.

Sign in to view

lbloder added 2 commits November 4, 2025 14:47

make initUtil methods more readable, return value from options, impro…

8fca29a

…ve tests

Merge branch 'feat/profiling-w-spring-otel-agent' of github.com:getse…

40bb0a2

…ntry/sentry-java into feat/profiling-w-spring-otel-agent

cursor bot reviewed Nov 4, 2025

View reviewed changes

sentry-spring-boot-4/src/test/kotlin/io/sentry/spring/boot4/SentryAutoConfigurationTest.kt Show resolved Hide resolved

lbloder added 4 commits November 5, 2025 10:05

add tests for path creation

4a52a0d

improve test cases

f04bdbc

add condition on JavaContinuousProfiler to be on the classpath to inv…

c3c36b6

…oke ProfilerAutoConfig

Merge branch 'main' into feat/profiling-w-spring-otel-agent

3ebaeb5

# Conflicts: # CHANGELOG.md

adinauer approved these changes Nov 10, 2025

View reviewed changes

Merge branch 'main' into feat/profiling-w-spring-otel-agent

fa864ed

cursor bot reviewed Nov 10, 2025

View reviewed changes

lbloder added 2 commits November 10, 2025 15:44

Merge branch 'main' into feat/profiling-w-spring-otel-agent

1bb7e19

# Conflicts: # CHANGELOG.md

return profiler and converter from options instead of a instance of noop

adf084c

cursor bot reviewed Nov 10, 2025

View reviewed changes

lbloder added 2 commits November 11, 2025 13:19

Merge branch 'main' into feat/profiling-w-spring-otel-agent

23ebbf7

# Conflicts: # CHANGELOG.md

Merge branch 'main' into feat/profiling-w-spring-otel-agent

937782e

# Conflicts: # CHANGELOG.md

lbloder enabled auto-merge (squash) November 11, 2025 12:32

lbloder merged commit 591b401 into main Nov 11, 2025
62 of 63 checks passed

lbloder deleted the feat/profiling-w-spring-otel-agent branch November 11, 2025 12:50

Uh oh!

Conversation

lbloder commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

Uh oh!

lbloder Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/profiling-w-spring-otel-agent

Startup times

App size

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lbloder commented Nov 3, 2025

Uh oh!

lbloder commented Nov 3, 2025

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

adinauer left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot Nov 10, 2025

Choose a reason for hiding this comment

Bug: NoOp Profiler Overwrites Custom Configuration

Uh oh!

cursor bot Nov 10, 2025

Choose a reason for hiding this comment

Bug: Custom Configuration Unexpectedly Overwritten

Uh oh!

Uh oh!

cursor bot Nov 10, 2025

Choose a reason for hiding this comment

Bug: Sentry profiler: Custom configuration discarded.

Uh oh!

cursor bot Nov 10, 2025

Choose a reason for hiding this comment

lbloder commented Oct 20, 2025 •

edited

Loading

lbloder Oct 20, 2025 •

edited

Loading

github-actions bot commented Oct 20, 2025 •

edited

Loading