コンテンツにスキップ

クイックスタート

本文では、macOS RUM SDK の最短の導入手順を示し、最小限のステップで検証可能なデータ送信を一度完了できるようにします。

アプリケーションは Agent による自動導入 と 手動導入 をサポートしています。以下の手順では、手動導入の最小構成について説明します。

事前準備

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

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

導入ステップ

  1. プロジェクトに FTMacOSSDK をインストールします
  2. アプリケーションの起動前に FTSDKConfig を初期化します
  3. FTRumConfig を初期化し、View、Action、Resource、クラッシュ、フリーズの収集を有効にします
  4. デバッグログを有効にしたままアプリケーションを実行し、ウィンドウの切り替えまたはネットワークリクエストを1回発生させます
  5. コンソールと Guance プラットフォームでデータが正常に送信されたことを確認します

SDK のインストール

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

クイック検証のみを行う場合は、CocoaPods または Swift Package Manager の使用を推奨します。

最小構成の初期化例

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

// main.m ファイル
#import "FTMacOSSDK.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.enableTrackAppCrash = YES;
        rumConfig.enableTrackAppANR = YES;
        rumConfig.enableTrackAppFreeze = YES;
        rumConfig.enableTraceUserAction = YES;
        rumConfig.enableTraceUserView = YES;
        rumConfig.enableTraceUserResource = YES;
        rumConfig.errorMonitorType = FTErrorMonitorAll;
        rumConfig.deviceMetricsMonitorType = FTDeviceMetricsMonitorAll;
        [[FTSDKAgent sharedInstance] startRumWithConfigOptions:rumConfig];
    }
    return NSApplicationMain(argc, argv);
}
import Cocoa
import FTMacOSSDK

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.enableTraceUserAction = true
rumConfig.enableTrackAppANR = true
rumConfig.enableTraceUserView = true
rumConfig.enableTraceUserResource = true
rumConfig.enableTrackAppCrash = true
rumConfig.enableTrackAppFreeze = true
rumConfig.errorMonitorType = .all
rumConfig.deviceMetricsMonitorType = .all
rumConfig.monitorFrequency = .rare
FTSDKAgent.sharedInstance().startRum(withConfigOptions: rumConfig)

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

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

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

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

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

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

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

導入の成功を確認する

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

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

次のステップ

フィードバック

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