iOS agent configuration and feature flags

New Relic's iOS agent provides configuration settings to change the default behavior of the agent. If used, implement these flags just before calling:

Objective-C: +[NewRelic startWithApplicationToken:]
Swift: NewRelic.start(withApplicationToken:)

Enable or disable feature flags

To configure feature flags, use the following method defined in NewRelic.h:

iOS language	Procedure
Objective-C	In Objective-C, these features are bitmasked, so you can use a `\|` to enable or disable multiple features at the same time. Enable a feature flag: `+[NewRelic enableFeatures:(NRMAFeatureFlags)flags];` Disable a feature flag: `+[NewRelic disableFeatures:(NRMAFeatureFlags)flags];` Here is an example where: Interaction tracing and experimental networking instrumentation are enabled. `NSURLSession` instrumentation and crash reporting are disabled. `[NewRelic enableFeatures:NRFeatureFlag_SwiftInteractionTracing \| NRFeatureFlag_ExperimentalNetworkingInstrumentation]; [NewRelic disableFeatures:NRFeatureFlag_NSURLSessionInstrumentation \| NRFeatureFlag_CrashReporting]; [NewRelic startWithApplicationToken:...];`
Swift	Enable a feature flag: `NewRelic.enableFeatures(NRMAFeatureFlags.[NRMAFeatureFlag])` Disable a feature flag: `NewRelic.disableFeatures(NRMAFeatureFlags.[NRMAFeatureFlag])` Example to disable default interaction tracing: `NewRelic.disableFeatures(NRMAFeatureFlags.NRFeatureFlag_DefaultInteractions)`

iOS language

Procedure

Objective-C

In Objective-C, these features are bitmasked, so you can use a | to enable or disable multiple features at the same time.

Enable a feature flag:

+[NewRelic enableFeatures:(NRMAFeatureFlags)flags];

Disable a feature flag:

+[NewRelic disableFeatures:(NRMAFeatureFlags)flags];

Here is an example where:

Interaction tracing and experimental networking instrumentation are enabled.
NSURLSession instrumentation and crash reporting are disabled.

[NewRelic enableFeatures:NRFeatureFlag_SwiftInteractionTracing | NRFeatureFlag_ExperimentalNetworkingInstrumentation];
[NewRelic disableFeatures:NRFeatureFlag_NSURLSessionInstrumentation | NRFeatureFlag_CrashReporting]; 
[NewRelic startWithApplicationToken:...];

Swift

Enable a feature flag:

NewRelic.enableFeatures(NRMAFeatureFlags.[NRMAFeatureFlag])

Disable a feature flag:

NewRelic.disableFeatures(NRMAFeatureFlags.[NRMAFeatureFlag])

Example to disable default interaction tracing:

NewRelic.disableFeatures(NRMAFeatureFlags.NRFeatureFlag_DefaultInteractions)

Crash and error reporting feature flag

If used, be sure to call the feature flag before the New Relic iOS agent start call.

Distributed tracing

Enable or disable the adding of distributed tracing headers to network requests.

Refer to How New Relic distributed tracing works for more information on distributed tracing in mobile apps.

Type	Boolean
Default	`true`

Interactions feature flags

If used, be sure to call the feature flag before the New Relic iOS agent start call.

Enable (default) or disable interaction tracing only for default instrumented classes and methods. Custom interactions will be reported. The traces will appear on the Interactions page.

Type	Boolean
Default	`true`

Globally enable (default) or disable interaction traces, which appear on the Interactions page.

Interaction tracing will be disabled after the agent has started. Interactions for any activity or methods executed prior to starting the agent may still appear on the Interactions page.

Type	Boolean
Default	`true`

Caution

Before enabling this feature, see Enable Swift interaction traces. If proper steps are not taken, enabling this feature may cause instability.

Enable or disable (default) interaction tracing for Swift code. The traces appear on the Interactions page. This feature will always be disabled if NRFeatureFlag_InteractionTracing is disabled.

Type	Boolean
Default	`false`

Networking feature flags

If used, be sure to call the feature flag before the New Relic iOS agent start call.

Caution

Enabling this feature flag call may decrease the stability of applications. Avoid using unless instructed by New Relic.

Enable or disable (default) experimental networking instrumentation. This forces all NSURLConnection network requests through the NRMAURProtocol.

Type	Boolean
Default	`false`

Enable or disable (default) networking instrumentation. This sends the HTTP response data as MobileRequest events.

Available for iOS agent version 5.14.0 and higher

Type	Boolean
Default	`true` - Enabled by default as of 6.0.0

Enable (default) or disable HTTP request error event generation of instrumented network calls that result in an error or failure. These events are reported as MobileRequestError events.

Available for iOS agent version 5.11.0 and higher

Type	Boolean
Default	`true`

App launch time settings

Enable or disable reporting app start time (cold and hot time) as a metric.

Cold time refers to time between starting app and the first draw.
Hot time refers to the time it takes for an app to resume from running in the background to the first draw.
Available for iOS agent version 7.4.0 or higher.
Type
Boolean
Default
true
Enabled by default as of agent version 7.4.0

iOS agent configuration and feature flags

Enable or disable feature flags

Crash and error reporting feature flag

NRFeatureFlag_CrashReporting

NRFeatureFlag_HandledExceptionEvents

Distributed tracing

NRFeatureFlag_DistributedTracing

Interactions feature flags

NRFeatureFlag_DefaultInteractions

NRFeatureFlag_InteractionTracing

NRFeatureFlag_SwiftInteractionTracing

Caution

NRFeatureFlag_WebViewInstrumentation

Networking feature flags

NRFeatureFlag_ExperimentalNetworkingInstrumentation

Caution

NRFeatureFlag_NSURLSessionInstrumentation

NRFeatureFlag_NetworkRequestEvents

NRFeatureFlag_RequestErrorEvents

NRFeatureFlag_HttpResponseBodyCapture

NRFeatureFlag_SwiftAsyncURLSessionSupport

App launch time settings

NRFeatureFlag_AppStartMetrics

FedRAMP endpoints settings

NRFeatureFlag_FedRampEnabled