コンテンツにスキップ

クイックスタート

この記事では、iOS/tvOS/macOS RUM SDK の最短の導入パスを提供し、最小限の手順で検証可能なデータ送信を一度完了できるようにします。

アプリケーションは Agent 自動導入 と 手動導入 に対応しています。以下の手順では、手動導入の最小設定について説明します。

前提条件

SDK 1.6.8+ の最低デプロイバージョンは iOS 15、tvOS 15、macOS 12 です。既存プロジェクトをアップグレードする場合は、先に 1.6.8 アップグレード要件 を確認してください。

開始前に、以下の準備を完了してください:

  1. リアルユーザーモニタリング(RUM)で iOS、tvOS または macOS アプリケーションを作成し、RUM App ID を取得します
  2. データ送信先アドレスと認証方式を確認します:
  3. ローカル環境デプロイ:datakitUrl を準備します
  4. パブリック DataWay:datawayUrl と clientToken を準備します
  5. プロジェクトで SDK のインストールが完了していることを確認します。Swift Package Manager の使用を推奨し、CocoaPods、Carthage にも対応しています

導入手順

  1. プロジェクトに GuanceSDK をインストールします
  2. アプリ起動時に FTSDKConfig を初期化します
  3. FTRumConfig を初期化し、View、Action、Resource、クラッシュ、フリーズの収集を有効にします
  4. デバッグログを有効にし、アプリを実行して、ページの表示またはネットワークリクエストを一度発生させます
  5. コンソールと Guance プラットフォームで、データが正常に送信されたことを確認します

SDK のインストール

インストール方法については、アプリケーション導入 を直接参照してください。

迅速に検証したいだけの場合は、Swift Package Manager の使用を優先することを推奨します。既存の依存関係管理の制約がある場合にのみ、CocoaPods または Carthage を選択してください。

最小初期化例

iOS/tvOS では通常、AppDelegate で初期化します。macOS では、最初に表示される NSViewController の viewDidLoad メソッドと NSWindowController の windowDidLoad メソッドの呼び出しが AppDelegate の applicationDidFinishLaunching より早く行われるため、最初のビューのライフサイクル収集の異常を避けるには、main.m または main.swift で SDK を初期化することを推奨します。

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    // ローカル環境デプロイでは [[FTSDKConfig alloc] initWithDatakitUrl:datakitUrl] を使用
    FTSDKConfig *config = [[FTSDKConfig alloc] initWithDatawayUrl:datawayUrl clientToken:clientToken];
    config.enableSDKDebugLog = YES;
    [FTMobileAgent startWithConfigOptions:config];

    FTRumConfig *rumConfig = [[FTRumConfig alloc] initWithAppid:appid];
    rumConfig.enableTraceUserView = YES;
    rumConfig.enableTraceUserAction = YES;
    rumConfig.enableTraceUserResource = YES;
    rumConfig.enableTrackAppFreeze = YES;
    rumConfig.enableTrackAppCrash = YES;
    rumConfig.enableTrackAppANR = YES;
    [[FTMobileAgent sharedInstance] startRumWithConfigOptions:rumConfig];
    return YES;
}
// main.m ファイル
#import <Cocoa/Cocoa.h>
#import <GuanceSDK/GuanceSDK.h>
int main(int argc, const char * argv[]) {
    @autoreleasepool {
        // ローカル環境デプロイでは [[FTSDKConfig alloc] initWithDatakitUrl:datakitUrl] を使用
        FTSDKConfig *config = [[FTSDKConfig alloc] initWithDatawayUrl:datawayUrl clientToken:clientToken];
        config.enableSDKDebugLog = YES;
        [FTSDKAgent startWithConfigOptions:config];

        FTRumConfig *rumConfig = [[FTRumConfig alloc] initWithAppid:appid];
        rumConfig.enableTraceUserView = YES;
        rumConfig.enableTraceUserAction = YES;
        rumConfig.enableTraceUserResource = YES;
        rumConfig.enableTrackAppFreeze = YES;
        rumConfig.enableTrackAppCrash = YES;
        rumConfig.enableTrackAppANR = YES;
        rumConfig.errorMonitorType = FTErrorMonitorAll;
        rumConfig.deviceMetricsMonitorType = FTDeviceMetricsMonitorAll;
        [[FTSDKAgent sharedInstance] startRumWithConfigOptions:rumConfig];
    }
    return NSApplicationMain(argc, argv);
}
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    // ローカル環境デプロイでは FTSDKConfig(datakitUrl: datakitUrl) を使用
    let config = FTSDKConfig(datawayUrl: datawayUrl, clientToken: clientToken)
    config.enableSDKDebugLog = true
    FTMobileAgent.start(withConfigOptions: config)

    let rumConfig = FTRumConfig(appid: appid)
    rumConfig.enableTraceUserView = true
    rumConfig.enableTraceUserAction = true
    rumConfig.enableTraceUserResource = true
    rumConfig.enableTrackAppFreeze = true
    rumConfig.enableTrackAppCrash = true
    rumConfig.enableTrackAppANR = true
    FTMobileAgent.sharedInstance().startRum(withConfigOptions: rumConfig)
    return true
}
import Cocoa
import GuanceSDK
let delegate = AppDelegate()
NSApplication.shared.delegate = delegate

// ローカル環境デプロイでは FTSDKConfig(datakitUrl: datakitUrl) を使用
let config = FTSDKConfig(datawayUrl: datawayUrl, clientToken: clientToken)
config.enableSDKDebugLog = true
FTSDKAgent.start(withConfigOptions: config)

let rumConfig = FTRumConfig(appid: appid)
rumConfig.enableTraceUserView = true
rumConfig.enableTraceUserAction = true
rumConfig.enableTraceUserResource = true
rumConfig.enableTrackAppFreeze = true
rumConfig.enableTrackAppCrash = true
rumConfig.enableTrackAppANR = true
rumConfig.errorMonitorType = .all
rumConfig.deviceMetricsMonitorType = .all
FTSDKAgent.sharedInstance().startRum(withConfigOptions: rumConfig)

_ = NSApplicationMain(CommandLine.argc, CommandLine.unsafeArgv)

Swift を使用する場合は、先に main.swift ファイルを作成し、AppDelegate.swift の @main または @NSApplicationMain を削除してください。

上記の例は最小限の RUM 導入を満たしており、クラッシュとフリーズの検出はデフォルトで有効になっています。ローカル環境デプロイを使用する場合は、initWithDatawayUrl:clientToken: / FTSDKConfig(datawayUrl:clientToken:) を initWithDatakitUrl: / FTSDKConfig(datakitUrl:) に置き換えてください。FTMobileConfig は現在も互換性のために使用できますが、新しいコードでは FTSDKConfig の使用を推奨します。macOS は現在 Alpha バージョンであり、すべての iOS 機能がサポートされることを保証するものではありません。

オプション:Log と Trace の初期化

ログ収集や分散型トレーシングも必要な場合は、次の初期化を追加してください:

FTLoggerConfig *loggerConfig = [[FTLoggerConfig alloc] init];
loggerConfig.enableCustomLog = YES;
loggerConfig.enableLinkRumData = YES;
[[FTMobileAgent sharedInstance] startLoggerWithConfigOptions:loggerConfig];

FTTraceConfig *traceConfig = [[FTTraceConfig alloc] init];
traceConfig.enableAutoTrace = YES;
traceConfig.enableLinkRumData = YES;
[[FTMobileAgent sharedInstance] startTraceWithConfigOptions:traceConfig];
let loggerConfig = FTLoggerConfig()
loggerConfig.enableCustomLog = true
loggerConfig.enableLinkRumData = true
FTMobileAgent.sharedInstance().startLogger(withConfigOptions: loggerConfig)

let traceConfig = FTTraceConfig()
traceConfig.enableAutoTrace = true
traceConfig.enableLinkRumData = true
FTMobileAgent.sharedInstance().startTrace(withConfigOptions: traceConfig)

導入が成功したかどうかの確認

  1. enableSDKDebugLog = YES/true を有効にしたまま、アプリを実行します
  2. ページを開くか、URLSession のネットワークリクエストを一度発行します
  3. Xcode コンソールに SDK の初期化とデータ同期に関連するログが表示されることを確認します
  4. Guance コンソールに戻り、アプリケーションに対応する RUM データが表示されていることを確認します

さらに調査が必要な場合は、トラブルシューティング を参照してください。

次のステップ

フィードバック

このページは役に立ちましたか?