Package com.dynatrace.tools.android.dsl

Class UserActionOptions

java.lang.Object
com.dynatrace.tools.android.dsl.UserActionOptions
All Implemented Interfaces:
com.dynatrace.tools.android.api.UserActionOptions, Serializable
public class UserActionOptions extends Object implements Serializable, com.dynatrace.tools.android.api.UserActionOptions
DSL object for configuring the user action monitoring feature.

The configuration options for user actions only affect user actions that are generated by auto-instrumentation. Manually generated user actions are not affected by these options.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    UserActionOptions(org.gradle.internal.reflect.Instantiator instantiator)
    Creates new UserActionOptions.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    composeEnabled(boolean composeEnabled)
    Specifies if the Jetpack Compose monitoring feature is enabled.
    void
    emptyActions(boolean emptyActions)
    Specifies if empty user actions should be monitored.
    void
    enabled(boolean enabled)
    Specifies if the user monitoring feature is enabled
    boolean
    equals(Object other)
    int
    getMaxDuration()
    Specifies the maximum value for the user action duration.
    UserActionSensors
    getSensors()
    Specifies sensor options
    int
    getTimeout()
    Specifies how long the agent will add lifecycle and web request events to an user action.
    int
    hashCode()
    boolean
    isComposeEnabled()
    Specifies if the Jetpack Compose monitoring feature is enabled.
    boolean
    isEmptyActions()
    Specifies if empty user actions should be monitored.
    boolean
    isEnabled()
    Specifies if the user monitoring feature is enabled
    boolean
    isNamePrivacy()
    Specifies if the view class name should be used instead of the view label to avoid monitoring sensitive data
    void
    maxDuration(int maxDuration)
    Specifies the maximum value for the user action duration.
    void
    namePrivacy(boolean namePrivacy)
    Specifies if the view class name should be used instead of the view label to avoid monitoring sensitive data
    void
    sensors(Action<? super UserActionSensors> action)
    Specifies sensor options
    void
    timeout(int timeout)
    Specifies how long the agent will add lifecycle and web request events to an user action.
    String
    toString()

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • UserActionOptions

      public UserActionOptions(org.gradle.internal.reflect.Instantiator instantiator)
      Creates new UserActionOptions.
      Parameters:
      instantiator - instantiator that can create instances from classes

  • Method Details

    • enabled

      public void enabled(boolean enabled)
      Specifies if the user monitoring feature is enabled

      The default value is true.

      Parameters:
      enabled - true, if the user monitoring feature is enabled

    • composeEnabled

      public void composeEnabled(boolean composeEnabled)
      Specifies if the Jetpack Compose monitoring feature is enabled.

      The default value is true.

      Parameters:
      composeEnabled - true, if the Jetpack Compose framework should be instrumented
      Since:
      8.263

    • timeout

      public void timeout(int timeout)
      Specifies how long the agent will add lifecycle and web request events to an user action.

      When the timeout value is reached, the agent will stop aggregating events to this actions and waits until all child actions and events are closed.

      The default value is 500 ms.

      Parameters:
      timeout - waiting timeout value in ms (must be between 100 ms - 5,000 ms)

    • maxDuration

      public void maxDuration(int maxDuration)
      Specifies the maximum value for the user action duration.

      When the duration of an user action exceeds this value, the agent will close the user action. It will also close unfinished child actions and decouple unfinished web requests from the user action.

      The default value is 60,000 ms (= one minute).

      Parameters:
      maxDuration - max duration value in ms (must be between 100 ms - 540,000 ms)

    • emptyActions

      public void emptyActions(boolean emptyActions)
      Specifies if empty user actions should be monitored.

      The default value is true.

      Parameters:
      emptyActions - true, empty user actions should be monitored

    • namePrivacy

      public void namePrivacy(boolean namePrivacy)
      Specifies if the view class name should be used instead of the view label to avoid monitoring sensitive data

      The default value is false.

      Parameters:
      namePrivacy - true, if the view class name should be used as user action name
      Since:
      8.249

    • sensors

      public void sensors(Action<? super UserActionSensors> action)
      Specifies sensor options

      For more information about the properties you can configure in this block, see UserActionSensors.

      Parameters:
      action - action object to specific the UserActionSensors

    • isEnabled

      public boolean isEnabled()
      Specifies if the user monitoring feature is enabled

      The default value is true.

      Specified by:
      isEnabled in interface com.dynatrace.tools.android.api.UserActionOptions
      Returns:
      true, if the user monitoring feature is enabled

    • isComposeEnabled

      public boolean isComposeEnabled()
      Specifies if the Jetpack Compose monitoring feature is enabled.

      The default value is true.

      Specified by:
      isComposeEnabled in interface com.dynatrace.tools.android.api.UserActionOptions
      Returns:
      true, if the Jetpack Compose monitoring feature is enabled
      Since:
      8.263

    • getTimeout

      public int getTimeout()
      Specifies how long the agent will add lifecycle and web request events to an user action.

      When the timeout value is reached, the agent will stop aggregating events to this actions and waits until all child actions and events are closed.

      The default value is 500 ms.

      Specified by:
      getTimeout in interface com.dynatrace.tools.android.api.UserActionOptions
      Returns:
      the waiting timeout value for user actions

    • getMaxDuration

      public int getMaxDuration()
      Specifies the maximum value for the user action duration.

      When the duration of an user action exceeds this value, the agent will close the user action. It will also close unfinished child actions and decouple unfinished web requests from the user action.

      The default value is 60,000 ms (= one minute).

      Specified by:
      getMaxDuration in interface com.dynatrace.tools.android.api.UserActionOptions
      Returns:
      the max duration value for user actions

    • isEmptyActions

      public boolean isEmptyActions()
      Specifies if empty user actions should be monitored.

      The default value is true.

      Specified by:
      isEmptyActions in interface com.dynatrace.tools.android.api.UserActionOptions
      Returns:
      true, if empty user actions should be monitored

    • isNamePrivacy

      public boolean isNamePrivacy()
      Specifies if the view class name should be used instead of the view label to avoid monitoring sensitive data

      The default value is false.

      Specified by:
      isNamePrivacy in interface com.dynatrace.tools.android.api.UserActionOptions
      Returns:
      true, if the view class name should be used as user action name
      Since:
      8.249

    • getSensors

      public UserActionSensors getSensors()
      Specifies sensor options

      For more information about the properties you can configure in this block, see UserActionSensors.

      Specified by:
      getSensors in interface com.dynatrace.tools.android.api.UserActionOptions
      Returns:
      sensor options

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object