Configure monitoring capabilities of Dynatrace Android Gradle plugin

With the following configuration options, you can customize OneAgent monitoring capabilities and fine-tune the auto-instrumentation process for these features.

User action monitoring

OneAgent creates user actions based on the UI components that trigger these actions and automatically combines user action data with other monitoring data, such as information on web requests and crashes. OneAgent extends the lifetime of user actions to properly aggregate them with other events that are executed in a background thread or immediately after a user action.

Configure user action monitoring

You can configure user action monitoring using the following properties:

All properties related to user action monitoring are part of UserAction DSL, so configure them via the userActions block.

dynatrace {
    configurations {
        sampleConfig {
            userActions {
                // your user action monitoring configuration
            }
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            userActions {
                // your user action monitoring configuration
            }
        }
    }
}

timeout and maxDuration properties

With the timeout property, you can configure the time during which OneAgent can add other events to the newly created user action. When another user interaction is detected, OneAgent stops adding events to the user action of the previous interaction, regardless of the configured timeout value. Instead, OneAgent adds events only to the user action from the current user interaction.

When the timeout time period expires, OneAgent checks if there are open events and waits until these events are completed. With the maxDuration property, you can configure the maximum duration of these user actions. If an open event, for example, a web request, is still not finished after this period, OneAgent removes these events from the user action and closes the user action with an appropriate end time value.

Specify the value for both properties in milliseconds. The value of the maxDuration property must be equal to or greater than the value of the timeout property.

emptyActions property

OneAgent also reports user actions that don't contain child events. To discard such user actions, use the emptyActions property.

Disable user action monitoring

You can completely deactivate user action monitoring with the enabled property. In this case, all other properties are ignored, so only specify the enabled property to avoid confusion.

dynatrace {
    configurations {
        sampleConfig {
            userActions.enabled false
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            userActions.enabled(false)
        }
    }
}

User action monitoring sensors

The plugin automatically instruments the following classes and methods:

You can deactivate specific sensors via the UserAction Sensor DSL properties and configure it inside the sensors block.

dynatrace {
    configurations {
        sampleConfig {
            userActions {
                sensors {
                    // fine-tune the sensors if necessary
                    pageChange false
                    refresh false
                }
            }
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            userActions {
                sensors {
                    // fine-tune the sensors if necessary
                    pageChange(false)
                    refresh(false)
                }
            }
        }
    }
}

User action naming

To construct user action names, OneAgent captures the control title from different attributes depending on the listener or method used. See the table below for details.

Mask user actions

Dynatrace Android Gradle plugin version 8.249+

By default, user action names are derived from UI control titles, for example, button or menu item titles. In rare circumstances, email addresses, usernames, or other personal information might be unintentionally included in user action names. This happens when this information is included in parameters used for control titles, resulting in user action names such as Touch on Account 123456.

If such personal information appears in your application's user action names, enable user action masking. OneAgent will replace all Touch on <control title> action names with the class name of the control that the user touched, for example:

You can enable user action masking with the namePrivacy property of the UserAction DSL.

dynatrace {
    configurations {
        sampleConfig {
            userActions {
                namePrivacy true
            }
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            userActions {
                namePrivacy(true)
            }
        }
    }
}

Modify user actions

OneAgent for Android creates user actions based on interactions of your application's users. These actions are different from custom actions and are sometimes called autogenerated actions. We also refer to them as user actions.

You can modify or even cancel user actions.

Modify a specific user action

With Dynatrace.modifyUserAction, you can modify the current user action. You can change the user action name and report events, values, and errors. You can also cancel a user action.

The Dynatrace.modifyUserAction method accepts an implementation of UserActionModifier as a parameter, which provides you with the current mutable ModifiableUserAction object.

Allowed operations on this user action object are as follows:

You can modify a user action only while it is still open. If the user action times out before it is modified, the modification has no effect. We recommend that you invoke Dynatrace.modifyUserAction inside the instrumented listener method and don't call this method from a different thread.

In the following example, we're using a calculator app to show you how to change the name of the user action that is created for the button click and how to report a value to the action.

