Auto add OpenTelemetryLinkErrorEventProcessor for Spring Boot #2429

adinauer · 2022-12-15T11:40:48Z

📜 Description

SentryAutoConfiguration.java now automatically provides a OpenTelemetryLinkErrorEventProcessor bean in case it's present and auto init (provided by sentry-opentelemetry-agent) has been turned off.

💡 Motivation and Context

This makes it easier for users who are not using auto init (provided by sentry-opentelemetry-agent) as they no longer need to manually provicde OpenTelemetryLinkErrorEventProcessor as a bean or add it to the options.

💚 How did you test it?

Manually using Spring Boot sample app; automated tests

📝 Checklist

I reviewed the submitted code
I added tests to verify the changes
I updated the docs if needed
No breaking changes

🔮 Next steps

github-actions · 2022-12-15T11:41:51Z

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against 44f9f2e

github-actions · 2022-12-15T11:55:16Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	328.74 ms	436.20 ms	107.46 ms
Size	1.73 MiB	2.33 MiB	616.48 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`f1150bc`	352.62 ms	453.27 ms	100.65 ms
`a04f788`	321.78 ms	354.12 ms	32.35 ms
`4a9c176`	319.77 ms	363.20 ms	43.43 ms
`90e9745`	314.68 ms	357.28 ms	42.60 ms
`3695453`	314.63 ms	353.10 ms	38.47 ms
`16371c5`	314.02 ms	394.54 ms	80.52 ms
`507f924`	342.51 ms	402.65 ms	60.14 ms
`703d523`	330.27 ms	377.66 ms	47.39 ms
`4a9c176`	320.62 ms	334.68 ms	14.06 ms
`87598a5`	310.41 ms	373.27 ms	62.86 ms

App size

Revision	Plain	With Sentry	Diff
`f1150bc`	1.73 MiB	2.33 MiB	615.66 KiB
`a04f788`	1.73 MiB	2.32 MiB	609.88 KiB
`4a9c176`	1.73 MiB	2.33 MiB	612.69 KiB
`90e9745`	1.73 MiB	2.32 MiB	608.63 KiB
`3695453`	1.73 MiB	2.32 MiB	611.62 KiB
`16371c5`	1.73 MiB	2.32 MiB	611.62 KiB
`507f924`	1.73 MiB	2.32 MiB	609.95 KiB
`703d523`	1.73 MiB	2.33 MiB	613.23 KiB
`4a9c176`	1.73 MiB	2.33 MiB	612.69 KiB
`87598a5`	1.73 MiB	2.33 MiB	614.63 KiB

Previous results on branch: feat/auto-add-otel-event-processor-for-spring-boot

Startup times

Revision	Plain	With Sentry	Diff
`be7a638`	339.88 ms	344.96 ms	5.08 ms
`3993470`	295.45 ms	313.83 ms	18.39 ms
`349e444`	332.65 ms	379.73 ms	47.08 ms
`c76546c`	317.68 ms	338.29 ms	20.61 ms
`7aab380`	342.61 ms	355.39 ms	12.78 ms

App size

Revision	Plain	With Sentry	Diff
`be7a638`	1.73 MiB	2.33 MiB	615.83 KiB
`3993470`	1.73 MiB	2.33 MiB	615.83 KiB
`349e444`	1.73 MiB	2.33 MiB	613.23 KiB
`c76546c`	1.73 MiB	2.33 MiB	613.23 KiB
`7aab380`	1.73 MiB	2.33 MiB	613.23 KiB

codecov-commenter · 2022-12-15T12:08:49Z

Codecov Report

Base: 80.08% // Head: 80.09% // Increases project coverage by +0.00% 🎉

Coverage data is based on head (44f9f2e) compared to base (5610867).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #2429   +/-   ##
=========================================
  Coverage     80.08%   80.09%           
  Complexity     3807     3807           
=========================================
  Files           306      306           
  Lines         14386    14390    +4     
  Branches       1904     1904           
=========================================
+ Hits          11521    11525    +4     
  Misses         2118     2118           
  Partials        747      747

