Add Track Exception APIs, and Error Identifier Attributes Span Processor #1172

tonzhan2 · 2025-02-12T21:44:42Z

Added trackException and trackException APIs to custom tracking module
Added buttons to sample app to test the behavior
Add common:utils module which contains the Error Identifier Extractor logic from the splunk-otel-agent
Add a Error Identifier Attributes Span Processor to :integration:agent:api module that adds the error identifier attributes to any span that has component = "error" or "crash" (so crashes, ANRs, and custom tracked exceptions)
Add some rum constants
Add the new span processor when the agent is initialized.

Testing notes
Logged out spans to logcat in AndroidSpanExporter. After clicking test buttons, can see the exception spans generated, with error identifying attributes service.application_id and service.version_code, as well as any additional attributes from calling the trackException API that allows attributes

logs attached:
trackExceptionSpans.txt

… API version

…plunk-otel-android into addTrackExceptionAPIs

common/utils/proguard-rules.pro

common/utils/src/main/java/com/splunk/sdk/utils/ErrorIdentifierExtractor.kt

...va/com/splunk/rum/integration/agent/api/attributes/ErrorIdentifierAttributesSpanProcessor.kt

TomasChladekSL · 2025-02-13T11:26:22Z

...va/com/splunk/rum/integration/agent/api/attributes/ErrorIdentifierAttributesSpanProcessor.kt

