New Relic Mobileエージェントセットアップ手順 (iOS/Swift編)

最終更新日 2023年 5月 22日所要時間：約 8分

本コンテンツは、投稿日時点での最新のiOS（Swift）アプリにおけるNew Relic Mobileエージェントのセットアップ手順を記載しています。最新の手順や詳細については、基本的にすべてドキュメントページに記載されているため、そちらをご参照ください。

アプリケーショントークン取得

まず最初に、アプリに組み込むためのトークンを以下の手順で取得してください。

New Relicにログインし、画面左の「+ Add Data」をクリック。
Add Dataの画面上部の検索ボックスにて、iosとタイプしていただくと、「iOS」のタイルが表示されるので、それをクリック
続いて表示された画面で、アカウントを選択していただき、Continueをクリック
「Give your application a name」の項目にアプリ名を入力し、CreateをクリックするとNew Relic上でアプリが作成されます。
引き続きUI上で表示されるガイドに従って導入していただくこともできますが、本ブログの手順に従う場合は、一旦Add Dataの画面を抜けます。
左側メニューで「Mobile」の項目がある場合は、それを選択してください。ない場合は、左側メニューの「All Capabilities」をクリックしていただき、表示されたタイルのリストから「Mobile」を選択してください。
すると先程作成したアプリケーションがリストに表示されています。
作成したアプリをクリックし、その中の「Application」をクリックし、表示された画面のトークンをコピーしてください

Agentの導入

本ページでは、Swift Package Managerを使った導入方法のみを記載します。CocoaPodsを利用してSwiftへ組み込む方法及び、SDKを直接組み込む方法に関しては、ドキュメントページをご参照ください。

Xcodeで対象のプロジェクトを開いてください。
続いて画面上部のメニューから File > Swift Packages > Add Package Dependency... を開いてください。
リポジトリの設定画面が表示されるので、以下のURLを設定してNextをクリックしてください。

https://github.com/newrelic/newrelic-ios-agent-spm

利用するバージョンのルールの選択画面が表示されるので、導入したいバージョンのルールを設定してください。

最後に設定する対象のTargetを選択し完了してください。

SwiftUIで作成したケースなど、AppDelegate.swiftがない場合は、ファイルを追加して以下のようなコードを追加してください。（すでにある場合は、スキップしてください）

import SwiftUI
import UIKit

class AppDelegate: NSObject, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
        return true
    }
}

<アプリ名>App.swiftという名前のファイルのファイルを開き、以下のTODOの行のようにAppDelegateを追加してください。

@main
struct HelloSwiftUIApp: App {
    //TODO Adding AppDelegate
    @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

プロジェクト内のAppDelegate.swiftというファイルを開き、以下のようにNew Relicのヘッダーをimportしてください。

import NewRelic

同じファイル内のapplication:didFinishLaunchingWithOptionsの最初の行に以下の1行を追加してください（APP_TOKENは、前述のアプリケーショントークンの取得で取得したトークンに置き換えてください。）

NewRelic.start(withApplicationToken:"APP_TOKEN")

これで、モバイルモニタリングが開始できるようになりました。試しにクラッシュが取得できることが確認できるよう、任意の箇所（例えば特定のボタンをクリックしたときに動作するコード）に、 NewRelic.crashNow()を追加し、アプリをビルドして実行、クラッシュを発生させ、アプリを再起動してみてください。数分以内に、one.newrelic.comのMobileの画面で、クラッシュを確認することができます。

なお、アプリがデバッガと接続した状態で起動した場合、クラッシュの取得ができません。その場合、端末のログに「New Relic Crash Reporting is DISABLED because it has detected the debugger is enabled.」という表示されます。デバッガを切断した状態でアプリを再起動するか、XcodeのEdit Scheme...からDebug executableのチェックを外して実行して、クラッシュを発生させてみてください。

ビルドスクリプトの設定

iOSのクラッシュデータは、そのままでは関数名が表示されずクラッシュが発生した箇所や原因の特定が困難になります。そのためシンボル情報をアップロードするためにビルドスクリプトの設定を行ってください。なお、bitcodeが有効な場合は本スクリプトではアップロードされません。こちらを参照し、dSYMを取得して手動でのアップロードを行ってください。

対象となるTargetのBuild Phasesを表示し、+ボタンよりNew Run Script Phaseを選択し、Run Scriptを追加してください

iOS Agent 7.4.0以降をインストールされる場合、Run Scriptの中のShellの中に以下のコードを追加してください。（APP_TOKENは、前述のアプリケーショントークンの取得で取得したトークンに置き換えてください。）

ARTIFACT_DIR="${BUILD_DIR%Build/*}SourcePackages/artifacts"

SCRIPT=`/usr/bin/find "${SRCROOT}" "${ARTIFACT_DIR}" -type f -name run-symbol-tool | head -n 1`
/bin/sh "${SCRIPT}" "APP_TOKEN"

以上で基本的な設定は完了です。その他細かい設定の変更などは、以下の参考情報やドキュメントページをご参照ください。

アプリ起動時間の取得設定

7.4.0以降のiOS Agentを導入していただくだけで、追加の計装を行う必要なく、「コールドタイム」、「ホットタイム」と呼ばれるアプリの起動時間を報告することができます。

参考情報

By 松川晋士, リードテクニカルサポートエンジニア

New Relic株式会社　リードテクニカルサポートエンジニア。大手電機メーカーでソフトウェアエンジニアとして、携帯電話の開発に従事。フィーチャーフォンに始まり、Android搭載のスマートフォンの開発に携わる。その後、創業して間もないベンチャー企業で新規のWebサービス及びモバイルSDKの開発から運用、サポートを経て現職。

本ブログに掲載されている見解は著者に所属するものであり、必ずしも New Relic 株式会社の公式見解であるわけではありません。また、本ブログには、外部サイトにアクセスするリンクが含まれる場合があります。それらリンク先の内容について、New Relic がいかなる保証も提供することはありません。

780+ インテグレーションを導入し、スタック監視を無料で開始しましょう

詳細を見る

この記事で