Merge branch 'main' into feat/anr-native-symbolication

Author: markushi

.craft.yml

@@ -43,14 +43,15 @@ targets:
       maven:io.sentry:sentry-openfeign:
       maven:io.sentry:sentry-opentelemetry-agent:
       maven:io.sentry:sentry-opentelemetry-agentcustomization:
+      maven:io.sentry:sentry-opentelemetry-agentless:
+      maven:io.sentry:sentry-opentelemetry-agentless-spring:
+      maven:io.sentry:sentry-opentelemetry-bootstrap:
       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:
-#      maven:io.sentry:sentry-graphql-core:
-#      maven:io.sentry:sentry-graphql-22:
+      maven:io.sentry:sentry-graphql-22:
+      maven:io.sentry:sentry-graphql-core:
       maven:io.sentry:sentry-quartz:
       maven:io.sentry:sentry-okhttp:
       maven:io.sentry:sentry-android-navigation:

CHANGELOG.md

@@ -13,7 +13,7 @@ android.useAndroidX=true
 android.defaults.buildfeatures.buildconfig=true
 
 # Release information
-versionName=8.0.0-rc.4
+versionName=8.0.0
 
 # Override the SDK name on native crashes on Android
 sentryAndroidSdkName=sentry.native.android

gradle.properties

