ADEumAgentConfiguration Class Reference

Inherits from NSObject
Declared in ADEumInstrumentation_interfaces.h

Overview

The configuration of the AppDynamics SDK

  appKey

The application key.

@property (nonatomic, copy) NSString *appKey

Discussion

Warning: This property is required.

Declared In

ADEumInstrumentation_interfaces.h

  collectorURL

The URL of the collector. It should be compliant with “1.4. Hierarchical URI and Relative Forms” of RFC2396.

@property (nonatomic, copy) NSString *collectorURL

Discussion

The SDK will send beacons to this collector.

Declared In

ADEumInstrumentation_interfaces.h

  screenshotURL

The URL of the screenshot service. It should be compliant with “1.4. Hierarchical URI and Relative Forms” of RFC2396.

@property (nonatomic, copy) NSString *screenshotURL

Discussion

The SDK will send screenshot tiles to this service.

Declared In

ADEumInstrumentation_interfaces.h

  reachabilityHostName

The hostname used to determine whether the device is connected to the internet.

@property (nonatomic, copy) NSString *reachabilityHostName

Discussion

In order to determine if a device is connected to the internet, the agent SDK checks if a network route to the specific host is available. If that host is not reachable, the device is marked as “offline”.

If the application has restrictions on the IP addresses it is allowed to freely access, then this property should be used with a host the application can reach that is expected to be available to ensure the connection type is accurate.

The default hostname is www.google.com.

Declared In

ADEumInstrumentation_interfaces.h

  enableLogging

Boolean value that indicates whether logging is enabled. (Deprecated: Please use loggingLevel instead.)

@property (nonatomic) BOOL enableLogging

Discussion

Default logging level is ADEumLoggingLevelError, setting this changes loggingLevel to:

  • NO/false: ADEumLoggingLevelError (the default)
  • YES/true: ADEumLoggingLevelAll

Warning: Not recommended for production.

Warning: Backward Compatibility: Setting this will overwrite the setting in loggingLevel.

For this reason it is recommended to use loggingLevel directly.

Declared In

ADEumInstrumentation_interfaces.h

  loggingLevel

The logging level for the agent.

@property (nonatomic) ADEumLoggingLevel loggingLevel

Discussion

Default logging level is ADEumLoggingLevelError.

Warning: See enableLogging for information on how the two interact.

Warning: Setting this beyond ADEumLoggingLevelError is not recommended for production.

Declared In

ADEumInstrumentation_interfaces.h

  collectorChannel

The custom collector channel, if used.

@property (nonatomic, strong) id<ADEumCollectorChannel> ADEUM_NULLABLE collectorChannel

Discussion

This is only needed when customizing the communication channel between the SDK and the collector. Most users will not need this.

Declared In

ADEumInstrumentation_interfaces.h

  applicationName

The name of this mobile application, if used.

@property (nonatomic, strong) NSString *applicationName

Discussion

If set, all data reported from this application is associated with the given application name, and appears together in dashboards. If not set, the mobile application name is determined automatically based on the identifier of the main application bundle. Most users will not need this.

Warning: applicationName must not be an empty string, and must contain only alphanumeric characters and periods in reverse-DNS format.

Declared In

ADEumInstrumentation_interfaces.h

  excludedUrlPatterns

The url regex patterns for excluding url request tracking, if used

@property (nonatomic, strong) NSSet *excludedUrlPatterns

Discussion

If set, any url matching one of defined patterns won’t be tracked.

Declared In

ADEumInstrumentation_interfaces.h

  crashReportCallback

The agent supports the use of a “callback” to send notifications of crashes being reported. You can use this callback to get these reports.

@property (nonatomic, weak) id<ADEumCrashReportCallback> ADEUM_NULLABLE crashReportCallback

Declared In

ADEumInstrumentation_interfaces.h

  interactionCaptureMode

Bitmask value that indicates what types of user interaction events should be captured. The default value is ADEumInteractionCaptureModeNone which means no interactions are captured.

@property (nonatomic) ADEumInteractionCaptureMode interactionCaptureMode

Discussion

Warning: Using ADEumInteractionCaptureModeAll means that all currently known and to-be implemented interactions are captured. This could conceivably include personal user information. If you have any concerns around this, we recommend turning on only the interactions you want captured by using the individual specific constants.

