Fix profiling init for Spring and Spring Boot w Agent auto-init #4815

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

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

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	314.20 ms	354.71 ms	40.51 ms
Size	1.58 MiB	2.12 MiB	551.90 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`27d7cf8`	397.90 ms	498.65 ms	100.75 ms
`9fbb112`	361.43 ms	427.57 ms	66.14 ms
`b3d8889`	371.33 ms	426.24 ms	54.92 ms
`b3d8889`	420.46 ms	453.71 ms	33.26 ms
`d217708`	355.34 ms	381.39 ms	26.05 ms
`27d7cf8`	314.17 ms	347.00 ms	32.83 ms
`ee747ae`	396.82 ms	441.67 ms	44.86 ms
`3d205d0`	352.15 ms	432.53 ms	80.38 ms
`85d7417`	347.21 ms	394.35 ms	47.15 ms
`d5a29b6`	298.62 ms	391.78 ms	93.16 ms

App size

Revision	Plain	With Sentry	Diff
`27d7cf8`	1.58 MiB	2.12 MiB	549.42 KiB
`9fbb112`	1.58 MiB	2.11 MiB	539.18 KiB
`b3d8889`	1.58 MiB	2.10 MiB	535.07 KiB
`b3d8889`	1.58 MiB	2.10 MiB	535.07 KiB
`d217708`	1.58 MiB	2.10 MiB	532.97 KiB
`27d7cf8`	1.58 MiB	2.12 MiB	549.42 KiB
`ee747ae`	1.58 MiB	2.10 MiB	530.95 KiB
`3d205d0`	1.58 MiB	2.10 MiB	532.97 KiB
`85d7417`	1.58 MiB	2.10 MiB	533.44 KiB
`d5a29b6`	1.58 MiB	2.12 MiB	549.37 KiB

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

Startup times

Revision	Plain	With Sentry	Diff
`d76029f`	339.65 ms	357.82 ms	18.17 ms
`2b6b804`	312.35 ms	370.80 ms	58.45 ms
`c773a3a`	406.73 ms	491.63 ms	84.90 ms
`b59fc8e`	399.24 ms	444.62 ms	45.38 ms
`c4729d6`	315.52 ms	362.84 ms	47.32 ms

App size

Revision	Plain	With Sentry	Diff
`d76029f`	1.58 MiB	2.12 MiB	549.52 KiB
`2b6b804`	1.58 MiB	2.12 MiB	551.86 KiB
`c773a3a`	1.58 MiB	2.12 MiB	549.51 KiB
`b59fc8e`	1.58 MiB	2.11 MiB	539.90 KiB
`c4729d6`	1.58 MiB	2.12 MiB	548.31 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 · 2025-11-03T07:45:17Z

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

@@ -0,0 +1,77 @@
+import io.sentry.ILogger


Missing package declaration at the beginning of the file. The Kotlin file should start with a package statement to match the directory structure and avoid namespace conflicts. Expected: package io.sentry.asyncprofiler.init
_{Severity: HIGH}

🤖 Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: sentry-async-profiler/src/test/java/io/sentry/asyncprofiler/init/AsyncProfilerInitUtilTest.kt#L1 Potential issue: Missing package declaration at the beginning of the file. The Kotlin file should start with a package statement to match the directory structure and avoid namespace conflicts. Expected: `package io.sentry.asyncprofiler.init`

_{Did we get this right? 👍 / 👎 to inform future reviews.}

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

sentry · 2025-11-03T07:45:17Z

sentry/src/main/java/io/sentry/SentryEnvelopeItem.java

-                final IProfileConverter profileConverter =
-                    ProfilingServiceLoader.loadProfileConverter();
-                if (profileConverter != null) {
+                if (!NoOpProfileConverter.getInstance().equals(profileConverter)) {


In the fromProfileChunk() method that takes an IProfileConverter parameter (line 307), the code checks if a converter is a NoOp using reference equality: !NoOpProfileConverter.getInstance().equals(profileConverter). This relies on instance equality and the singleton pattern holding throughout the application. A more robust approach would be to use instanceof check: !(profileConverter instanceof NoOpProfileConverter). This makes the code less fragile and independent of instance reuse patterns.
_{Severity: MEDIUM}

🤖 Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: sentry/src/main/java/io/sentry/SentryEnvelopeItem.java#L307 Potential issue: In the `fromProfileChunk()` method that takes an `IProfileConverter` parameter (line 307), the code checks if a converter is a NoOp using reference equality: `!NoOpProfileConverter.getInstance().equals(profileConverter)`. This relies on instance equality and the singleton pattern holding throughout the application. A more robust approach would be to use `instanceof` check: `!(profileConverter instanceof NoOpProfileConverter)`. This makes the code less fragile and independent of instance reuse patterns.

_{Did we get this right? 👍 / 👎 to inform future reviews.}

sentry · 2025-11-03T07:45:17Z

sentry/src/main/java/io/sentry/SentryEnvelopeItem.java

      final @NotNull ProfileChunk profileChunk, final @NotNull ISerializer serializer)
      throws SentryEnvelopeException {

+    return fromProfileChunk(profileChunk, serializer, NoOpProfileConverter.getInstance());


The new overload of fromProfileChunk() that takes an IProfileConverter changes the semantics of the original method. The original method at line 282 now delegates to the new overload with NoOpProfileConverter.getInstance(), which means if a real converter was available via ProfilingServiceLoader, it will no longer be used in the delegating method. This is a breaking change in behavior. Consider documenting this change in the javadoc or adding a deprecation notice if the old method is meant to be phased out.
_{Severity: MEDIUM}

🤖 Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: sentry/src/main/java/io/sentry/SentryEnvelopeItem.java#L282-L285 Potential issue: The new overload of `fromProfileChunk()` that takes an `IProfileConverter` changes the semantics of the original method. The original method at line 282 now delegates to the new overload with `NoOpProfileConverter.getInstance()`, which means if a real converter was available via `ProfilingServiceLoader`, it will no longer be used in the delegating method. This is a breaking change in behavior. Consider documenting this change in the javadoc or adding a deprecation notice if the old method is meant to be phased out.

_{Did we get this right? 👍 / 👎 to inform future reviews.}

cursor

✅ Bugbot reviewed your changes and found no bugs!

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

16 tasks

sentry bot reviewed Nov 3, 2025

View reviewed changes

cursor bot reviewed Nov 3, 2025

View reviewed changes

lbloder added 2 commits November 3, 2025 09:30

add missing package to test, adapt log statement

0514903

add changelog entry, improve logs

2cb26e1

Uh oh!

Fix profiling init for Spring and Spring Boot w Agent auto-init #4815

Are you sure you want to change the base?

Fix profiling init for Spring and Spring Boot w Agent auto-init #4815

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

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!

lbloder Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

lbloder Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

lbloder commented Nov 3, 2025

Uh oh!

lbloder commented Nov 3, 2025

Uh oh!

sentry bot Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sentry bot Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

sentry bot Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

✅ Bugbot reviewed your changes and found no bugs!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lbloder commented Oct 20, 2025 •

edited

Loading

github-actions bot commented Oct 20, 2025 •

edited

Loading