UserActionOptions

API Documentation: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.

Properties

PropertyDescription
composeEnabled

Specifies if the Jetpack Compose monitoring feature is enabled.

emptyActions

Specifies if empty user actions should be monitored.

enabled

Specifies if the user monitoring feature is enabled

maxDuration

Specifies the maximum value for the user action duration.

namePrivacy

Specifies if the view class name should be used instead of the view label to avoid monitoring sensitive data

sensors

Specifies sensor options

timeout

Specifies how long the agent will add lifecycle and web request events to an user action.

Methods

No methods

Script blocks

BlockDescription
sensors

Specifies sensor options

Property details

boolean composeEnabled

Specifies if the Jetpack Compose monitoring feature is enabled.

The default value is true.

boolean emptyActions

Specifies if empty user actions should be monitored.

The default value is true.

boolean enabled

Specifies if the user monitoring feature is enabled

The default value is true.

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).

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.

Specifies sensor options

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

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.

Script block details

sensors { }

Specifies sensor options

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

Delegates to:
UserActionSensors from sensors