Declared In

ADEumInstrumentation_interfaces.h

  enableAutoInstrument

Boolean value that indicates if automatic instrumentation is enabled. The default is YES.

@property (nonatomic) BOOL enableAutoInstrument

Declared In

ADEumInstrumentation_interfaces.h

  screenshotsEnabled

Boolean value that enables or disables the screenshots.

@property (nonatomic) BOOL screenshotsEnabled

Discussion

Default is enabled

This must be YES in order for any of the other screenshot methods to be used, either in the app or via the controller.

Recommended for most applications to leave this option enabled, and control the screenshots from the controller configuration page.

Declared In

ADEumInstrumentation_interfaces.h

  jsAgentEnabled

Boolean value that enables or disables JS Agent instrumentation of WKWebViews.

@property (nonatomic) BOOL jsAgentEnabled

Discussion

Default is enabled

Recommended for most applications to leave this option enabled.

Declared In

ADEumInstrumentation_interfaces.h

  jsAgentAjaxEnabled

Boolean value that enables or disables JS Agent collection of WKWebView Ajax activity

@property (nonatomic) BOOL jsAgentAjaxEnabled

Discussion

Default is disabled

Declared In

ADEumInstrumentation_interfaces.h

  jsAgentFetchEnabled

Boolean value that enables or disables JS Agent Fetch flag

@property (nonatomic) BOOL jsAgentFetchEnabled

Discussion

Default is enabled

Declared In

ADEumInstrumentation_interfaces.h

  jsAgentZonePromiseEnabled

Boolean value that enables or disables JS Agent ZonePromise flag

@property (nonatomic) BOOL jsAgentZonePromiseEnabled

Discussion

Default is enabled

Declared In

ADEumInstrumentation_interfaces.h

  anrDetectionEnabled

Boolean value that enables or disables the ANR Detection system.

@property (nonatomic) BOOL anrDetectionEnabled

Discussion

Default is disabled

Recommended for most applications to leave this option disabled. Enable it in applications that use the the standard iOS user interface components.

Declared In

ADEumInstrumentation_interfaces.h

  anrStackTraceEnabled

Boolean value that enables or disables the sending of stack traces during an ANR event.

@property (nonatomic) BOOL anrStackTraceEnabled

Discussion

Default is disabled

Recommended for most applications to leave this option disabled.

Declared In

ADEumInstrumentation_interfaces.h

  crashReportingEnabled

Boolean value that enables, or disables, the Crash Reporter feature

@property (nonatomic) BOOL crashReportingEnabled

Discussion

Default is enabled

Most applications should leave this feature enabled. Disable it if you are using a different crash reporting tool and conflicts are occuring.

Declared In

ADEumInstrumentation_interfaces.h

  flushInterval

Integer value specifying the interval between periodic beacon flushes to the network.

@property (nonatomic) int flushInterval

Discussion

Default is 60 seconds

Most applications should not change this value. The value should be no less than 1 second. Depending on what other code paths are executed which may also initiate flushes other than the periodic beacon flush this value governs, values higher than the default may result in a corresponding delay in beacons reaching the collector.

Declared In

ADEumInstrumentation_interfaces.h

  networkRequestCallback

The agent supports the use of a “callback” to modify or redact URL components prior to send the beacon to the collector.

@property (nonatomic, weak) id<ADEumNetworkRequestCallback> ADEUM_NULLABLE networkRequestCallback

Declared In

ADEumInstrumentation_interfaces.h

– initWithAppKey:

Returns a configuration with the specified app key and defaults for the other properties.

- (id)initWithAppKey:(NSString *)appKey

Parameters

appKey

The application key to use.

Declared In

ADEumInstrumentation_interfaces.h

– initWithAppKey:collectorURL:

Returns a configuration with the specified app key and collector URL, and defaults for the other properties.

- (id)initWithAppKey:(NSString *)appKey collectorURL:(NSString *ADEUM_NULLABLE)collectorURL

Parameters

appKey

The application key to use.

collectorURL

The URL of the collector.

Discussion

Warning: This method is for use in on premise installations only.

Declared In

ADEumInstrumentation_interfaces.h