Add the current screen name to crash events (open-telemetry#704)

* move SessionIdLogRecordAppender.kt into internal package * fix test * add screen appender log processor * wire up to builder and fix tests * spotless
Hinge · Nov 21, 2024 · c10adba · c10adba
1 parent 56dbb88
commit c10adba
Show file tree

Hide file tree

Showing 6 changed files with 79 additions and 5 deletions.
diff --git a/core/src/main/java/io/opentelemetry/android/OpenTelemetryRumBuilder.java b/core/src/main/java/io/opentelemetry/android/OpenTelemetryRumBuilder.java
@@ -23,6 +23,8 @@
 import io.opentelemetry.android.internal.features.persistence.SimpleTemporaryFileProvider;
 import io.opentelemetry.android.internal.initialization.InitializationEvents;
 import io.opentelemetry.android.internal.processors.GlobalAttributesLogRecordAppender;
+import io.opentelemetry.android.internal.processors.ScreenAttributesLogRecordProcessor;
+import io.opentelemetry.android.internal.processors.SessionIdLogRecordAppender;
 import io.opentelemetry.android.internal.services.CacheStorage;
 import io.opentelemetry.android.internal.services.Preferences;
 import io.opentelemetry.android.internal.services.ServiceManager;
@@ -478,6 +480,9 @@ private SdkLoggerProvider buildLoggerProvider(
                 SdkLoggerProvider.builder()
                         .setResource(resource)
                         .addLogRecordProcessor(new SessionIdLogRecordAppender(sessionProvider))
+                        .addLogRecordProcessor(
+                                new ScreenAttributesLogRecordProcessor(
+                                        getServiceManager().getVisibleScreenService()))
                         .addLogRecordProcessor(
                                 new GlobalAttributesLogRecordAppender(
                                         config.getGlobalAttributesSupplier()));

diff --git a/...n/java/io/opentelemetry/android/internal/processors/ScreenAttributesLogRecordProcessor.kt b/...n/java/io/opentelemetry/android/internal/processors/ScreenAttributesLogRecordProcessor.kt
@@ -0,0 +1,22 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.android.internal.processors
+
+import io.opentelemetry.android.common.RumConstants
+import io.opentelemetry.android.internal.services.visiblescreen.VisibleScreenService
+import io.opentelemetry.context.Context
+import io.opentelemetry.sdk.logs.LogRecordProcessor
+import io.opentelemetry.sdk.logs.ReadWriteLogRecord
+
+class ScreenAttributesLogRecordProcessor(val visibleScreenService: VisibleScreenService) : LogRecordProcessor {
+    override fun onEmit(
+        context: Context,
+        logRecord: ReadWriteLogRecord,
+    ) {
+        val currentScreen = visibleScreenService.currentlyVisibleScreen
+        logRecord.setAttribute(RumConstants.SCREEN_NAME_KEY, currentScreen)
+    }
+}
diff --git a/...try/android/SessionIdLogRecordAppender.kt → .../processors/SessionIdLogRecordAppender.kt b/...try/android/SessionIdLogRecordAppender.kt → .../processors/SessionIdLogRecordAppender.kt
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.android
+package io.opentelemetry.android.internal.processors
 
 import io.opentelemetry.android.session.SessionProvider
 import io.opentelemetry.context.Context

diff --git a/core/src/test/java/io/opentelemetry/android/OpenTelemetryRumBuilderTest.java b/core/src/test/java/io/opentelemetry/android/OpenTelemetryRumBuilderTest.java
@@ -41,6 +41,7 @@
 import io.opentelemetry.android.internal.services.ServiceManager;
 import io.opentelemetry.android.internal.services.applifecycle.AppLifecycleService;
 import io.opentelemetry.android.internal.services.applifecycle.ApplicationStateListener;
+import io.opentelemetry.android.internal.services.visiblescreen.VisibleScreenService;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.KeyValue;
 import io.opentelemetry.api.common.Value;
@@ -83,6 +84,7 @@
 @RunWith(AndroidJUnit4.class)
 public class OpenTelemetryRumBuilderTest {
 
+    public static final String CUR_SCREEN_NAME = "Celebratory Token";
     final Resource resource =
             Resource.getDefault().toBuilder().put("test.attribute", "abcdef").build();
     final InMemorySpanExporter spanExporter = InMemorySpanExporter.create();
@@ -152,8 +154,10 @@ public void shouldBuildTracerProvider() {
 
     @Test
     public void shouldBuildLogRecordProvider() {
+        ServiceManager serviceManager = createServiceManager();
         OpenTelemetryRum openTelemetryRum =
                 makeBuilder()
+                        .setServiceManager(serviceManager)
                         .setResource(resource)
                         .addLoggerProviderCustomizer(
                                 (logRecordProviderBuilder, app) ->
@@ -174,6 +178,7 @@ public void shouldBuildLogRecordProvider() {
                 .hasAttributesSatisfyingExactly(
                         equalTo(SESSION_ID, openTelemetryRum.getRumSessionId()),
                         equalTo(stringKey("event.name"), "test.event"),
+                        equalTo(SCREEN_NAME_KEY, CUR_SCREEN_NAME),
                         equalTo(stringKey("mega"), "hit"))
                 .hasResource(resource);
 
@@ -288,13 +293,18 @@ public void setSpanExporterCustomizer() {
 
     @Test
     public void setLogRecordExporterCustomizer() {
+        ServiceManager serviceManager = createServiceManager();
         AtomicBoolean wasCalled = new AtomicBoolean(false);
         Function<LogRecordExporter, LogRecordExporter> customizer =
                 x -> {
                     wasCalled.set(true);
                     return logsExporter;
                 };
-        OpenTelemetryRum rum = makeBuilder().addLogRecordExporterCustomizer(customizer).build();
+        OpenTelemetryRum rum =
+                makeBuilder()
+                        .setServiceManager(serviceManager)
+                        .addLogRecordExporterCustomizer(customizer)
+                        .build();
 
         Logger logger = rum.getOpenTelemetry().getLogsBridge().loggerBuilder("LogScope").build();
         logger.logRecordBuilder()
@@ -313,6 +323,7 @@ public void setLogRecordExporterCustomizer() {
                 .hasBody("foo")
                 .hasAttributesSatisfyingExactly(
                         equalTo(stringKey("bing"), "bang"),
+                        equalTo(SCREEN_NAME_KEY, CUR_SCREEN_NAME),
                         equalTo(SESSION_ID, rum.getRumSessionId()))
                 .hasSeverity(Severity.FATAL3);
     }
@@ -402,12 +413,14 @@ public void diskBufferingDisabled() {
 
     @Test
     public void verifyGlobalAttrsForLogs() {
+        ServiceManager serviceManager = createServiceManager();
         OtelRumConfig otelRumConfig = buildConfig();
         otelRumConfig.setGlobalAttributes(
                 () -> Attributes.of(stringKey("someGlobalKey"), "someGlobalValue"));
 
         OpenTelemetryRum rum =
                 OpenTelemetryRum.builder(application, otelRumConfig)
+                        .setServiceManager(serviceManager)
                         .addLoggerProviderCustomizer(
                                 (sdkLoggerProviderBuilder, application) ->
                                         sdkLoggerProviderBuilder.addLogRecordProcessor(
@@ -426,6 +439,7 @@ public void verifyGlobalAttrsForLogs() {
                                 .put(SESSION_ID, rum.getRumSessionId())
                                 .put("someGlobalKey", "someGlobalValue")
                                 .put("localAttrKey", "localAttrValue")
+                                .put(SCREEN_NAME_KEY, CUR_SCREEN_NAME)
                                 .build());
     }
 
@@ -459,6 +473,9 @@ private static ServiceManager createServiceManager() {
         when(serviceManager.getAppLifecycleService()).thenReturn(mock(AppLifecycleService.class));
         when(serviceManager.getCacheStorage()).thenReturn(mock(CacheStorage.class));
         when(serviceManager.getPreferences()).thenReturn(mock(Preferences.class));
+        VisibleScreenService screenService = mock(VisibleScreenService.class);
+        when(screenService.getCurrentlyVisibleScreen()).thenReturn(CUR_SCREEN_NAME);
+        when(serviceManager.getVisibleScreenService()).thenReturn(screenService);
         return serviceManager;
     }
 

diff --git a/...va/io/opentelemetry/android/internal/processors/ScreenAttributesLogRecordProcessorTest.kt b/...va/io/opentelemetry/android/internal/processors/ScreenAttributesLogRecordProcessorTest.kt
@@ -0,0 +1,30 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.android.internal.processors
+
+import io.mockk.every
+import io.mockk.mockk
+import io.mockk.verify
+import io.opentelemetry.android.common.RumConstants.SCREEN_NAME_KEY
+import io.opentelemetry.android.internal.services.visiblescreen.VisibleScreenService
+import io.opentelemetry.api.common.AttributeKey
+import io.opentelemetry.sdk.logs.ReadWriteLogRecord
+import org.junit.Test
+
+private const val CURRENT_SCREEN = "party favors"
+
+class ScreenAttributesLogRecordProcessorTest {
+    @Test
+    fun `current screen name is appended`() {
+        val visibleScreenService: VisibleScreenService = mockk()
+        val logRecord: ReadWriteLogRecord = mockk()
+        every { visibleScreenService.currentlyVisibleScreen }.returns(CURRENT_SCREEN)
+        every { logRecord.setAttribute(any<AttributeKey<String>>(), any<String>()) } returns logRecord
+        val testClass = ScreenAttributesLogRecordProcessor(visibleScreenService)
+        testClass.onEmit(mockk(), logRecord)
+        verify { logRecord.setAttribute(SCREEN_NAME_KEY, CURRENT_SCREEN) }
+    }
+}
diff --git a/...android/SessionIdLogRecordAppenderTest.kt → ...cessors/SessionIdLogRecordAppenderTest.kt b/...android/SessionIdLogRecordAppenderTest.kt → ...cessors/SessionIdLogRecordAppenderTest.kt
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.android
+package io.opentelemetry.android.internal.processors
 
 import io.mockk.MockKAnnotations
 import io.mockk.every
@@ -13,7 +13,7 @@ import io.opentelemetry.android.session.SessionProvider
 import io.opentelemetry.api.common.AttributeKey
 import io.opentelemetry.context.Context
 import io.opentelemetry.sdk.logs.ReadWriteLogRecord
-import io.opentelemetry.semconv.incubating.SessionIncubatingAttributes.SESSION_ID
+import io.opentelemetry.semconv.incubating.SessionIncubatingAttributes
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 
@@ -39,6 +39,6 @@ class SessionIdLogRecordAppenderTest {
 
         underTest.onEmit(Context.root(), log)
 
-        verify { log.setAttribute(SESSION_ID, SESSION_ID_VALUE) }
+        verify { log.setAttribute(SessionIncubatingAttributes.SESSION_ID, SESSION_ID_VALUE) }
     }
 }