Merge branch 'feat/update-otel-sample-readme' into fix/fix-console-samples

Author: lbloder

.craft.yml

@@ -45,6 +45,7 @@ targets:
       maven:io.sentry:sentry-opentelemetry-agentcustomization:
       maven:io.sentry:sentry-opentelemetry-core:
 #      maven:io.sentry:sentry-opentelemetry-agentless:
+#      maven:io.sentry:sentry-opentelemetry-agentless-spring:
       maven:io.sentry:sentry-apollo:
       maven:io.sentry:sentry-jdbc:
       maven:io.sentry:sentry-graphql:

.github/ISSUE_TEMPLATE/bug_report_java.yml

@@ -16,6 +16,7 @@ body:
         - sentry-kotlin-extensions
         - sentry-opentelemetry-agent
         - sentry-opentelemetry-agentless
+        - sentry-opentelemetry-agentless-spring
         - sentry-opentelemetry-core
         - sentry-servlet
         - sentry-servlet-jakarta

CHANGELOG.md

@@ -4,20 +4,38 @@
 
 ### Features
 
+- Add `sentry-opentelemetry-agentless-spring` module ([#4000](https://github.com/getsentry/sentry-java/pull/4000))
+  - This module can be added as a dependency when using Sentry with OpenTelemetry and Spring Boot but don't want to use our Agent. It takes care of configuring OpenTelemetry for use with Sentry.
+  - You may want to set `OTEL_LOGS_EXPORTER=none;OTEL_METRICS_EXPORTER=none;OTEL_TRACES_EXPORTER=none` env vars to not have the log flooded with error messages regarding OpenTelemetry features we don't use.
 - Add `sentry-opentelemetry-agentless` module ([#3961](https://github.com/getsentry/sentry-java/pull/3961))
   - This module can be added as a dependency when using Sentry with OpenTelemetry but don't want to use our Agent. It takes care of configuring OpenTelemetry for use with Sentry.
   - To enable the auto configuration of it, please set `-Dotel.java.global-autoconfigure.enabled=true` on the `java` command, when starting your application.
   - You may also want to set `OTEL_LOGS_EXPORTER=none;OTEL_METRICS_EXPORTER=none;OTEL_TRACES_EXPORTER=none` env vars to not have the log flooded with error messages regarding OpenTelemetry features we don't use.
 - `OpenTelemetryUtil.applyOpenTelemetryOptions` now takes an enum instead of a boolean for its mode
-  - Use `AGENT` when using `sentry-opentelemetry-agent`
-  - Use `AGENTLESS` when using `sentry-opentelemetry-agentless`
-  - Use `AGENTLESS_SPRING` when using `sentry-opentelemetry-agentless-spring`
+- Add `openTelemetryMode` option ([#3994](https://github.com/getsentry/sentry-java/pull/3994))
+    - It defaults to `AUTO` meaning the SDK will figure out how to best configure itself for use with OpenTelemetry
+    - Use of OpenTelemetry can also be disabled completely by setting it to `OFF` ([#3995](https://github.com/getsentry/sentry-java/pull/3995))
+      - In this case even if OpenTelemetry is present, the Sentry SDK will not use it
+    - Use `AGENT` when using `sentry-opentelemetry-agent`
+    - Use `AGENTLESS` when using `sentry-opentelemetry-agentless`
+    - Use `AGENTLESS_SPRING` when using `sentry-opentelemetry-agentless-spring`
+- Add `scopeBindingMode` to `SpanOptions` ([#4004](https://github.com/getsentry/sentry-java/pull/4004))
+  - This setting only affects the SDK when used with OpenTelemetry.
+  - Defaults to `AUTO` meaning the SDK will decide whether the span should be bound to the current scope. It will not bind transactions to scope using `AUTO`, it will only bind spans where the parent span is on the current scope.
+  - `ON` sets the new span on the current scope.
+  - `OFF` does not set the new span on the scope.
 
 ### Fixes
 
 - Replace deprecated `SimpleInstrumentation` with `SimplePerformantInstrumentation` for graphql 22 ([#3974](https://github.com/getsentry/sentry-java/pull/3974))
 - Cache requests for Spring using Springs `ContentCachingRequestWrapper` instead of our own Wrapper to also cache parameters ([#3641](https://github.com/getsentry/sentry-java/pull/3641))
   - Previously only the body was cached which could lead to problems in the FilterChain as Request parameters were not available
+- We now hold a strong reference to the underlying OpenTelemetry span when it is created through Sentry API ([#3997](https://github.com/getsentry/sentry-java/pull/3997))
+  - This keeps it from being garbage collected too early
+- Close backpressure monitor on SDK shutdown ([#3998](https://github.com/getsentry/sentry-java/pull/3998))
+  - Due to the backpressure monitor rescheduling a task to run every 10s, it very likely caused shutdown to wait the full `shutdownTimeoutMillis` (defaulting to 2s) instead of being able to terminate immediately
+- Improve ignored check performance ([#3992](https://github.com/getsentry/sentry-java/pull/3992))
+  - Checking if a span origin, a transaction or a checkIn should be ignored is now faster 
 
 ## 8.0.0-rc.2
 

sentry-android-core/src/main/java/io/sentry/android/core/AndroidOptionsInitializer.java

@@ -15,6 +15,7 @@
 import io.sentry.SendFireAndForgetEnvelopeSender;
 import io.sentry.SendFireAndForgetOutboxSender;
 import io.sentry.SentryLevel;
+import io.sentry.SentryOpenTelemetryMode;
 import io.sentry.android.core.cache.AndroidEnvelopeCache;
 import io.sentry.android.core.internal.debugmeta.AssetsDebugMetaLoader;
 import io.sentry.android.core.internal.gestures.AndroidViewGestureTargetLocator;
@@ -101,7 +102,7 @@ static void loadDefaultAndMetadataOptions(
     options.setLogger(logger);
 
     options.setDefaultScopeType(ScopeType.CURRENT);
-
+    options.setOpenTelemetryMode(SentryOpenTelemetryMode.OFF);
     options.setDateProvider(new SentryAndroidDateProvider());
 
     // set a lower flush timeout on Android to avoid ANRs

sentry-android-core/src/test/java/io/sentry/android/core/EnvelopeFileObserverIntegrationTest.kt

@@ -52,7 +52,12 @@ class EnvelopeFileObserverIntegrationTest {
 
     @AfterTest
     fun shutdown() {
-        Files.delete(file.toPath())
+        delete(file)
+    }
+
+    private fun delete(f: File) {
+        f.listFiles()?.forEach { delete(it) }
+        Files.delete(f.toPath())
     }
 
     @Test

sentry-android-core/src/test/java/io/sentry/android/core/InternalSentrySdkTest.kt

@@ -55,7 +55,7 @@ class InternalSentrySdkTest {
         lateinit var options: SentryOptions
 
         fun init(context: Context) {
-            SentryAndroid.init(context) { options ->
+            initForTest(context) { options ->
                 this@Fixture.options = options
                 options.dsn = "https://key@host/proj"
                 options.setTransportFactory { _, _ ->

sentry-android-core/src/test/java/io/sentry/android/core/SentryAndroidTest.kt

@@ -15,6 +15,7 @@ import io.sentry.Hint
 import io.sentry.ILogger
 import io.sentry.ISentryClient
 import io.sentry.Sentry
+import io.sentry.Sentry.OptionsConfiguration
 import io.sentry.SentryEnvelope
 import io.sentry.SentryLevel
 import io.sentry.SentryLevel.DEBUG
@@ -40,6 +41,8 @@ import io.sentry.cache.PersistingScopeObserver
 import io.sentry.cache.PersistingScopeObserver.BREADCRUMBS_FILENAME
 import io.sentry.cache.PersistingScopeObserver.SCOPE_CACHE
 import io.sentry.cache.PersistingScopeObserver.TRANSACTION_FILENAME
+import io.sentry.test.applyTestOptions
+import io.sentry.test.initForTest
 import io.sentry.transport.NoOpEnvelopeCache
 import io.sentry.util.StringUtils
 import org.awaitility.kotlin.await
@@ -100,9 +103,9 @@ class SentryAndroidTest {
             }
             val mockContext = context ?: ContextUtilsTestHelper.mockMetaData(metaData = metadata)
             when {
-                logger != null -> SentryAndroid.init(mockContext, logger)
-                options != null -> SentryAndroid.init(mockContext, options)
-                else -> SentryAndroid.init(mockContext)
+                logger != null -> initForTest(mockContext, logger)
+                options != null -> initForTest(mockContext, options)
+                else -> initForTest(mockContext)
             }
         }
 
@@ -290,7 +293,7 @@ class SentryAndroidTest {
 
         val mockContext = ContextUtilsTestHelper.createMockContext(true)
         val cacheDirPath = Files.createTempDirectory("new_cache").absolutePathString()
-        SentryAndroid.init(mockContext) {
+        initForTest(mockContext) {
             it.dsn = "https://key@sentry.io/123"
             it.cacheDirPath = cacheDirPath
             options = it
@@ -354,7 +357,7 @@ class SentryAndroidTest {
     @Test
     fun `When initializing Sentry a callback is added to application by appStartMetrics`() {
         val mockContext = ContextUtilsTestHelper.createMockContext(true)
-        SentryAndroid.init(mockContext) {
+        initForTest(mockContext) {
             it.dsn = "https://key@sentry.io/123"
         }
         verify(mockContext.applicationContext as Application).registerActivityLifecycleCallbacks(eq(AppStartMetrics.getInstance()))
@@ -368,7 +371,7 @@ class SentryAndroidTest {
         Mockito.mockStatic(ContextUtils::class.java, Mockito.CALLS_REAL_METHODS).use { mockedContextUtils ->
             mockedContextUtils.`when`<Any> { ContextUtils.isForegroundImportance() }
                 .thenReturn(inForeground)
-            SentryAndroid.init(context) { options ->
+            initForTest(context) { options ->
                 options.release = "prod"
                 options.dsn = "https://key@sentry.io/123"
                 options.isEnableAutoSessionTracking = true
@@ -558,3 +561,18 @@ class SentryAndroidTest {
         override fun discard(envelope: SentryEnvelope) = Unit
     }
 }
+
+fun initForTest(context: Context, optionsConfiguration: OptionsConfiguration<SentryAndroidOptions>) {
+    SentryAndroid.init(context) {
+        applyTestOptions(it)
+        optionsConfiguration.configure(it)
+    }
+}
+
+fun initForTest(context: Context, logger: ILogger) {
+    SentryAndroid.init(context, logger)
+}
+
+fun initForTest(context: Context) {
+    SentryAndroid.init(context)
+}

sentry-android-core/src/test/java/io/sentry/android/core/SentryLogcatAdapterTest.kt

@@ -30,8 +30,8 @@ class SentryLogcatAdapterTest {
             }
             val mockContext = ContextUtilsTestHelper.mockMetaData(metaData = metadata)
             when {
-                options != null -> SentryAndroid.init(mockContext, options)
-                else -> SentryAndroid.init(mockContext)
+                options != null -> initForTest(mockContext, options)
+                else -> initForTest(mockContext)
             }
         }
     }

sentry-android-core/src/test/java/io/sentry/android/core/SessionTrackingIntegrationTest.kt

@@ -44,7 +44,7 @@ class SessionTrackingIntegrationTest {
     @Test
     fun `session tracking works properly with multiple backgrounds and foregrounds`() {
         lateinit var options: SentryAndroidOptions
-        SentryAndroid.init(context) {
+        initForTest(context) {
             it.dsn = "https://key@sentry.io/proj"
             it.release = "io.sentry.samples@2.3.0"
             it.environment = "production"

sentry-android-integration-tests/sentry-uitest-android-benchmark/build.gradle.kts

@@ -99,6 +99,7 @@ dependencies {
     errorprone(Config.CompileOnly.errorprone)
     errorprone(Config.CompileOnly.errorProneNullAway)
 
+    androidTestImplementation(projects.sentryTestSupport)
     androidTestImplementation(Config.TestLibs.kotlinTestJunit)
     androidTestImplementation(Config.TestLibs.espressoCore)
     androidTestImplementation(Config.TestLibs.androidxTestCoreKtx)