OneAgent for iOS configuration keys
Configuration keys are essentially properties you can set to your preferences for auto-instrumentation. Add the keys to your app's Info.plist
file, as required to fine-tune auto-instrumentation.
The following tables include all configuration keys for iOS auto-instrumentation.
General
Key | Key type | Description | Default value |
---|---|---|---|
| string | Identifies your mobile app. Auto-instrumentation reports an error if the key isn't present. | |
| string | This key's value is used to identify your environment within Dynatrace. Auto-instrumentation reports an error if the key is not present. | |
| boolean | When set to |
|
| boolean | When set to |
|
| string | If this key is present with a valid value, OneAgent logging is automatically enabled with the set value. If a key isn't present or doesn't have a valid value, automatic logging is turned off and must be turned on manually via API call. Possible values: |
|
User actions
Key | Key type | Description | Default value |
---|---|---|---|
| boolean | Turns on the ability to automatically create user actions for user interactions with the app, such as button clicks. Set the value to |
|
| array | An array of items where each item contains the name of a UI control class (or sub-class) to exclude from automatic control instrumentation. Each item in the array is a case-sensitive string that must exactly match the name of the class to be excluded. | |
| array | Defines an array of items where each item contains a type of view or control to exclude from automatic creation of user actions. Each item in the array is a case-insensitive string. Possible values: | |
| boolean | When set to
As a result, all |
|
| boolean | Defines if rage tap detection is enabled or not. Use this feature as a measure of user frustration. Set the value to |
|
| boolean | Determines whether to send automatic user actions that don't contain any web requests or lifecycle actions. |
|
| number | Sets the amount of time to retain an automatic user action before deletion. The purpose is to detect all web requests that occur when an automatic user action is active. If an automatic user action has pending web requests that are taking longer to complete, OneAgent waits for this amount of time for the web requests to complete before leaving the user action. Possible values: from |
|
| number | Sets the value for how long a particular automatic user action is active. The purpose is to detect all web requests that occur when an automatic user action is active. If the automatic user action has completed web requests, OneAgent leaves the action at the end of this time. Possible values: from |
|
Available for OneAgent for iOS version 8.249+
Web requests
Key | Key type | Description | Default value |
---|---|---|---|
| boolean | Turns on automatic web request timing and tagging. To disable automatic web request timing and tagging, set the value to |
|
| array | An array of items where each item contains the URL filters to exclude web requests from monitoring. Each item in the array should be a URL string or regular expression matching the URL your want to filter. | |
| boolean | Required if NSURLProtocol subclassing is used and duplicate web requests may appear. |
|
Lifecycle monitoring
Key | Key type | Description | Default value |
---|---|---|---|
| boolean | Enables automatic lifecycle detection without the need to override your view controller classes with the OneAgent SDK for iOS lifecycle classes. To disable automatic lifecycle monitoring, set the value to |
|
| boolean | Enables automatic lifecycle instrumentation of UI classes from third-party frameworks that are bundled with the application. Set the value to |
|
| array | An array of items where each item contains the name of a class to exclude from automatic lifecycle instrumentation. Each item in the array is a case-sensitive string that must exactly match the name of the class to be excluded. |
Hybrid apps
Key | Key type | Description | Default value |
---|---|---|---|
| boolean | For hybrid apps, set the value to |
|
| array[string] | For hybrid apps that use the RUM JavaScript, cookies must be set for each instrumented domain or server that the app communicates with. You can specify domains, host, or IP addresses. Domains and sub-domains must start with a dot. | |
| array[string] | For hybrid apps that use the RUM JavaScript, cookies must be set for each instrumented domain or server that the app communicates with. You can specify domains, host, or IP addresses. Domains and sub-domains must start with a dot.
This configuration key is similar to | |
| boolean | Turns on automatic web request timing and tagging for requests passed to |
|
obsolete |
|
|
|
Obsolete starting with OneAgent for iOS version 8.257
Privacy and security
Key | Key type | Description | Default value |
---|---|---|---|
| boolean | When set to |
|
| boolean | Enables crash reporting. To disable crash reporting, set the value to |
|
| boolean | Captures the location only if the app uses |
|
| array[string] | Includes the | |
| string | Defines the path to a (self-signed) certificate in |
|
| boolean | Allows the use of self-signed certificates. When set to |
|
SwiftUI
Key | Key type | Description | Default value |
---|---|---|---|
| boolean | When set to |
|
| array[string] | Includes relative paths of files and directories that are excluded from the SwiftUI instrumentation. The paths are relative to the project root, which is the directory where the | |
| array[string] | Specifies SwiftUI controls that are globally excluded from the SwiftUI instrumentation. Possible values: all values under Supported controls | |
| boolean | When set to | |
| boolean | When set to | |
| boolean | When set to | |
| number | Sets the number of builds after which the SwiftUI instrumentor logs are deleted. Possible values: from | |
| number | Sets the number of days after which the SwiftUI instrumentor logs are deleted. Possible values: from |
Available for OneAgent for iOS version 8.249+
Available for OneAgent for iOS version 8.257+
Available for OneAgent for iOS version 8.263+