• /
  • Log in
  • Free account

iOS manual installation

To install and configure New Relic functionality with your iOS applications, follow these procedures. If your iOS app uses Cocoapods, follow the Cocoapods installation procedures.

Tip

To use mobile monitoring and the rest of our observability platform, join the New Relic family! Sign up to create your free account in only a few seconds. Then ingest up to 100GB of data for free each month. Forever.

Install your iOS application

As part of the installation process, New Relic automatically generates an application token. This is a 40-character hexadecimal string for authenticating each mobile app you monitor in New Relic.

To install and configure your iOS application:

  1. Go to one.newrelic.com.
  2. If applicable: From the Mobile Apps index, select Add a new app.
  3. From the Get started page, select XCFramework as the platform for mobile monitoring.
  4. Type a name for your mobile app, and select Continue.

Continue with the steps to configure New Relic.

Add the New Relic framework to your app

  1. Download and unzip the iOS SDK for New Relic.

  2. To add the New Relic framework to your Xcode project: Use Finder to drag the NewRelicAgent.framework folder into your Xcode project, and drop it onto your project in the Project navigator window, under Frameworks, Libraries, and Embedded Content. Make sure Embed & Sign is selected under the Embed dropdown menu.

  3. Implement the agent using the appropriate method:

    Important

    To ensure proper instrumentation, you must call the agent on the first line of didFinishLaunchingWithOptions(), and run the agent on the main thread. Starting the call later, on a background thread, or asynchronously can cause unexpected or unstable behavior.

    Language

    Procedure

    Objective-C

    1. To start the agent: Import the New Relic header at the top of your prefix.pch.
    2. Add +[NewRelic startWithApplicationToken:@"<appToken>"] to the top of -application:didFinishLaunchingWithOptions: in your AppDelegate.m, using the unique application token that is automatically generated.

    Swift

    1. Create a bridging header file:

      1. Select File > New > File > Objective-C File.
      2. Name the file Placeholder.m, then select Next.
      3. Select Create, and confirm Xcode's prompt to generate the bridging header.
      4. Delete Placeholder.m.
    2. Import the New Relic agent by adding #import "NewRelic/NewRelic.h" to the top of MyApp-Bridging-Header.h.

    3. Add NewRelic.start(withApplicationToken: ">appToken>") to the top of application(_:didFinishLaunchingWithOptions:) in your AppDelegate.swift using the unique application token that is automatically generated.

  4. Add a build script to your target's Build Phases. Ensure the new build script is the very last build phase, then paste the following, replacing PUT_NEW_RELIC_APP_TOKEN_HERE with your application token:

    SCRIPT=`/usr/bin/find "${SRCROOT}" -name newrelic_postbuild.sh | head -n 1`
    /bin/sh "${SCRIPT}" "PUT_NEW_RELIC_APP_TOKEN_HERE"
  5. Clean and build your app, and then run it in the simulator or other device.

Optional: Execute a demo crash

If you have trouble getting your app to crash, the New Relic agent provides an API to execute a demo crash.

Recommendation: Add one of these lines of code to a button click event handler as applicable:

Language

Code

Objective-C

Crash:

[NewRelic crashNow];

Crash with log message:

[NewRelic crashNow:@"<reason>"];

Swift

Crash:

NewRelic.crashNow()

Crash with log message:

NewRelic.crashNow(_ message:)

Optional: Change the logging level

Six log levels are available for mobile apps monitoring:

  • none
  • error
  • warning
  • info
  • verbose
  • ALL

To increase your logging level in the app, add the following method:

Language

Code

Objective-C

Just before calling startWithApplicationToken in AppDelegate.m, add:

[NRLogger setLogLevels:NRLogLevelALL];

Swift

Just before calling start(withApplicationToken:) in AppDelegate.swift, add:

NRLogger.setLogLevels(NRLogLevelALL.rawValue)

For more help

If you need more help, check out these support and learning resources:

Create issueEdit page
Copyright © 2021 New Relic Inc.