@@ -580,7 +580,7 @@ private void mergeUser(final @NotNull SentryBaseEvent event) {
     if (user.getId() == null) {
       user.setId(getDeviceId());
     }
-    if (user.getIpAddress() == null) {
+    if (user.getIpAddress() == null && options.isSendDefaultPii()) {
       user.setIpAddress(IpAddressUtils.DEFAULT_IP_ADDRESS);
     }
   }

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

@@ -156,7 +156,7 @@ private void mergeUser(final @NotNull SentryBaseEvent event) {
     if (user.getId() == null) {
       user.setId(Installation.id(context));
     }
-    if (user.getIpAddress() == null) {
+    if (user.getIpAddress() == null && options.isSendDefaultPii()) {
       user.setIpAddress(IpAddressUtils.DEFAULT_IP_ADDRESS);
     }
   }

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

@@ -85,18 +85,20 @@ class AnrV2EventProcessorTest {
         lateinit var context: Context
         val options = SentryAndroidOptions().apply {
             setLogger(NoOpLogger.getInstance())
-            isSendDefaultPii = true
         }
 
         fun getSut(
             dir: TemporaryFolder,
             currentSdk: Int = Build.VERSION_CODES.LOLLIPOP,
             populateScopeCache: Boolean = false,
             populateOptionsCache: Boolean = false,
-            replayErrorSampleRate: Double? = null
+            replayErrorSampleRate: Double? = null,
+            isSendDefaultPii: Boolean = true
         ): AnrV2EventProcessor {
             options.cacheDirPath = dir.newFolder().absolutePath
             options.environment = "release"
+            options.isSendDefaultPii = isSendDefaultPii
+
             whenever(buildInfo.sdkInfoVersion).thenReturn(currentSdk)
             whenever(buildInfo.isEmulator).thenReturn(true)
 
@@ -278,6 +280,7 @@ class AnrV2EventProcessorTest {
         // user
         assertEquals("bot", processed.user!!.username)
         assertEquals("[email protected]", processed.user!!.id)
+        assertEquals("{{auto}}", processed.user!!.ipAddress)
         // trace
         assertEquals("ui.load", processed.contexts.trace!!.operation)
         // tags
@@ -304,6 +307,13 @@ class AnrV2EventProcessorTest {
         assertEquals("Google Chrome", processed.contexts.browser!!.name)
     }
 
+    @Test
+    fun `when backfillable event is enrichable, does not backfill user ip`() {
+        val hint = HintUtils.createWithTypeCheckHint(BackfillableHint())
+        val processed = processEvent(hint, isSendDefaultPii = false, populateScopeCache = true)
+        assertNull(processed.user!!.ipAddress)
+    }
+
     @Test
     fun `when backfillable event is enrichable, backfills serialized options data`() {
         val hint = HintUtils.createWithTypeCheckHint(BackfillableHint())
@@ -617,14 +627,16 @@ class AnrV2EventProcessorTest {
         hint: Hint,
         populateScopeCache: Boolean = false,
         populateOptionsCache: Boolean = false,
+        isSendDefaultPii: Boolean = true,
         configureEvent: SentryEvent.() -> Unit = {}
     ): SentryEvent {
         val original = SentryEvent().apply(configureEvent)
 
         val processor = fixture.getSut(
             tmpDir,
             populateScopeCache = populateScopeCache,
-            populateOptionsCache = populateOptionsCache
+            populateOptionsCache = populateOptionsCache,
+            isSendDefaultPii = isSendDefaultPii
         )
         return processor.process(original, hint)!!
     }

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

@@ -66,7 +66,11 @@ class DefaultAndroidEventProcessorTest {
 
         lateinit var sentryTracer: SentryTracer
 
-        fun getSut(context: Context): DefaultAndroidEventProcessor {
+        fun getSut(
+            context: Context,
+            isSendDefaultPii: Boolean = false
+        ): DefaultAndroidEventProcessor {
+            options.isSendDefaultPii = isSendDefaultPii
             whenever(scopes.options).thenReturn(options)
             sentryTracer = SentryTracer(TransactionContext("", ""), scopes)
             return DefaultAndroidEventProcessor(context, buildInfo, options)
@@ -284,8 +288,20 @@ class DefaultAndroidEventProcessorTest {
     }
 
     @Test
-    fun `when event user data does not have ip address set, sets {{auto}} as the ip address`() {
-        val sut = fixture.getSut(context)
+    fun `when event user data does not have ip address set, sets no ip address if sendDefaultPii is false`() {
+        val sut = fixture.getSut(context, isSendDefaultPii = false)
+        val event = SentryEvent().apply {
+            user = User()
+        }
+        sut.process(event, Hint())
+        assertNotNull(event.user) {
+            assertNull(it.ipAddress)
+        }
+    }
+
+    @Test
+    fun `when event user data does not have ip address set, sets {{auto}} if sendDefaultPii is true`() {
+        val sut = fixture.getSut(context, isSendDefaultPii = true)
         val event = SentryEvent().apply {
             user = User()
         }

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

@@ -22,6 +22,9 @@ private SentryNdk() {}
               try {
                 //noinspection UnstableApiUsage
                 io.sentry.ndk.SentryNdk.loadNativeLibraries();
+              } catch (Throwable t) {
+                // ignored
+                // if loadLibrary() fails, the later init() will throw an exception anyway
               } finally {
                 loadLibraryLatch.countDown();
               }

sentry-android-ndk/src/main/java/io/sentry/android/ndk/SentryNdk.java

@@ -1,7 +1,5 @@
 # sentry-opentelemetry
 
-*NOTE: Our OpenTelemetry modules are still experimental. Any feedback is welcome.*
-
 ## OpenTelemetry
 
 More information on OpenTelemetry can be found on their [website](https://opentelemetry.io/) as well
@@ -21,8 +19,7 @@ application. Please see the module [README](sentry-opentelemetry-agent/README.md
 
 This contains customizations to the OpenTelemetry Java Agent such as registering the
 `SentrySpanProcessor` and `SentryPropagator` as well as providing default properties that
-enable the `sentry` propagator and disable exporters so our agent doesn't trigger lots of log 
-warnings due to OTLP server not being there. This can also be used without the agent.
+enable the `sentry` propagator.
 
 ### `sentry-opentelemetry-bootstrap`
 
@@ -39,4 +36,50 @@ you also need this module as a dependency.
 Contains `SentrySpanProcessor` and `SentryPropagator` which are used by our Java Agent but can also
 be used when manually instrumenting using OpenTelemetry. If you want to use OpenTelemetry without
 the agent but still want some configuration convenience, you should rather use the
-`sentry-opentelemetry-agentcustomization` module.
+`sentry-opentelemetry-agentless` module or the `sentry-opentelemetry-agentless-spring` module if you are using Spring Boot.
+
+### `sentry-opentelemetry-agentless`
+Combines all modules and dependencies needed to use Sentry with OpenTelemetry without the agent.
+
+### `sentry-opentelemetry-agentless-spring`
+Combines all modules and dependencies needed to use Sentry with OpenTelemetry in Spring Boot without an agent.
+
+## Running without an Agent
+If you want to use Sentry with OpenTelemetry without an agent, you can do so by adding the `sentry-opentelemetry-agentless` (or `sentry-opentelemetry-agentless-spring`) module as dependency to your project. 
+
+And run your application with the following JVM arguments:
+```
+-Dotel.java.global-autoconfigure.enabled=true
+```
+You may also want to set the following environment variables to if you do not use OpenTelemetry exporters:
+`OTEL_LOGS_EXPORTER=none;OTEL_METRICS_EXPORTER=none;OTEL_TRACES_EXPORTER=none`
+
+Alternatively you can initialize OpenTelemetry programmatically like this:
+
+```java
+// Initialize OpenTelemetry by using the AutoConfiguredOpenTelemetrySdk which automatically
+// registers the `SentrySpanProcessor` and `SentryPropagator` and others.
+// Also, you need to disable the OTEL exporters if you do not use them.
+AutoConfiguredOpenTelemetrySdk.builder()
+  .setResultAsGlobal()
+  .addPropertiesSupplier(() -> {
+final Map<String, String> properties = new HashMap<>();
+    properties.put("otel.logs.exporter", "none");
+    properties.put("otel.metrics.exporter", "none");
+    properties.put("otel.traces.exporter", "none");
+    return properties;
+  })
+  .build();
+```
+
+And then initialize Sentry as usual:
+
+```java
+// Initialize Sentry
+Sentry.init(
+    options -> {
+    options.setDsn("...");
+      ...
+  }
+)
+```

sentry-opentelemetry/README.md

@@ -1,7 +1,5 @@
 # sentry-opentelemetry-agent
 
-*NOTE: Our OpenTelemetry modules are still experimental. Any feedback is welcome.*
-
 ## How to use it
 
 Download the latest `sentry-opentelemetry-agent.jar` and use it when launching your Java
@@ -21,30 +19,24 @@ For more details on configuring Sentry via `sentry.properties` please see the
 [docs page](https://docs.sentry.io/platforms/java/configuration/).
 
 As an alternative to the `SENTRY_PROPERTIES_FILE` environment variable you can provide individual
-settings as environment variables (e.g. `SENTRY_DSN=...`) or you may initialize `Sentry` inside
-your target application. If you do so, please make sure to set the `instrumenter` to `otel`, e.g.
-like this:
+settings as environment variables (e.g. `SENTRY_DSN=...`).
+
+## Controlling auto initialization of Sentry
+
+By default, if you pass either `SENTRY_DSN` or `SENTRY_PROPERTIES_FILE` as environment variable,
+Sentry will automatically be initialized by this agent. To disable this behaviour, you can set
+`SENTRY_AUTO_INIT=false` as environment variable. You will then have to use a Sentry SDK that takes care of initialization or initialize Sentry manually inside
+the target application:
 
 ```
 Sentry.init(
         options -> {
           options.setDsn("...");
           ...
-          options.setInstrumenter(Instrumenter.OTEL);
         }
 )
 ```
 
-Using the `otel` instrumenter will ensure `Sentry` instrumentation will be done via OpenTelemetry
-and integrations as well as direct interactions with transactions and spans have no effect.
-
-## Controlling auto initialization of Sentry
-
-By default if you pass either `SENTRY_DSN` or `SENTRY_PROPERTIES_FILE` as environment variable,
-Sentry will automatically be initialized by this agent. To disable this behaviour, you can set
-`SENTRY_AUTO_INIT=false` as environment variable. You will then have to initialize Sentry inside
-the target application.
-
 ## Debugging
 
 To enable debug logging for Sentry, please provide `SENTRY_DEBUG=true` as environment variable or
@@ -62,6 +54,7 @@ Example log message:
 ```
 ERROR io.opentelemetry.exporter.internal.grpc.OkHttpGrpcExporter - Failed to export spans. The request could not be executed. Full error message: Failed to connect to localhost/[0:0:0:0:0:0:0:1]:4317
 ERROR io.opentelemetry.exporter.internal.grpc.OkHttpGrpcExporter - Failed to export metrics. The request could not be executed. Full error message: Failed to connect to localhost/[0:0:0:0:0:0:0:1]:4317
+ERROR io.opentelemetry.exporter.internal.http.HttpExporter - Failed to export logs. The request could not be executed. Full error message: Failed to connect to localhost/[0:0:0:0:0:0:0:1]:4318
 ```
 
 ### Traces
@@ -73,3 +66,8 @@ see [OpenTelemetry GitHub](https://github.com/open-telemetry/opentelemetry-java/
 
 To turn off exporting of metrics you can set `OTEL_METRICS_EXPORTER=none`
 see [OpenTelemetry GitHub](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure#otlp-exporter-span-metric-and-log-exporters)
+
+### Logs
+
+To turn off log exporting, set `OTEL_LOGS_EXPORTER=none` 
+see [OpenTelemetry GitHub](https://github.com/open-telemetry/opentelemetry-java/tree/main/sdk-extensions/autoconfigure#otlp-exporter-span-metric-and-log-exporters).