button.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View v) {
        int result = calc();
        // we use Java 8 language features here. You can also use anonymous classes instead of lambdas
        Dynatrace.modifyUserAction(userAction -> {
            userAction.setActionName("Click on Calculate");
            userAction.reportValue("Calculated result", result);
        });
        showResult(result);
    }
});

button.setOnClickListener {
    val result = calc()
    Dynatrace.modifyUserAction { userAction ->
        userAction.actionName = "Click on Calculate"
        userAction.reportValue("Calculated result", result)
    }
    showResult(result)
}

Modify any user action

OneAgent for Android version 8.241+

You can modify user actions via Dynatrace.modifyUserAction. However, you can do that only for a specific user action, and you usually should know whether this user action is still open or not.

To overcome these limitations, we introduced a feature that allows you to receive a callback for every newly created user action. With this approach, you are notified about every new autogenerated user action, so you get a chance to update the user action name as well as report events, values, and errors. You can also cancel a user action.

You can register a callback that is invoked for each user action. UserActionModifier is set once at OneAgent startup via the DynatraceConfigurationBuilder#withAutoUserActionModifier method. After that, it is invoked each time OneAgent creates a user action. It is not invoked for custom actions.

Allowed operations are as follows:

Dynatrace.startup(this, new DynatraceConfigurationBuilder("<YourApplicationID>", "<ProvidedBeaconUrl>")
    .withAutoUserActionModifier(modifiableAction -> {
        if (modifiableAction.getActionName().contains("account ID")) {
            // remove personal information from the user action name
            modifiableAction.setActionName("Touch on Account");
        }
    })
    .buildConfiguration());

Dynatrace.startup(this, DynatraceConfigurationBuilder("<YourApplicationID>", "<ProvidedBeaconUrl>")
    .withAutoUserActionModifier { modifiableAction: ModifiableUserAction ->
        if (modifiableAction.actionName.contains("account ID")) {
            // remove personal information from the user action name
            modifiableAction.actionName = "Touch on Account"
        }
    }
    .buildConfiguration())

Android data binding library

The Dynatrace Android Gradle plugin can instrument event logic and listeners that are defined via the data binding feature. If your app contains code similar to the official listener binding example, the plugin can detect the correct bytecode and instrument it.

<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">
    <data>
        <variable name="task" type="com.android.example.Task" />
        <variable name="presenter" type="com.android.example.Presenter" />
    </data>
    <LinearLayout android:layout_width="match_parent" android:layout_height="match_parent">
        <Button android:layout_width="wrap_content" android:layout_height="wrap_content"
        android:onClick="@{() -> presenter.onSaveClick(task)}" />
    </LinearLayout>
</layout>

Define an event handler via XML attribute

The following example from the Android documentation shows how you can define an event handler via XML attributes.

<?xml version="1.0" encoding="utf-8"?>
<Button xmlns:android="http://schemas.android.com/apk/res/android"
    android:id="@+id/button_send"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:text="@string/button_send"
    android:onClick="sendMessage" />

/** Called when the user touches the button */
public void sendMessage(View view) {
    // Do something in response to button click
}

/** Called when the user touches the button */
fun sendMessage(view: View) {
    // Do something in response to button click
}

The Dynatrace Android Gradle plugin cannot determine the relationship between the button in the layout XML file and the sendMessage method in the activity. However, when your app uses the Appcompat library and your activities are derived from androidx.appcompat.app.AppCompatActivity, the plugin auto-instruments the delegation logic of the Appcompat library. If you don't use the Appcompat library, you must manually instrument these event handler methods because the plugin is unable to determine the connection between the bytecode and the layout XML file.

User action monitoring for Jetpack Compose

Dynatrace Android Gradle plugin version 8.263+

Dynatrace supports the auto-instrumentation of Jetpack Compose UI components. OneAgent creates user actions based on the UI components that trigger these actions and automatically combines user action data with other monitoring data, such as information on web requests and crashes.

Jetpack Compose auto-instrumentation is enabled by default starting with Dynatrace Android Gradle plugin version 8.271.

Requirements

Supported UI components