Impacted Files	Coverage Δ
...a/io/sentry/opentelemetry/SentrySpanProcessor.java	`86.74% <ø> (ø)`
...y/spring/boot/jakarta/SentryAutoConfiguration.java	`98.50% <100.00%> (+0.04%)`	⬆️
...io/sentry/spring/boot/SentryAutoConfiguration.java	`98.50% <100.00%> (+0.04%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

adinauer · 2022-12-15T13:57:09Z

sentry-spring-boot-starter/src/main/java/io/sentry/spring/boot/SentryAutoConfiguration.java

@@ -139,6 +140,19 @@ static class ContextTagsEventProcessorConfiguration {
      }
    }

+    @Configuration(proxyBeanMethods = false)
+    @ConditionalOnProperty(name = "sentry.auto-init", havingValue = "false")


When not using the agent this will not trigger. At the moment it feels like a niche use case to not use the agent JAR and there doesn't seem to be an easy way of detecting whether the agent is in use. We could add some class that serves as a marker (to the bootstrap classloader) or manipulate the options (byte code manipulation) from the agent but decided not to do that for now. If this becomes a more common use case we can revisit.

💡 could also look at the classloader of OpenTelemetryLinkErrorEventProcessor. If it's the bootstrap classloader the agent is in use. Not sure yet how to turn that into an @Conditional for spring config.

💡 probably even easier to just have SentryOptions injected into the @Bean method and not create the bean if a OpenTelemetryLinkErrorEventProcessor has already been registered. Also not sure how to add that to the auto config yet.

...starter-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryAutoConfigurationTest.kt

…en using agent

…dd-otel-event-processor-for-spring-boot

...try/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentrySpanProcessor.java

romtsn · 2022-12-21T08:14:09Z

sentry-opentelemetry/sentry-opentelemetry-core/build.gradle.kts

@@ -21,7 +21,7 @@ tasks.withType<KotlinCompile>().configureEach {
 dependencies {
    compileOnly(projects.sentry)

-    compileOnly(Config.Libs.OpenTelemetry.otelSdk)
+    implementation(Config.Libs.OpenTelemetry.otelSdk)


hm, why did we change it to implementation? It's not possible to use this module without otel, right? Or is the assumption that people will just include our sentry-opentelemetry-core package, but not otel itself?

The intention was to make it easier to use sentry-opentelemetry-agent with SENTRY_AUTO_INIT=false. Currently you need to add sentry-opentelemetry-core to the dependencies so you can enjoy linking of errors to transactions. With compileOnly you'd also have to include the correct version of the OTEL SDK, with implementation it just drags it in. For sentry-opentelemetry-agent we exclude it again, which users also have to do, if they don't want to use the agent but have a different OTEL version than we use or their build system can't figure out versions.

Another approach (for later) would be to have yet another gradle module, that we can then add to the bootstrap classloader in the agent, thus not requiring the explicit dependency on sentry-opentelemetry-core at all, when setting SENTRY_AUTO_INIT=false.

alright, just beware that implementation will override whatever version the users are using (if it's lower than ours). If that's what we want, then I'm good 👍

…g-boot

adinauer added 5 commits December 13, 2022 08:06

Add tests for linking errors to otel transactions

baf8bd5

Add logging to OTEL code

49efc4c

Add more IDs to log statements

183423a

Add changelog

8b47a99

Auto add OpenTelemetryLinkErrorEventProcessor for Spring Boot

e3c8470

adinauer requested review from romtsn, stefanosiano and markushi as code owners December 15, 2022 11:40

Add changelog

707ea59

adinauer mentioned this pull request Dec 15, 2022

Add docs for OpenTelemetry Java getsentry/sentry-docs#5968

Merged

adinauer commented Dec 15, 2022

View reviewed changes

lbloder reviewed Dec 16, 2022

View reviewed changes

...starter-jakarta/src/test/kotlin/io/sentry/spring/boot/jakarta/SentryAutoConfigurationTest.kt Show resolved Hide resolved

lbloder approved these changes Dec 16, 2022

View reviewed changes

adinauer added 3 commits December 19, 2022 13:50

No longer require direct dependency on OTEL SDK in spring boot app wh…

ba730c2

…en using agent

Merge branch 'main' into feat/test-error-otel-transaction-link

319b527

Merge branch 'feat/test-error-otel-transaction-link' into feat/auto-a…

d7813ca

…dd-otel-event-processor-for-spring-boot

markushi approved these changes Dec 21, 2022

View reviewed changes

...try/sentry-opentelemetry-core/src/main/java/io/sentry/opentelemetry/SentrySpanProcessor.java Show resolved Hide resolved

romtsn reviewed Dec 21, 2022

View reviewed changes

Base automatically changed from feat/test-error-otel-transaction-link to main December 22, 2022 07:13

adinauer added 2 commits December 22, 2022 08:14

Merge branch 'main' into feat/auto-add-otel-event-processor-for-sprin…

da36dbf

…g-boot

Merge branch 'main' into feat/auto-add-otel-event-processor-for-sprin…

44f9f2e

…g-boot

adinauer merged commit 5fd37fa into main Dec 22, 2022

adinauer deleted the feat/auto-add-otel-event-processor-for-spring-boot branch December 22, 2022 13:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Auto add OpenTelemetryLinkErrorEventProcessor for Spring Boot #2429

Auto add OpenTelemetryLinkErrorEventProcessor for Spring Boot #2429

adinauer commented Dec 15, 2022

github-actions bot commented Dec 15, 2022 •

edited

github-actions bot commented Dec 15, 2022 •

edited

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/auto-add-otel-event-processor-for-spring-boot

Startup times

App size

codecov-commenter commented Dec 15, 2022 •

edited

adinauer Dec 15, 2022

adinauer Dec 15, 2022

adinauer Dec 15, 2022 •

edited

romtsn Dec 21, 2022

adinauer Dec 21, 2022

romtsn Dec 21, 2022

Auto add OpenTelemetryLinkErrorEventProcessor for Spring Boot #2429

Auto add OpenTelemetryLinkErrorEventProcessor for Spring Boot #2429

Conversation

adinauer commented Dec 15, 2022

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

🔮 Next steps

github-actions bot commented Dec 15, 2022 • edited

github-actions bot commented Dec 15, 2022 • edited

Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/auto-add-otel-event-processor-for-spring-boot

Startup times

App size

codecov-commenter commented Dec 15, 2022 • edited

Codecov Report

adinauer Dec 15, 2022

Choose a reason for hiding this comment

adinauer Dec 15, 2022

Choose a reason for hiding this comment

adinauer Dec 15, 2022 • edited

Choose a reason for hiding this comment

romtsn Dec 21, 2022

Choose a reason for hiding this comment

adinauer Dec 21, 2022

Choose a reason for hiding this comment

romtsn Dec 21, 2022

Choose a reason for hiding this comment

github-actions bot commented Dec 15, 2022 •

edited

github-actions bot commented Dec 15, 2022 •

edited

codecov-commenter commented Dec 15, 2022 •

edited

adinauer Dec 15, 2022 •

edited