Add event attribute extractor (#1104)

* wire up EventAttributesExtractor to ANRs

* wire up EventAttributesExtractor to crash instrumentation, fix tests.

* fix javadoc

Author: breedx-splk

android-agent/src/main/kotlin/io/opentelemetry/android/agent/OpenTelemetryRumInitializer.kt

@@ -18,6 +18,7 @@ import io.opentelemetry.android.instrumentation.AndroidInstrumentation
 import io.opentelemetry.android.instrumentation.AndroidInstrumentationLoader
 import io.opentelemetry.android.instrumentation.activity.ActivityLifecycleInstrumentation
 import io.opentelemetry.android.instrumentation.anr.AnrInstrumentation
+import io.opentelemetry.android.instrumentation.common.EventAttributesExtractor
 import io.opentelemetry.android.instrumentation.common.ScreenNameExtractor
 import io.opentelemetry.android.instrumentation.crash.CrashDetails
 import io.opentelemetry.android.instrumentation.crash.CrashReporterInstrumentation
@@ -31,7 +32,6 @@ import io.opentelemetry.api.trace.Tracer
 import io.opentelemetry.exporter.otlp.http.logs.OtlpHttpLogRecordExporter
 import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter
 import io.opentelemetry.exporter.otlp.http.trace.OtlpHttpSpanExporter
-import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor
 import java.time.Duration
 
 object OpenTelemetryRumInitializer {
@@ -81,8 +81,8 @@ object OpenTelemetryRumInitializer {
         activityNameExtractor: ScreenNameExtractor? = null,
         fragmentTracerCustomizer: ((Tracer) -> Tracer)? = null,
         fragmentNameExtractor: ScreenNameExtractor? = null,
-        anrAttributesExtractors: List<AttributesExtractor<Array<StackTraceElement>, Void>> = emptyList(),
-        crashAttributesExtractors: List<AttributesExtractor<CrashDetails, Void>> = emptyList(),
+        anrAttributesExtractors: List<EventAttributesExtractor<Array<StackTraceElement>>> = emptyList(),
+        crashAttributesExtractors: List<EventAttributesExtractor<CrashDetails>> = emptyList(),
         networkChangeAttributesExtractors: List<NetworkAttributesExtractor> = emptyList(),
         slowRenderingDetectionPollInterval: Duration? = null,
     ): OpenTelemetryRum {
@@ -135,8 +135,8 @@ object OpenTelemetryRumInitializer {
         activityNameExtractor: ScreenNameExtractor?,
         fragmentTracerCustomizer: ((Tracer) -> Tracer)?,
         fragmentNameExtractor: ScreenNameExtractor?,
-        anrAttributesExtractors: List<AttributesExtractor<Array<StackTraceElement>, Void>>,
-        crashAttributesExtractors: List<AttributesExtractor<CrashDetails, Void>>,
+        anrAttributesExtractors: List<EventAttributesExtractor<Array<StackTraceElement>>>,
+        crashAttributesExtractors: List<EventAttributesExtractor<CrashDetails>>,
         networkChangeAttributesExtractors: List<NetworkAttributesExtractor>,
         slowRenderingDetectionPollInterval: Duration?,
     ) {

instrumentation/anr/build.gradle.kts

@@ -20,6 +20,7 @@ android {
 dependencies {
     api(project(":instrumentation:android-instrumentation"))
     implementation(project(":services"))
+    implementation(project(":instrumentation:common-api"))
     api(platform(libs.opentelemetry.platform.alpha))
     api(libs.opentelemetry.api)
     implementation(libs.androidx.core)

instrumentation/anr/src/main/java/io/opentelemetry/android/instrumentation/anr/AnrDetector.java

@@ -7,23 +7,23 @@
 
 import android.os.Handler;
 import android.os.Looper;
+import io.opentelemetry.android.instrumentation.common.EventAttributesExtractor;
 import io.opentelemetry.android.internal.services.applifecycle.AppLifecycle;
 import io.opentelemetry.api.OpenTelemetry;
 import io.opentelemetry.api.logs.Logger;
-import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import java.util.List;
 import java.util.concurrent.ScheduledExecutorService;
 
 /** Entrypoint for installing the ANR (application not responding) detection instrumentation. */
 public final class AnrDetector {
-    private final List<AttributesExtractor<StackTraceElement[], Void>> additionalExtractors;
+    private final List<EventAttributesExtractor<StackTraceElement[]>> additionalExtractors;
     private final Looper mainLooper;
     private final ScheduledExecutorService scheduler;
     private final AppLifecycle appLifecycle;
     private final OpenTelemetry openTelemetry;
 
     AnrDetector(
-            List<AttributesExtractor<StackTraceElement[], Void>> additionalExtractors,
+            List<EventAttributesExtractor<StackTraceElement[]>> additionalExtractors,
             Looper mainLooper,
             ScheduledExecutorService scheduler,
             AppLifecycle appLifecycle,

instrumentation/anr/src/main/java/io/opentelemetry/android/instrumentation/anr/AnrInstrumentation.java

@@ -10,8 +10,8 @@
 import com.google.auto.service.AutoService;
 import io.opentelemetry.android.instrumentation.AndroidInstrumentation;
 import io.opentelemetry.android.instrumentation.InstallationContext;
+import io.opentelemetry.android.instrumentation.common.EventAttributesExtractor;
 import io.opentelemetry.android.internal.services.Services;
-import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.Executors;
@@ -22,14 +22,14 @@
 public final class AnrInstrumentation implements AndroidInstrumentation {
 
     public static final String INSTRUMENTATION_NAME = "anr";
-    final List<AttributesExtractor<StackTraceElement[], Void>> additionalExtractors =
+    final List<EventAttributesExtractor<StackTraceElement[]>> additionalExtractors =
             new ArrayList<>();
     Looper mainLooper = Looper.getMainLooper();
     ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);
 
-    /** Adds an {@link AttributesExtractor} that will extract additional attributes. */
+    /** Adds an {@link EventAttributesExtractor} that will extract additional attributes. */
     public AnrInstrumentation addAttributesExtractor(
-            AttributesExtractor<StackTraceElement[], Void> extractor) {
+            EventAttributesExtractor<StackTraceElement[]> extractor) {
         additionalExtractors.add(extractor);
         return this;
     }

instrumentation/anr/src/main/java/io/opentelemetry/android/instrumentation/anr/AnrWatcher.kt

@@ -6,11 +6,11 @@
 package io.opentelemetry.android.instrumentation.anr
 
 import android.os.Handler
+import io.opentelemetry.android.instrumentation.common.EventAttributesExtractor
 import io.opentelemetry.api.common.Attributes
 import io.opentelemetry.api.incubator.logs.ExtendedLogRecordBuilder
 import io.opentelemetry.api.logs.Logger
 import io.opentelemetry.context.Context
-import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor
 import io.opentelemetry.semconv.ExceptionAttributes.EXCEPTION_STACKTRACE
 import io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_ID
 import io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_NAME
@@ -32,7 +32,7 @@ internal class AnrWatcher(
     private val uiHandler: Handler,
     private val mainThread: Thread,
     private val anrLogger: Logger,
-    private val additionalExtractors: List<AttributesExtractor<Array<StackTraceElement>, Void>>,
+    private val additionalExtractors: List<EventAttributesExtractor<Array<StackTraceElement>>>,
     private val pollDurationNs: Long = DEFAULT_POLL_DURATION_NS,
 ) : Runnable {
     private val anrCounter = AtomicInteger()
@@ -45,7 +45,7 @@ internal class AnrWatcher(
         uiHandler: Handler,
         mainThread: Thread,
         anrLogger: Logger,
-        additionalExtractors: List<AttributesExtractor<Array<StackTraceElement>, Void>>,
+        additionalExtractors: List<EventAttributesExtractor<Array<StackTraceElement>>>,
     ) :
         this(uiHandler, mainThread, anrLogger, additionalExtractors, DEFAULT_POLL_DURATION_NS)
 
@@ -82,7 +82,8 @@ internal class AnrWatcher(
                 .put(EXCEPTION_STACKTRACE, stackTraceToString(stackTrace))
 
         for (extractor in additionalExtractors) {
-            extractor.onStart(attributesBuilder, Context.current(), stackTrace)
+            val extractedAttributes = extractor.extract(Context.current(), stackTrace)
+            attributesBuilder.putAll(extractedAttributes)
         }
 
         val eventBuilder = anrLogger.logRecordBuilder() as ExtendedLogRecordBuilder

instrumentation/anr/src/test/java/io/opentelemetry/android/instrumentation/anr/AnrDetectorTest.java

@@ -6,15 +6,16 @@
 package io.opentelemetry.android.instrumentation.anr;
 
 import static io.opentelemetry.api.common.AttributeKey.stringKey;
-import static io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor.constant;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.ArgumentMatchers.isA;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
 import android.os.Looper;
+import io.opentelemetry.android.instrumentation.common.EventAttributesExtractor;
 import io.opentelemetry.android.internal.services.applifecycle.AppLifecycle;
 import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import java.util.Collections;
 import java.util.concurrent.ScheduledExecutorService;
@@ -36,9 +37,11 @@ void shouldInstallInstrumentation() {
         when(mainLooper.getThread()).thenReturn(new Thread());
         OpenTelemetry openTelemetry = OpenTelemetrySdk.builder().build();
 
+        EventAttributesExtractor<StackTraceElement[]> extractor =
+                (parentContext, o) -> Attributes.of(stringKey("test.key"), "abc");
         AnrDetector anrDetector =
                 new AnrDetector(
-                        Collections.singletonList(constant(stringKey("test.key"), "abc")),
+                        Collections.singletonList(extractor),
                         mainLooper,
                         scheduler,
                         appLifecycle,

instrumentation/common-api/src/main/java/io/opentelemetry/android/instrumentation/common/EventAttributesExtractor.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.android.instrumentation.common
+
+import io.opentelemetry.api.common.Attributes
+import io.opentelemetry.context.Context
+
+/**
+ * Extractor of point-in-time attributes. Whereas the AttributesExtractor in the
+ * upstream instrumentation api is targeted at tracing/spans (onStart, onEnd),
+ * this extractor operates purely on the parentContext and a generic SUBJECT
+ * at a point in time. The resulting Attributes will all be added to the event
+ * that is being generated.
+ */
+interface EventAttributesExtractor<SUBJECT> {
+    fun extract(
+        parentContext: Context,
+        subject: SUBJECT,
+    ): Attributes
+}

instrumentation/crash/build.gradle.kts

@@ -18,6 +18,7 @@ dependencies {
     implementation(project(":common"))
     implementation(project(":services"))
     implementation(project(":session"))
+    implementation(project(":instrumentation:common-api"))
     api(platform(libs.opentelemetry.platform.alpha))
     api(libs.opentelemetry.api)
     implementation(libs.androidx.core)

instrumentation/crash/src/main/java/io/opentelemetry/android/instrumentation/crash/CrashReporter.java

@@ -11,23 +11,23 @@
 import static io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_ID;
 import static io.opentelemetry.semconv.incubating.ThreadIncubatingAttributes.THREAD_NAME;
 
+import io.opentelemetry.android.instrumentation.common.EventAttributesExtractor;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.AttributesBuilder;
 import io.opentelemetry.api.incubator.logs.ExtendedLogRecordBuilder;
 import io.opentelemetry.api.logs.Logger;
 import io.opentelemetry.api.logs.LoggerProvider;
 import io.opentelemetry.context.Context;
-import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import java.io.PrintWriter;
 import java.io.StringWriter;
 import java.util.List;
 import java.util.function.Consumer;
 
 public final class CrashReporter {
-    private final List<AttributesExtractor<CrashDetails, Void>> additionalExtractors;
+    private final List<EventAttributesExtractor<CrashDetails>> additionalExtractors;
 
-    public CrashReporter(List<AttributesExtractor<CrashDetails, Void>> additionalExtractors) {
+    public CrashReporter(List<EventAttributesExtractor<CrashDetails>> additionalExtractors) {
         this.additionalExtractors = additionalExtractors;
     }
 
@@ -55,8 +55,9 @@ private void emitCrashEvent(Logger crashReporter, CrashDetails crashDetails) {
                         .put(EXCEPTION_STACKTRACE, stackTraceToString(throwable))
                         .put(EXCEPTION_TYPE, throwable.getClass().getName());
 
-        for (AttributesExtractor<CrashDetails, Void> extractor : additionalExtractors) {
-            extractor.onStart(attributesBuilder, Context.current(), crashDetails);
+        for (EventAttributesExtractor<CrashDetails> extractor : additionalExtractors) {
+            Attributes extractedAttributes = extractor.extract(Context.current(), crashDetails);
+            attributesBuilder.putAll(extractedAttributes);
         }
 
         ExtendedLogRecordBuilder eventBuilder =

instrumentation/crash/src/main/java/io/opentelemetry/android/instrumentation/crash/CrashReporterInstrumentation.java

@@ -7,10 +7,9 @@
 
 import androidx.annotation.NonNull;
 import com.google.auto.service.AutoService;
-import io.opentelemetry.android.common.RuntimeDetailsExtractor;
 import io.opentelemetry.android.instrumentation.AndroidInstrumentation;
 import io.opentelemetry.android.instrumentation.InstallationContext;
-import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
+import io.opentelemetry.android.instrumentation.common.EventAttributesExtractor;
 import io.opentelemetry.sdk.OpenTelemetrySdk;
 import java.util.ArrayList;
 import java.util.List;
@@ -19,11 +18,11 @@
 @AutoService(AndroidInstrumentation.class)
 public final class CrashReporterInstrumentation implements AndroidInstrumentation {
     private static final String INSTRUMENTATION_NAME = "crash";
-    private final List<AttributesExtractor<CrashDetails, Void>> additionalExtractors =
+    private final List<EventAttributesExtractor<CrashDetails>> additionalExtractors =
             new ArrayList<>();
 
-    /** Adds an {@link AttributesExtractor} that will extract additional attributes. */
-    public void addAttributesExtractor(AttributesExtractor<CrashDetails, Void> extractor) {
+    /** Adds an {@link EventAttributesExtractor} that will extract additional attributes. */
+    public void addAttributesExtractor(EventAttributesExtractor<CrashDetails> extractor) {
         additionalExtractors.add(extractor);
     }