+import io.opentelemetry.sdk.trace.ReadableSpan
+import io.opentelemetry.sdk.trace.SpanProcessor
+
+internal class ErrorIdentifierAttributesSpanProcessor(private val application: Application) : SpanProcessor {


Class named ErrorIdentifierAttributesSpanProcessor adds applicationId, versionCode, customUUID. There is no any error. Please consider of using GlobalAttributeSpanProcessor.

The application ID, version code, and uuid (if the customer adds it) only need to be added to crash and error spans that have stacktraces. This is because these attributes are used to correlate an android stacktrace with the correct mapping file for deobfuscation in the backend.

They do not need to be added to any other spans, as they are only relevant to identifying errors. That is why this class is called Error Identifier Attributes Span Processor, its the span processor that adds the attributes that help identify error spans for the backend and is only added to error and crash spans

TomasChladekSL · 2025-02-13T11:29:16Z

common/utils/src/main/java/com/splunk/sdk/utils/ErrorIdentifierExtractor.kt

+import android.os.Build
+import android.util.Log
+
+class ErrorIdentifierExtractor(private val application: Application) {


Class named ErrorIdentifierExtractor provides applicationId, versionCode, customUUID. There is no any error.

Please see above comment:

These fields:

-application ID
-version code
-uuid (if the customer adds it)

only need to be added to crash and error spans that have stacktraces. This is because these attributes are used to correlate an android stacktrace with the correct mapping file for deobfuscation in the backend.

They do not need to be added to any other spans, as they are only relevant to identifying errors. That is why this class is called the error identifier extractor. Because it extracts the attributes used to identify an error stacktrace

common/utils/src/main/java/com/splunk/sdk/utils/ErrorIdentifierInfo.kt

TomasChladekSL · 2025-02-13T11:30:30Z

...ntation/runtime/customtracking/src/main/java/com/splunk/rum/customtracking/CustomTracking.kt

+     * @param throwable A [Throwable] associated with this event.
+     */
+    fun trackException(throwable: Throwable) {
+        trackException(throwable, Attributes.empty())


Wouldn't it be better to pass null?

It doesn't make a difference

According to the source code, using Attributes.empty() requires two additional comparisons to achieve the same result.

…irectly accessible, simplified the span processor class init, renamed proguard rules.pro

TomasChladekSL · 2025-02-13T11:44:03Z

common/otel/src/main/java/com/splunk/sdk/common/otel/internal/RumConstants.kt

    val WORKFLOW_NAME_KEY: AttributeKey<String> = AttributeKey.stringKey("workflow.name")
+    val COMPONENT_KEY: AttributeKey<String> = AttributeKey.stringKey("component")
+
+    val APPLICATION_ID_KEY: AttributeKey<String> = AttributeKey.stringKey("service.application_id")


I don't think it's a good idea to have attributes as global properties. It goes against the principle of an independent modular architecture.

Some of these are going to be used by multiple modules, so that's why it's helpful to keep them in a common module. I also came across another class we already have where we can park commonly used attributes (I Missed it in my PR as well where I added workflow.name) - AttributeConstants

TomasChladekSL · 2025-02-14T09:40:24Z

...ntation/runtime/customtracking/src/main/java/com/splunk/rum/customtracking/CustomTracking.kt

+     * @param throwable A [Throwable] associated with this event.
+     */
+    fun trackException(throwable: Throwable) {
+        trackException(throwable, Attributes.empty())


According to the source code, using Attributes.empty() requires two additional comparisons to achieve the same result.

surbhiia · 2025-02-14T23:14:56Z

common/utils/src/main/java/com/splunk/sdk/utils/ErrorIdentifierExtractor.kt

@@ -0,0 +1,65 @@
+package com.splunk.sdk.utils


nit: Should we add "common" word in the package name like the other common packages - com.splunk.sdk.common.utils ? If not, we might need to change the package name in pro guard-rules.pro

tonzhan2 and others added 8 commits February 11, 2025 12:10

add error extractor module and basic APIs

7783c48

moved error identifying attributes to separate span processor

7f525ec

add error span processor, and conditional version code check based on…

f716fde

… API version

remove extra depednency

bb6d321

Merge branch 'feature/next-gen' into addTrackExceptionAPIs

b4ec428

remove some extra dependencies

b19495c

Merge branch 'addTrackExceptionAPIs' of https://github.com/signalfx/s…

bf30fae

…plunk-otel-android into addTrackExceptionAPIs

added test buttons to sample app

0299619

tonzhan2 marked this pull request as ready for review February 12, 2025 22:56

tonzhan2 requested a review from a team as a code owner February 12, 2025 22:56

TomasChladekSL requested changes Feb 13, 2025

View reviewed changes

tonzhan2 added 2 commits February 13, 2025 11:39

addressed some comments, used logger etc

aab47e3

remove error identifier attributes class, made methods in extractor d…

f3fce1a

…irectly accessible, simplified the span processor class init, renamed proguard rules.pro

TomasChladekSL reviewed Feb 14, 2025

View reviewed changes

TomasChladekSL self-requested a review February 14, 2025 10:01

TomasChladekSL approved these changes Feb 14, 2025

View reviewed changes

surbhiia reviewed Feb 14, 2025

View reviewed changes

surbhiia approved these changes Feb 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Track Exception APIs, and Error Identifier Attributes Span Processor #1172

Add Track Exception APIs, and Error Identifier Attributes Span Processor #1172

tonzhan2 commented Feb 12, 2025 •

edited

Loading

TomasChladekSL Feb 13, 2025

tonzhan2 Feb 13, 2025

TomasChladekSL Feb 13, 2025

tonzhan2 Feb 13, 2025 •

edited

Loading

TomasChladekSL Feb 13, 2025

tonzhan2 Feb 13, 2025

TomasChladekSL Feb 14, 2025

TomasChladekSL Feb 13, 2025

surbhiia Feb 14, 2025

TomasChladekSL Feb 14, 2025

surbhiia Feb 14, 2025 •

edited

Loading

Add Track Exception APIs, and Error Identifier Attributes Span Processor #1172

Are you sure you want to change the base?

Add Track Exception APIs, and Error Identifier Attributes Span Processor #1172

Conversation

tonzhan2 commented Feb 12, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonzhan2 Feb 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

surbhiia Feb 14, 2025 • edited Loading

Choose a reason for hiding this comment

tonzhan2 commented Feb 12, 2025 •

edited

Loading

tonzhan2 Feb 13, 2025 •

edited

Loading

surbhiia Feb 14, 2025 •

edited

Loading