Instrument an iOS Application

Edit your app's AppDelegate.m file to initialize the Mobile Agent as soon as the app launches. This registers your application and only needs to be done once in your code.

1. In the AppDelegate.m file, add this import statement:

   #import <ADEumInstrumentation/ADEumInstrumentation.h>

   OBJ-C

2. In the method didFinishLaunchingWithOptions, create an ADEumAgentConfiguration object with the EUM App Key that you received when completing the Getting Started Wizard to initialize the iOS Agent:

   // Example EUM App Key: "AAA-AAB-AUM"
   ADEumAgentConfiguration *config = [[ADEumAgentConfiguration alloc] initWithAppKey:<#EUM_APP_KEY#>];

   OBJ-C

   Your code should look something like the following:

   #import <ADEumInstrumentation/ADEumInstrumentation.h>
   #import "AppDelegate.h"
    
       // ...
       -(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
       {
           // Example EUM App Key: "AAA-AAB-AUM"
           ADEumAgentConfiguration *config = [[ADEumAgentConfiguration alloc] initWithAppKey:<#EUM_APP_KEY#>]; 
           // other tasks
           return YES;
       }
   

   OBJ-C

3. Configure the iOS Agent to report metrics and screenshots to the SaaS EUM Server in your region and initialize the agent by passing the ADEumAgentConfiguration object to the method initWithConfiguration. If you are using an on-premises EUM Server, see Configure the iOS Agent for On-Prem Deployments (Optional).

   #import <ADEumInstrumentation/ADEumInstrumentation.h>
   #import "AppDelegate.h"
    
       // ...
       -(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
       {
           ADEumAgentConfiguration *config = [[ADEumAgentConfiguration alloc] initWithAppKey:<#EUM_APP_KEY#>];
           //The default SaaS EUM Server and Screenshot Service are in the Americas, 
   		// so you can omit the following settings if you are in the Americas.
           config.collectorURL = "https://<your_region>.eum-appdynamics.com";
           config.screenshotURL = "https://<you_region>-image.eum-appdynamics.com/";
           [ADEumInstrumentation initWithConfiguration: config];
           // other tasks
           return YES;
        }
   

   OBJ-C

4. (Optional) If your application is using another tool to report crashes, the iOS Agent may warn you with the following message:

   Agent has detected a third party crash reporting tool. You may wish to disable AppDynamics Crash Reporting by setting the crashReportingEnabled configuration flag to NO

   OBJ-C

   You are recommended to use only one crash reporting tool for better results. See Disable Crash Reporting for instructions on how to disable the iOS Agent's crash reporting.

5. Save the file.

The iOS Agent is compatible with applications created using the Swift programming language.  

1. In your application's AppDelegate class, add this import statement:

   import ADEumInstrumentation

   SWIFT

2. In the AppDelegate class didFinishLaunchingWithOptions, create an ADEumAgentConfiguration object with the EUM App Key that you received when completing the Getting Started Wizard to initialize the iOS Agent:

   #import <ADEumInstrumentation/ADEumInstrumentation.h>
   #import "AppDelegate.h"
    
       // ...
       func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
           let config = ADEumAgentConfiguration(appKey: <#EUM_APP_KEY#>)
       }

   SWIFT

3. Configure the iOS Agent to report metrics and screenshots to the SaaS EUM Server in your region, and initialize the agent by passing the initWith() method that takes the ADEumAgentConfiguration object as a parameter.

   

   If you are using an on-premises EUM Server, see Configure the iOS Agent for On-Prem Deployments (Optional).

   #import <ADEumInstrumentation/ADEumInstrumentation.h>
   #import "AppDelegate.h"
    
       // ...
        func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
           let config = ADEumAgentConfiguration(appKey: <#EUM_APP_KEY#>)
           config.collectorURL = "https://<your_region>.eum-appdynamics.com"
           config.screenshotURL = "https://<your_region>-image.eum-appdynamics.com"
           ADEumInstrumentation.initWith(config)
           // other tasks
           return true
       }
   // ...

   SWIFT

4. (Optional) If your application is using another tool to report crashes, the iOS Agent will warn you with the following message:

   Agent has detected a third party crash reporting tool. You may wish to disable AppDynamics Crash Reporting by setting the crashReportingEnabled configuration flag to NO

   SWIFT

   We recommend you use only one crash reporting tool for better results. See Disable Crash Reporting for instructions on how to disable the iOS Agent's crash reporting.

5. Save the file.

Apps written for watchOS 1 contain a WatchKit extension that runs on the user's iPhone, but watchOS 2 also supports a new architecture, where the WatchKit extension runs on the Apple Watch itself. AppDynamics supports the watchOS 1 architecture, but not the new watchOS 2 architecture. Note that apps using the watchOS 1 architecture can run on both watchOS 1 and 2, so if your application is designed for watchOS 1, you can use AppDynamics on both versions of watchOS.

Because watchOS 1 apps are functionally launched in response to an interaction with the Watch UI, the SDK initialization code should be called at the point of that interaction in the iPhone app, which is usually not at the extension's AppDelegate.m call. The syntax remains the same.