OneAgent for iOS configuration keys

DTXApplicationID

required

string

Identifies your mobile app. Auto-instrumentation reports an error if the key isn't present.

DTXBeaconURL

required

string

This key's value is used to identify your environment within Dynatrace. Auto-instrumentation reports an error if the key is not present.

DTXAutoStart

boolean

When set to false, OneAgent doesn't start automatically, so you should start it manually.

true

DTXStartupLoadBalancing

boolean

When set to true, enables agent-side load balancing on startup, which avoids unbalanced load on the server when multiple OneAgents simultaneously establish a connection to the ActiveGate.

false

DTXLogLevel

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: OFF, SEVERE, WARNING, INFO, ALL

OFF

DTXInstrumentAutoUserAction

boolean

Turns on the ability to automatically create user actions for user interactions with the app, such as button clicks. Set the value to false to disable automatic creation of user actions.

true

DTXExcludedControlClasses

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.

DTXExcludedControls

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: Button, DatePicker, Slider, Stepper, Switch, RefreshControl, ToolBar, SegmentedControl, TableView, TabBar, AlertView, AlertAction, PageView, NavigationController, CollectionView, ActionSheet, Gesture, PickerView

DTXUIActionNamePrivacy¹

boolean

When set to true, enables user action masking.

As a result, all Touch on <control title> user action names are changed to Touch on <generic control type>. For example, Touch on Account 123456 becomes Touch on Button.

false

DTXDetectRageTaps

boolean

Defines if rage tap detection is enabled or not. Use this feature as a measure of user frustration. Set the value to false to stop detecting rage taps.

true

DTXSendEmptyAutoAction

boolean

Determines whether to send automatic user actions that don't contain any web requests or lifecycle actions.

true

DTXAutoActionMaxDurationMilliseconds

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 100 ms (= 0.1 seconds) to 540000 ms (= 9 minutes)

60000 ms

DTXAutoActionTimeoutMilliseconds

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 100 ms (= 0.1 seconds) to 5000 ms (= 5 seconds)

500 ms

DTXInstrumentWebRequestTiming

boolean

Turns on automatic web request timing and tagging. To disable automatic web request timing and tagging, set the value to false.

true

DTXURLFilters

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.

DTXFilterURLProtocolDuplicates

boolean

Required if NSURLProtocol subclassing is used and duplicate web requests may appear.

false

DTXInstrumentLifecycleMonitoring

boolean

Enables automatic lifecycle detection for iOS ViewController classes. To disable automatic lifecycle monitoring, set the value to false.

true

DTXInstrumentFrameworks

boolean

Enables automatic lifecycle instrumentation of UI classes from third-party frameworks that are bundled with the application. Set the value to true to enable automatic third-party framework lifecycle instrumentation. This configuration requires OneAgent for iOS to scan all frameworks bundled with your application, which can result in a noticeable performance impact at the application start.

false

DTXExcludedLifecycleClasses

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.

DTXHybridApplication

boolean

For hybrid apps, set the value to true. This is necessary to share the same visit for user actions created by the RUM JavaScript.

false

DTXSetCookiesForDomain

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.

DTXSetSecureCookiesForDomain

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 DTXSetCookiesForDomain, but the Secure cookie attribute is added for cookies that are set by Dynatrace. This ensures that the browser sends these cookies only over secure connections.

DTXInstrumentWebViewTiming

boolean

Turns on automatic web request timing and tagging for requests passed to WKWebView. This doesn't work for requests issued from JavaScript inside WKWebView. Set the value to false to disable automatic web request timing and tagging.

true

DTXWebViewStandInDelegate¹

obsolete

boolean

Use different instrumentation mode for WKWebView delegates to prevent circular instrumentation on delegate switching involving a subclass.

false

DTXUserOptIn

boolean

When set to true, activates user opt-in mode.

When user opt-in mode is enabled, you need to ask each user for permission to capture their data; then, you store their data privacy preferences. For details, see Configure data privacy.

false

DTXCrashReportingEnabled

boolean

Enables crash reporting. To disable crash reporting, set the value to false.

true

DTXInstrumentGPSLocation

boolean

When set to true, enables location monitoring. The location is captured when the app uses CLLocationManager and sends the captured location as a metric to the server. The OneAgent SDK for iOS doesn't perform GPS location capture on its own; to protect the privacy of the end user, it only captures a precision of three fractional digits.

false

DTXPublicKeyPins

array[string]

Includes the getPKHashFromCertificate.py script outputs used to enable the Public Key Hash Pinning feature for your mobile app.

DTXAgentCertificatePath

string

Defines the path to a (self-signed) certificate in DER format, which is used as an additional anchor to validate HTTPS communication. This key is needed if DTXAllowAnyCert is false and a self-signed certificate is used on the server.

null

DTXAllowAnyCert

boolean

Allows the use of self-signed certificates. When set to true, OneAgent for iOS accepts self-signed certificates (certificates that are not signed by a root-CA). This configuration key doesn't impact mobile app connections. It's only used for OneAgent communication, but doesn't overrule the host-name validation.

false

DTXWriteLogsToFile

boolean

When set to true, enables OneAgent to write logs to the device's local storage. This flag is required to be set to true for using the shareLogsFile API, which allows sharing of logs via an iOS sharing sheet (UIActivityViewController). This feature is not available on tvOS.

false

DTXSwiftUIEnableSessionReplayInstrumentation¹

boolean

When set to true, enables Session Replay for your SwiftUI apps.

false

DTXExcludedSwiftUIFiles¹

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 .xcodeproj file is located.

DTXSwiftUIExcludedControls³

array[string]

Specifies SwiftUI controls that are globally excluded from the SwiftUI instrumentation.

Possible values: all values under Supported controls

DTXSwiftUIInstrumentSimulatorBuilds¹

boolean

When set to true, enables the SwiftUI instrumentation for simulator builds.

DTXSwiftUIIgnoreDeploymentTarget¹

boolean

When set to true, allows you to generate builds for deployment targets of iOS 13 and earlier.

DTXSwiftUIManualPlaceholder¹

boolean

When set to true, enables line number mapping for legacy Objective-C projects. Note that additional configuration is required.

DTXCleanSwiftUILogsByCount²

number

Sets the number of builds after which the SwiftUI instrumentor logs are deleted.

Possible values: from 1 to 1000

DTXCleanSwiftUILogsByAgeDays²

number

Sets the number of days after which the SwiftUI instrumentor logs are deleted.

Possible values: from 1 to 500