We support auto-instrumentation of standard and custom components with default user interactions from the Jetpack Compose UI framework. The table below contains these components and user interactions as well as several UI components that are based on these instrumented user interactions.

Disable user action monitoring

You can disable user action monitoring for Jetpack Compose with the composeEnabled property of the UserAction DSL. Note that all other Jetpack Compose sensor properties are ignored when Jetpack Compose auto-instrumentation is disabled, so only specify the composeEnabled property to avoid confusion.

dynatrace {
    configurations {
        sampleConfig {
            userActions {
                composeEnabled false
            }
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            userActions {
                composeEnabled(false)
            }
        }
    }
}

User action monitoring sensors

The following sensors are supported for the Jetpack Compose auto-instrumentation. For more details, check the overview table with all sensors.

You can deactivate specific sensors via the UserAction Sensor DSL.

User action naming

To construct user action names for Jetpack Compose UI components, OneAgent captures semantics information and evaluates the information from the merged semantics tree of the instrumented component.

Four properties are evaluated to generate proper user action names. When several properties are present, the property with the highest priority is used for a user action name.

When several properties of the same type are available, then the value of the first property is used for the user action name. Empty property values are ignored.

Button(onClick = { ... }) {
    Text("Title")
    Text("Body")
}

var checked by rememberSaveable { mutableStateOf(false) }
val likeIcon =
    if (checked) Icons.Filled.ThumbUp
    else Icons.Outlined.ThumbUp

IconToggleButton(
    checked = checked,
    onCheckedChange = { checked = it },
    modifier = Modifier
        .clip(CircleShape)
        .background(
            if (checked) MaterialTheme.colors.primary
            else Color.Transparent
        )
        .semantics {
            contentDescription = "Finish your order"
        }
) {
    Icon(likeIcon, "Like", modifier = Modifier.semantics {
        contentDescription = "Finish"
    })
}

Set custom user action name

If you want to set a custom user action name for a Jetpack Compose UI component, use the SemanticsPropertyReceiver.dtActionName property.

// This import is required to use our custom semantics property
import com.dynatrace.android.api.compose.dtActionName

Box(
    modifier = Modifier
        .clickable { ... }
        .semantics {
            dtActionName = "Finish your order"
        }
) {
...
}

For the code snippet above, OneAgent will generate the Touch on Finish your order user action name.

If you want to mask personal information that appears in your application's user action names, enable user action masking.

Captured component metadata

When monitoring your mobile application, OneAgent for Android also captures additional metadata for the instrumented Jetpack Compose components. This metadata is stored as key-value pairs and is available in the Dynatrace web UI. It provides additional context for your instrumented components, for example, their location in code, initial and target states, user action types, and more.

Captured parameters and values by component

The following key-value pairs are reported depending on how the user interacted with the Jetpack Compose UI component.

View component metadata in Dynatrace

The metadata captured for Jetpack Compose UI components is available on the waterfall analysis pages of your app's user actions.

To view captured metadata for a Jetpack Compose component

Web request monitoring

The Dynatrace Android Gradle plugin can automatically instrument and tag your web requests. To track web requests, OneAgent adds the x-dynatrace HTTP header with a unique value to the web request. This is required to correlate the server-side monitoring data to the corresponding mobile web request.

Configure web request monitoring

All web request monitoring related properties are part of WebRequest DSL, so configure these properties via the webRequests block.

dynatrace {
    configurations {
        sampleConfig {
            webRequests {
                // your web request monitoring configuration
            }
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            webRequests {
                // your web request monitoring configuration
            }
        }
    }
}

If a web request is triggered shortly after a monitored user interaction, OneAgent adds the web request as a child event to the monitored user action. OneAgent automatically truncates the query from the captured URL and only reports the domain name and path of your web requests.

Disable web request monitoring

You can completely deactivate web request monitoring with the enabled property. In this case, all other properties are ignored, so only specify the enabled property to avoid confusion.

dynatrace {
    configurations {
        sampleConfig {
            webRequests.enabled false
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            webRequests.enabled(false)
        }
    }
}

Web request monitoring sensors

The following HTTP frameworks are supported:

You can deactivate specific sensors via the WebRequest Sensor DSL properties and configure it inside the sensors block.

dynatrace {
    configurations {
        sampleConfig {
            webRequests {
                sensors {
                    // fine-tune the sensors if necessary
                }
            }
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            webRequests {
                sensors {
                    // fine-tune the sensors if necessary
                }
            }
        }
    }
}

Lifecycle monitoring

To track lifecycle events, we use the official Android ActivityLifecycleCallbacks interface. For activities, Dynatrace reports the time of each entered lifecycle state until the activity is visible; if available, the timestamps of lifecycle callbacks are displayed in the user action waterfall analysis and are marked as a Lifecycle event.

Reported lifecycle events

With lifecycle monitoring, OneAgent collects data on the following lifecycle events.

The timespan used for measuring the lifecycle event duration depends on the lifecycle event type and the level of Android API. When Android API level 29+ is used, we can measure the duration of lifecycle events more accurately thanks to pre- and post-lifecycle callbacks.

Configure lifecycle monitoring

Lifecycle events are either part of existing user actions, or they create a new user action and attach the display or redisplay lifecycle action to it. All lifecycle monitoring related properties are part of Lifecycle DSL, so configure them via the lifecycle block.

dynatrace {
    configurations {
        sampleConfig {
            lifecycle {
                // your lifecycle monitoring configuration
            }
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            lifecycle {
                // your lifecycle monitoring configuration
            }
        }
    }
}

Disable lifecycle monitoring

You can deactivate lifecycle monitoring with the enabled property. In this case, all other properties are ignored, so specify only the enabled property.

dynatrace {
    configurations {
        sampleConfig {
            lifecycle.enabled false
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            lifecycle.enabled(false)
        }
    }
}

Lifecycle monitoring sensors

You can deactivate specific sensors via the Lifecycle Sensor DSL properties and configure it inside the sensors block.

dynatrace {
    configurations {
        sampleConfig {
            lifecycle {
                sensors {
                    // fine-tune the sensors if necessary
                }
            }
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            lifecycle {
                sensors {
                    // fine-tune the sensors if necessary
                }
            }
        }
    }
}

Crash reporting

OneAgent captures all uncaught exceptions. The crash report includes the occurrence time and the full stack trace of the exception.

In general, the crash details are sent immediately after the crash, so the user doesn’t have to relaunch the application. However, in some cases, the application should be reopened within 10 minutes so that the crash report is sent. Note that Dynatrace doesn't send crash reports that are older than 10 minutes (as such reports can no longer be correlated on the Dynatrace Cluster).

You can deactivate crash reporting with the crashReporting property.

dynatrace {
    configurations {
        sampleConfig {
            crashReporting false
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            crashReporting(false)
        }
    }
}

Rage tap detection

Dynatrace Android Gradle plugin version 8.231+

When your mobile app doesn't respond quickly, a text label looks like a button, or a toggle is hidden under another toggle, users might repeatedly tap the screen or the affected UI control in frustration. OneAgent detects such behavior as a rage tap.

You can deactivate rage tap detection using the detectRageTaps property of the BehavioralEvents DSL.

dynatrace {
    configurations {
        sampleConfig {
            behavioralEvents {
                detectRageTaps false
            }
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            behavioralEvents {
                detectRageTaps(false)
            }
        }
    }
}

Location monitoring

When enabled, OneAgent appends the captured end user positions to the monitoring data. To protect the privacy of the end user, OneAgent captures only three fractional digits of GPS coordinates.

You can activate the location monitoring feature with the locationMonitoring property.

dynatrace {
    configurations {
        sampleConfig {
            locationMonitoring true
        }
    }
}

configure<com.dynatrace.tools.android.dsl.DynatraceExtension> {
    configurations {
        create("sampleConfig") {
            locationMonitoring(true)
        }
    }
}

OneAgent only captures location data that is already processed in your application. OneAgent doesn't request additional location data from the Android SDK. If your app doesn't process location data, this feature isn't enabled. When location monitoring is disabled or no location information is available, Dynatrace uses IP addresses to determine the location of the user.

The plugin supports the following location listener: