まだ RUM iOS SDK のセットアップを完了していない場合は、アプリ内セットアップ手順 に従うか、RUM iOS セットアップドキュメント を参照してください。

##ユーザーセッションの拡張

iOS RUM は、ユーザーの活動、画面、エラー、ネットワークリクエストなどの属性を自動的に追跡します。RUM イベントとデフォルト属性については、RUM データ収集ドキュメント を参照してください。ユーザーセッション情報をさらに拡張し、カスタムイベントを追跡することで、収集される属性をより細かく制御できます。

###カスタムビュー

ビューを自動追跡する ほか、viewControllers などの特定のビューが表示され、操作可能になった際に追跡することもできます。ビューが表示されなくなったときに追跡を停止するには、RUMMonitor.shared() 内の以下のメソッドを使用します。

.startView(viewController:) .stopView(viewController:)

たとえば、以下のとおりです。

import DatadogRUM

// in your `UIViewController`:
let rum = RUMMonitor.shared()

override func viewDidAppear(_ animated: Bool) {
    super.viewDidAppear(animated)
    rum.startView(viewController: self)
}

override func viewDidDisappear(_ animated: Bool) {
  super.viewDidDisappear(animated)
  rum.stopView(viewController: self)
}

@import DatadogRUM;
// in your `UIViewController`:

DDRUMMonitor *rum = [DDRUMMonitor shared];

- (void)viewDidAppear:(BOOL)animated {
    [super viewDidAppear:animated];

    [rum startViewWithViewController:self name:nil attributes:nil];
}

- (void)viewDidDisappear:(BOOL)animated {
    [super viewDidDisappear:animated];

    [rum stopViewWithViewController:self attributes:nil];
}

詳細および利用可能なオプションについては、GitHub の RUMMonitorProtocol を参照してください。

###カスタムアクション

[アクションを自動追跡する] (#automaticallytrackuseractions) ほか、addAction(type:name:) API を使用して、特定のカスタムユーザーアクション (タップ、クリック、スクロール) も追跡することができます。

RUMMonitor.shared() 上での .tap などの瞬間的な RUM アクションを手動で登録するには、.addAction(type:name:) を使用します。.scroll のような継続的な RUM アクションには、.startAction(type:name:) または .stopAction(type:) を使用します。

たとえば、以下のとおりです。

import DatadogRUM

// in your `UIViewController`:

let rum = RUMMonitor.shared()

@IBAction func didTapDownloadResourceButton(_ sender: UIButton) {
    rum.addAction(
        type: .tap,
        name: sender.currentTitle ?? ""
    )
}

- (IBAction)didTapDownloadResourceButton:(UIButton *)sender {
    NSString *name = sender.currentTitle ? sender.currentTitle : @"";
    [[DDRUMMonitor shared] addActionWithType:DDRUMActionTypeTap name:name attributes:@{}];
}

注意: .startAction(type:name:) と .stopAction(type:) を使用する際には、アクションの type は同じでなければなりません。これは、RUM iOS SDK がアクションの開始とその完了を一致させるために必要です。

詳細および利用可能なオプションについては、GitHub の RUMMonitorProtocol を参照してください。

###カスタムリソース

リソースを自動的に追跡する ほか、ネットワークリクエストやサードパーティプロバイダー API などの特定のカスタムリソースを追跡することもできます。RUMMonitor.shared() で次のメソッドを使用して、RUM リソースを手動で収集します。

.startResource(resourceKey:request:) .stopResource(resourceKey:response:) .stopResourceWithError(resourceKey:error:) .stopResourceWithError(resourceKey:message:)

たとえば、以下のとおりです。

import DatadogRUM

// in your network client:

let rum = RUMMonitor.shared()

rum.startResource(
    resourceKey: "resource-key",
    request: request
)

rum.stopResource(
    resourceKey: "resource-key",
    response: response
)

// in your network client:

[[DDRUMMonitor shared] startResourceWithResourceKey:@"resource-key"
                                            request:request
                                         attributes:@{}];

[[DDRUMMonitor shared] stopResourceWithResourceKey:@"resource-key"
                                          response:response
                                        attributes:@{}];

注意: 両方の呼び出しにおいて resourceKey に使用される String は、呼び出しているリソースに対して一意である必要があります。これは、RUM iOS SDK がリソースの開始と完了を一致させるために必要です。

詳細および利用可能なオプションについては、GitHub の RUMMonitorProtocol を参照してください。

###カスタムエラー

特定のエラーを追跡するには、エラーが発生したときに RUMMonitor.shared() に通知するために、次のメソッドのいずれかを使用します。

.addError(message:) .addError(error:)

let rum = RUMMonitor.shared()
rum.addError(message: "error message.")

[[DDRUMMonitor shared] addErrorWithMessage:@"error message." stack:nil source:DDRUMErrorSourceCustom attributes:@{}];

詳細および利用可能なオプションについては、GitHub の RUMMonitorProtocol および エラー属性のドキュメント を参照してください。

##カスタムグローバル属性の追跡

RUM iOS SDK が自動的に取得する デフォルトの RUM 属性 に加えて、RUM イベントにカスタム属性などのコンテキスト情報を追加して、Datadog 内の観測可能性を高めることができます。

カスタム属性を使用すると、観察されたユーザーの行動に関する情報 (カート値、マーチャント層、広告キャンペーンなど) をコードレベルの情報 (バックエンドサービス、セッションタイムライン、エラーログ、ネットワークヘルスなど) でフィルタリングおよびグループ化することができます。

###カスタムグローバル属性の設定

カスタムグローバル属性を設定するには、RUMMonitor.shared().addAttribute(forKey:value:) を使用します。

• 属性を追加するには、RUMMonitor.shared().addAttribute(forKey: "<KEY>", value: "<VALUE>") を使用します。
• 値を更新するには、RUMMonitor.shared().addAttribute(forKey: "<KEY>", value: "<UPDATED_VALUE>") を使用します。 *キーを削除するには、RUMMonitor.shared().removeAttribute(forKey: "<KEY_TO_REMOVE>") を使用します。

一括操作 (複数の属性を一度に変更する) でのパフォーマンスを向上させるには、.addAttributes(_:) と .removeAttributes(forKeys:) を使用してください。

注意: キー名にスペースや特殊文字を使用すると、カスタム属性にファセットを作成することはできません。たとえば、forKey: "Store ID" の代わりに forKey: "store_id" を使用してください。

###ユーザーセッションの追跡

RUM セッションにユーザー情報を追加すると、次のことが簡単になります。

*特定のユーザーのジャーニーをたどる *エラーの影響を最も受けているユーザーを把握する *最も重要なユーザーのパフォーマンスを監視する

| 属性 | タイプ | 説明 | | | | | usr.id | 文字列 | (必須) 一意のユーザー識別子。 | usr.name | 文字列 | (オプション) RUM UI にデフォルトで表示されるユーザーフレンドリーな名前。 | usr.email | 文字列 | (オプション) ユーザー名が存在しない場合に RUM UI に表示されるユーザーのメール。|

ユーザーセッションを識別するには、Datadog.setUserInfo(id:name:email:) API を使用します。

たとえば、以下のとおりです。

import DatadogCore

Datadog.setUserInfo(id: "1234", name: "John Doe", email: "john@doe.com")

[DDDatadog setUserInfoWithId:@"1234" name:@"John Doe" email:@"john@doe.com" extraInfo:@{}];

##バックグラウンドイベントの追跡

アプリケーションがバックグラウンドにあるとき (たとえば、アクティブなビューがないとき)、クラッシュやネットワークリクエストなどのイベントを追跡することができます。

バックグラウンドイベントを追跡するには、Datadog の構成で、初期化時に以下のスニペットを追加します。

import DatadogRUM

RUM.enable(
  with: RUM.Configuration(
    ...
    trackBackgroundEvents: true
  )
)

##初期化パラメーター

ライブラリを初期化するために Datadog の構成を作成する際、Datadog.Configuration で以下のプロパティを使用できます。

backgroundTasksEnabled

このフラグは、UIApplication メソッド beginBackgroundTask(expirationHandler:) と endBackgroundTask: がバックグラウンドアップロードを実行するために使用されるかどうかを決定します。このフラグを有効にすると、アプリがバックグラウンドで動作する時間が 30 秒増加することがあります。タスクは、アップロードするものがない場合や、インターネット接続がない、またはバッテリー残量が少ないなど、アップロードを妨げる要因に直面した場合に通常停止します。デフォルトでは、このフラグは false に設定されています。

batchProcessingLevel

バッチ処理レベルは、1 回の読み取り/アップロードサイクル内で遅延なしに順次処理される最大バッチ数を定義します。デフォルト値は .medium です。

batchSize

Datadog にアップロードされるバッチデータの好ましいサイズを設定します。この値は、RUM iOS SDK によって実行されるリクエストのサイズと数に影響します (バッチサイズが小さいほどリクエスト数は増えますが、各リクエストのサイズは小さくなります)。利用可能な値には、.small、.medium、.large が含まれます。

bundle

現在の実行可能ファイルを含むバンドルオブジェクトです。

clientToken

RUM クライアントトークン (RUM、ログ、APM をサポート) または通常のクライアントトークン (ログと APM をサポート) のいずれかです。

encryption

DataEncryption プロトコルに準拠したオブジェクトを提供することによって、ディスク上のデータ永続性に使用するデータ暗号化を行います。

enabled

Datadog に送信される環境名です。staging や production など、異なる環境によってイベントをフィルタリングするために使用できます。

proxyConfiguration

トラッキングデータを Datadog のインテークにアップロードするためのカスタムプロキシを有効にするために使用できるプロキシ構成属性です。

serverDateProvider

カスタム NTP 同期インターフェイスです。デフォルトでは、Datadog SDK は NTP Pool Project が提供する専用 NTP プールと同期します。異なるプールを使用するか、何も操作を行わない ServerDateProvider の実装を設定すると、SDK インスタンスと Datadog サーバー間が同期されなくなる場合があります。これにより、RUM セッションや分散トレースにおいて、大幅な時間ずれが発生する可能性があります。

service

Datadog に送信されるデータに関連付けられたサービス名です。デフォルト値はアプリケーションバンドル識別子です。

site

データが送信される Datadog サーバーエンドポイントです。デフォルト値は .us1 です。

uploadFrequency

Datadog へのデータアップロードの好ましい頻度です。利用可能な値には、.frequent、.average、.rare が含まれます。

###RUM 構成

RUM を有効にする際は、RUM.Configuration で以下のプロパティを使用することができます。

actionEventMapper

アクションのデータスクラビングコールバックを設定します。これを使用して、アクションイベントを Datadog に送信する前に修正または削除することができます。詳細については、RUM イベントの修正または削除 を参照してください。

appHangThreshold

アプリがハングしたときに報告するための閾値を設定します。このオプションの最小許容値は 0.1 秒です。報告を無効にするには、この値を nil に設定します。詳細については、アプリハング報告の追加 を参照してください。

applicationID

RUM アプリケーション識別子です。

customEndpoint

RUM データを送信するためのカスタムサーバー URL です。

errorEventMapper

エラーのデータスクラビングコールバックです。これを使用して、エラーイベントを Datadog に送信する前に修正または削除することができます。詳細については、RUM イベントの修正または削除 を参照してください。

longTaskEventMapper

長いタスクのデータスクラビングコールバックです。これは、長いタスクイベントを Datadog に送信する前に修正または削除するために使用できます。詳細については、RUM イベントの修正または削除 を参照してください。

longTaskThreshold

RUM の長いタスク追跡の閾値 (秒単位) です。デフォルトでは、0.1 秒に設定されます。

networkSettledResourcePredicate

TimetoNetworkSettled (TNS) ビューのタイミング計算のために「初期」リソースを分類するために使用される述語です。

nextViewActionPredicate

InteractiontoNextView (INV) タイミング計算のために「最後」のアクションを分類するために使用される述語です。

onSessionStart

(オプション) RUM がセッションを開始するときに呼び出されるメソッドです。

resourceEventMapper

リソースのデータスクラビングコールバックです。リソースイベントを Datadog に送信する前の修正または削除に使用できます。詳細については、RUM イベントの修正または削除 を参照してください。

sessionSampleRate

RUM セッションのサンプリングレートです。sessionSampleRate の値は、0.0 と 100.0 の間でなければなりません。0.0 に設定されているとセッションが送信されません。100.0 に設定されているとすべてのセッションが Datadog に送信されます。デフォルト値は 100.0 です。

telemetrySampleRate

Datadog によって利用される SDK 内部のテレメトリのサンプリングレートです。このレートは、トレースシステムに報告されるリクエストの数を制御します。これは 0 と 100 の間の値でなければなりません。デフォルトでは、20 に設定されています。

trackAnonymousUser

有効にすると、SDK はアプリ起動間で保持される、一意かつ個人情報を含まない匿名ユーザー ID を生成します。この ID は各 RUM セッションに添付されるため、個人データを収集せずに同じユーザー/デバイスから発生するセッションをリンクできるようになります。デフォルトでは、true に設定されています。

trackBackgroundEvents

アクティブなビューがないときに RUM イベントが追跡されるかどうかを決定します。デフォルトでは、false に設定されています。

trackFrustrations ユーザーのフラストレーションの自動追跡が有効かどうかを決定します。デフォルトでは、true に設定されています。

trackMemoryWarnings

メモリ警告の自動追跡が有効かどうかを決定します。デフォルトでは、true に設定されています。

trackWatchdogTerminations

SDK が Watchdog によって実行されるアプリケーションの終了を追跡するかどうかを決定します。デフォルト設定は false です。

uiKitActionsPredicate ユーザーのインタラクション (タップ) を RUM アクションとして追跡することを有効にします。DefaultUIKitRUMActionsPredicate を設定することで predicate のデフォルト実装を使用するか、アプリにカスタマイズされた 独自のUIKitRUMActionsPredicate を実装することができます。

uiKitViewsPredicate UIViewControllers を RUM ビューとして追跡することを有効にします。DefaultUIKitRUMViewsPredicate を設定することで predicate のデフォルト実装を使用するか、アプリにカスタマイズされた独自のUIKitRUMViewsPredicateを実装することができます。

urlSessionTracking

URLSession タスク (ネットワークリクエスト) を RUM リソースとして追跡することを有効にします。firstPartyHostsTracing パラメーターは、firstparty リソースとして分類されるホスト (RUM が有効な場合)、およびトレーシング情報が注入されるホスト (トレーシング機能が有効な場合) を定義します。resourceAttributesProvider パラメーターは、RUM iOS SDK によって収集された各リソースに対して呼び出されるインターセプトされたリソースのカスタム属性を提供するクロージャを定義します。このクロージャはタスク情報と共に呼び出され、カスタムリソース属性を返すか、属性を添付しない場合は nil を返すことができます。

viewEventMapper

ビューのデータスクラビングコールバックです。ビューイベントを Datadog に送信する前に修正するために使用できます。詳細については、RUM イベントの修正または削除 を参照してください。

vitalsUpdateFrequency

モバイルバイタルを収集するための好ましい頻度です。利用可能な値には、.frequent (100ms ごと)、.average (500ms ごと)、.rare (1 秒ごと)、および .never (バイタルモニタリングを無効) が含まれます。

###ビューの自動追跡

UIKit と SwiftUI を使用してビューを自動的に追跡できます。

public protocol UIKitRUMViewsPredicate {
    func rumView(for viewController: UIViewController) -> RUMView?
}

@objc
public protocol DDUIKitRUMViewsPredicate: AnyObject {
    func rumView(for viewController: UIViewController) -> DDRUMView?
}

class YourCustomPredicate: UIKitRUMViewsPredicate {

    func rumView(for viewController: UIViewController) -> RUMView? {
        switch viewController {
        case is HomeViewController:     return .init(name: "Home")
        case is DetailsViewController:  return .init(name: "Details")
        default:                        return nil
        }
    }
}

@interface YourCustomPredicate : NSObject<DDUIKitRUMViewsPredicate>

@end

@implementation YourCustomPredicate

- (DDRUMView * _Nullable)rumViewFor:(UIViewController * _Nonnull)viewController {
    if ([viewController isKindOfClass:[HomeViewController class]]) {
        return [[DDRUMView alloc] initWithName:@"Home" attributes:@{}];
    }

    if ([viewController isKindOfClass:[DetailsViewController class]]) {
        return [[DDRUMView alloc] initWithName:@"Details" attributes:@{}];
    }

    return nil;
}

@end

class YourCustomPredicate: UIKitRUMViewsPredicate {

    func rumView(for viewController: UIViewController) -> RUMView? {
        guard let accessibilityLabel = viewController.accessibilityLabel else {
            return nil
        }

        return RUMView(name: accessibilityLabel)
    }
}

@interface YourCustomPredicate : NSObject<DDUIKitRUMViewsPredicate>

@end

@implementation YourCustomPredicate

- (DDRUMView * _Nullable)rumViewFor:(UIViewController * _Nonnull)viewController {
    if (viewController.accessibilityLabel) {
        return [[DDRUMView alloc] initWithName:viewController.accessibilityLabel attributes:@{}];
    }

    return nil;
}

@end

public protocol SwiftUIRUMViewsPredicate {
    func rumView(for extractedViewName: String) -> RUMView?
}

// Example: Custom predicate to ignore fallback names and rename views
class CustomSwiftUIPredicate: SwiftUIRUMViewsPredicate {
    func rumView(for extractedViewName: String) -> RUMView? {
        if extractedViewName == "AutoTracked_HostingController_Fallback" ||
           extractedViewName == "AutoTracked_NavigationStackController_Fallback" {
            return nil // Ignore fallback names
        }
        if extractedViewName == "MySpecialView" {
            return RUMView(name: "Special")
        }
        return RUMView(name: extractedViewName)
    }
}

@protocol DDSwiftUIRUMViewsPredicate <NSObject>
- (DDRUMView * _Nullable)rumViewFor:(NSString * _Nonnull)extractedViewName;
@end

@interface CustomSwiftUIPredicate : NSObject <DDSwiftUIRUMViewsPredicate>
@end

@implementation CustomSwiftUIPredicate
- (DDRUMView * _Nullable)rumViewFor:(NSString * _Nonnull)extractedViewName {
    if ([extractedViewName isEqualToString:@"AutoTracked_HostingController_Fallback"] ||
        [extractedViewName isEqualToString:@"AutoTracked_NavigationStackController_Fallback"]) {
        return nil; // Ignore fallback names
    }
    if ([extractedViewName isEqualToString:@"MySpecialView"]) {
        return [[DDRUMView alloc] initWithName:@"Special" attributes:@{}];
    }
    return [[DDRUMView alloc] initWithName:extractedViewName attributes:@{}];
}
@end

###ユーザーアクションの自動追跡

UIKit

UIKit を使用してユーザーのタップ操作を自動的に追跡するには、RUM を有効にする際に uiKitActionsPredicate オプションを設定してください。

SwiftUI

SwiftUI でユーザーのタップ操作を自動的に追跡するには、RUMを有効にする際に swiftUIActionsPredicate オプションを有効にしてください。

注: Datadogは、純粋な SwiftUI アプリでも UIKit アクショントラッキングを有効にすることを推奨しています。多くのインタラクティブコンポーネントは、内部的に UIKit で実装されています。 tvOS では、リモコンの押下インタラクションのみが追跡されます。これには UIKit の述語のみが必要です。純粋な SwiftUI アプリを持っていても、tvOS でリモコンの押下を追跡したい場合は、UIKit のインスツルメンテーションも有効にする必要があります。 実装は iOS 18 以上と iOS 17 以下で異なります。 iOS 18以上: ほとんどのインタラクションは、正しいコンポーネント名 (例: SwiftUI_Button、SwiftUI_NavigationLink) で確実に追跡されます。 iOS 17以下: SDK はインタラクティブコンポーネントと非インタラクティブコンポーネントを区別できません (たとえば、Button と Label)。そのため、アクションは SwiftUI_Unidentified_Element として報告されます。 自動追跡と手動追跡の両方を使用すると、イベントが重複して表示されることがあります。これは既知の制限です。これを避けるためには、自動または手動のいずれか 1 つのインスツルメンテーションタイプのみを使用してください。 デフォルトの述語 DefaultSwiftUIRUMActionsPredicate を使用するか、アクションをフィルタリングまたは名前変更するために独自のものを提供できます。iOS 18 以上の信頼できるトラッキングのみを希望する場合は、レガシー検出 (iOS 17 以下) を無効にすることもできます。

// Use the default predicate by disabling iOS 17 and below detection
let predicate = DefaultSwiftUIRUMActionsPredicate(isLegacyDetectionEnabled: false)

// Use your own predicate
class CustomSwiftUIActionsPredicate: SwiftUIRUMActionsPredicate {
    func rumAction(for componentName: String) -> RUMAction? {
        // Custom logic to filter or rename actions
        return RUMAction(name: componentName)
    }
}

// Use the default predicate by disabling iOS 17 and below detection
DDDefaultSwiftUIRUMActionsPredicate *swiftUIActionsPredicate = [[DDDefaultSwiftUIRUMActionsPredicate alloc] initWithIsLegacyDetectionEnabled:NO];

// Use your own predicate
@protocol DDSwiftUIRUMActionsPredicate <NSObject>
- (DDRUMAction * _Nullable)rumActionFor:(NSString * _Nonnull)componentName;
@end

@interface CustomSwiftUIActionsPredicate : NSObject <DDSwiftUIRUMActionsPredicate>
@end

@implementation CustomSwiftUIActionsPredicate
- (DDRUMAction * _Nullable)rumActionFor:(NSString * _Nonnull)componentName {
    // Custom logic to filter or rename actions
    return [[DDRUMAction alloc] initWithName:componentName attributes:@{}];
}
@end

####iOS バージョンによるアクションレポート

以下の表は、iOS 17 と iOS 18 におけるユーザーインタラクションの報告の違いを示しています。

| コンポーネント | iOS 18 で報告される名前 | iOS 17 で報告される名前 | |||| | Button | SwiftUI_Button | SwiftUI_Unidentified_Element | | NavigationLink | NavigationLink | SwiftUI_Unidentified_Element | | Menu | SwiftUI_Menu (およびそのアイテムは _UIContextMenuCell として) | SwiftUI_Menu (およびそのアイテムは _UIContextMenuCell として) | | Link | SwiftUI_Button | SwiftUI_Unidentified_Element |

###ネットワークリクエストの自動追跡

ネットワークリクエストは、urlSessionTracking 構成で RUM を有効にした後、自動的に追跡されます。

####(オプション) 詳細なタイミングの内訳の有効化

詳細なタイミングの内訳 (DNS 解決、SSL ハンドシェイク、最初のバイトまでの時間、接続時間、ダウンロード時間) を取得するには、デリゲートタイプに対して URLSessionInstrumentation を有効にします。

URLSessionInstrumentation.enableDurationBreakdown(
    with: .init(
        delegateClass: <YourSessionDelegate>.self
    )
)

let session = URLSession(
    configuration: .default,
    delegate: <YourSessionDelegate>(),
    delegateQueue: nil
)

DDURLSessionInstrumentationConfiguration *config = [[DDURLSessionInstrumentationConfiguration alloc] initWithDelegateClass:[<YourSessionDelegate> class]];
[DDURLSessionInstrumentation enableWithConfiguration:config];

NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]
                                                      delegate:[[<YourSessionDelegate> alloc] init]
                                                 delegateQueue:nil];

注: URLSessionInstrumentation がない場合でも、ネットワークリクエストは追跡されます。これを有効にすると、パフォーマンス分析のための詳細なタイミングの内訳が提供されます。 レスポンスデータは、resourceAttributesProvider コールバック (RUM.Configuration.URLSessionTracking で設定) で利用可能で、自動モードの完了ハンドラーを持つタスクと、URLSessionInstrumentation を有効にした後のすべてのタスクに対して利用できます。 特定のリクエストを追跡から除外するには、resourceEventMapper を RUM.Configuration で使用します (RUMイベントの変更または削除 を参照)。

アプリ内に計測したいデリゲートタイプが複数ある場合は、各デリゲートタイプに対して URLSessionInstrumentation.enable(with:) を呼び出すことができます。

また、urlSessionTracking を使用してファーストパーティホストを構成することができます。このクラスは、指定されたドメインに一致するリソースを RUM の「ファーストパーティ」として分類し、トレース情報をバックエンドに伝播します (トレースを有効にしている場合)。ネットワークトレースは、調整可能なサンプリングレートでサンプリングされます。デフォルトでは、20% のサンプリングが適用されます。

たとえば、example.com をファーストパーティホストとして構成し、RUM およびトレース機能の両方を有効にすることができます。

import DatadogRUM

RUM.enable(
  with: RUM.Configuration(
    applicationID: "<rum application id>",
    uiKitViewsPredicate: DefaultUIKitRUMViewsPredicate(),
    uiKitActionsPredicate: DefaultUIKitRUMActionsPredicate(),
    urlSessionTracking: RUM.Configuration.URLSessionTracking(
        firstPartyHostsTracing: .trace(hosts: ["example.com"], sampleRate: 20)
    )
  )
)

URLSessionInstrumentation.enable(
    with: .init(
        delegateClass: <YourSessionDelegate>.self
    )
)

let session = URLSession(
    configuration: .default,
    delegate: <YourSessionDelegate>(),
    delegateQueue: nil
)

@import DatadogRUM;

DDRUMConfiguration *configuration = [[DDRUMConfiguration alloc] initWithApplicationID:@"<rum application id>"];
DDRUMURLSessionTracking *urlSessionTracking = [DDRUMURLSessionTracking new];
[urlSessionTracking setFirstPartyHostsTracing:[DDRUMFirstPartyHostsTracing alloc] initWithHosts:@[@"example.com"] sampleRate:20];
[configuration setURLSessionTracking:urlSessionTracking];

[DDRUM enableWith:configuration];

リソースにカスタム属性を追加するには、RUM を有効にする際に URLSessionTracking.resourceAttributesProvider オプションを使用してください。属性プロバイダークロージャを設定することで、追跡されたリソースに添付される追加の属性を返すことができます。

たとえば、HTTP リクエストと応答ヘッダーを RUM リソースに追加できます。

RUM.enable(
  with: RUM.Configuration(
    ...
    urlSessionTracking: RUM.Configuration.URLSessionTracking(
        resourceAttributesProvider: { request, response, data, error in
            return [
                "request.headers" : redactedHeaders(from: request),
                "response.headers" : redactedHeaders(from: response)
            ]
        }
    )
  )
)

リクエストを追跡したくない場合は、デリゲートタイプの URLSessionInstrumentation を無効にすることができます。

URLSessionInstrumentation.disable(delegateClass: <YourSessionDelegate>.self)

[DDURLSessionInstrumentation disableWithDelegateClass:[<YourSessionDelegate> class]];

####Apollo のインスツルメンテーション iOS アプリケーションで Apollo のインスツルメンテーションを有効にすると、RUM により GraphQL のエラーやパフォーマンスが可視化されます。GraphQL リクエストはすべて単一のエンドポイントに送信され、エラーが発生しても「200 OK」を返すことが多いため、デフォルトの HTTP インスツルメンテーションはコンテキストが不足しています。有効化により、RUM は操作名、操作タイプ、および変数 (オプションでペイロード) をキャプチャできます。これにより、各ネットワークリクエストの詳細なコンテキストが提供されます。

このインテグレーションは、Apollo iOS 1.0 以降 および Apollo iOS 2.0 以降の両方をサポートしています。以下の Apollo iOS バージョンの指示に従ってください。

1. 設定 Datadog iOS RUM で RUM モニタリングを行います。

2. 次の内容をご使用のアプリケーションの Package.swift ファイルに追加します。

   dependencies: [
       // For Apollo iOS 1.0+
       .package(url: "https://github.com/DataDog/dd-sdk-ios-apollo-interceptor", .upToNextMajor(from: "1.0.0"))
   
       // For Apollo iOS 2.0+
       .package(url: "https://github.com/DataDog/dd-sdk-ios-apollo-interceptor", .upToNextMajor(from: "2.0.0"))
   ]
   

   または、Xcode を使用して追加することもできます。

   1. ファイル → パッケージ依存関係の追加 に移動します。
   2. リポジトリの URL https://github.com/DataDog/ddsdkiosapollointerceptor を入力します。
   3. ご使用の Apollo メジャーバージョンに一致するパッケージバージョンを選択してください (Apollo iOS 1.0 以降の場合は 1.x.x を、Apollo iOS 2.0 以降の場合は 2.x.x を選択します)。

3. ご使用の Apollo iOS バージョンに基づいてネットワークインスツルメンテーションを設定します。

   Apollo の組み込み URLSessionClient のためにネットワークインスツルメンテーションを設定します。

   import Apollo
   
   URLSessionInstrumentation.enable(with: .init(delegateClass: URLSessionClient.self))
   

   Apollo Client 設定に Datadog インターセプターを追加します。

   import Apollo
   import DatadogApollo
   
   class CustomInterceptorProvider: DefaultInterceptorProvider {
       override func interceptors<Operation: GraphQLOperation>(for operation: Operation) -> [ApolloInterceptor] {
           var interceptors = super.interceptors(for: operation)
           interceptors.insert(DatadogApolloInterceptor(), at: 0)
           return interceptors
       }
   }
   

   提供された DatadogApolloDelegate と DatadogApolloURLSession を使用してネットワークインスツルメンテーションを構成します。

   import Apollo
   import DatadogApollo
   import DatadogCore
   
   // Create the Datadog delegate
   let delegate = DatadogApolloDelegate()
   
   // Create the custom URLSession wrapper
   let customSession = DatadogApolloURLSession(
       configuration: .default,
       delegate: delegate
   )
   
   // Enable Datadog instrumentation for the delegate
   URLSessionInstrumentation.enable(
       with: .init(delegateClass: DatadogApolloDelegate.self)
   )
   
   // Configure Apollo Client with the custom session
   let networkTransport = RequestChainNetworkTransport(
       urlSession: customSession,
       interceptorProvider: NetworkInterceptorProvider(),
       store: store,
       endpointURL: url
   )
   

   Datadog インターセプターを使用してインターセプタープロバイダーを作成します。

   import Apollo
   import DatadogApollo
   
   struct NetworkInterceptorProvider: InterceptorProvider {
       func graphQLInterceptors<Operation>(for operation: Operation) -> [any GraphQLInterceptor] where Operation : GraphQLOperation {
           return [DatadogApolloInterceptor()] + DefaultInterceptorProvider.shared.graphQLInterceptors(for: operation)
       }
   }
   

   これにより、Datadog RUM はリクエストからオペレーションの種類、名前、変数、および (オプションで) ペイロードを自動的に抽出し、GraphQL リクエストの RUM リソースを拡張させます。

   • このインテグレーションは、Apollo iOS バージョン 1.0 以降および 2.0 以降をサポートしています。
   • この query と mutation タイプの操作は追跡されますが、subscription 操作は追跡されません。
   • GraphQL ペイロードの送信はデフォルトで無効になっています。これを有効にするには、sendGraphQLPayloads フラグを DatadogApolloInterceptor コンストラクタに次のように設定します。

   
   let datadogInterceptor = DatadogApolloInterceptor(sendGraphQLPayloads: true)
     

###エラーの自動追跡

Logger と送信されたすべての “error” および “critical” ログは自動的に RUM エラーとして報告され、現在の RUM ビューにリンクされます。

import DatadogLogs

let logger = Logger.create()

logger.error("message")
logger.critical("message")

@import DatadogLogs;

DDLogger *logger = [DDLogger create];
[logger error:@"message"];
[logger critical:@"message"];

同様に、エラーとしてマークされたすべての終了スパンは、RUM エラーとして報告されます。

import DatadogTrace

let span = Tracer.shared().startSpan(operationName: "operation")
// ... capture the `error`
span.setError(error)
span.finish()

// ... capture the `error`
id<OTSpan> span = [[DDTracer shared] startSpan:@"operation"];
[span setError:error];
[span finish];

##RUM イベントの変更または削除

Datadog に送信される前に RUM イベントの属性を変更したり、イベントを完全に削除したりするには、RUM iOS SDK を構成するときに Event Mappers API を使用します。

let configuration = RUM.Configuration(
    applicationID: "<rum application id>",
    viewEventMapper: { RUMViewEvent in
        return RUMViewEvent
    }
    resourceEventMapper: { RUMResourceEvent in
        return RUMResourceEvent
    }
    actionEventMapper: { RUMActionEvent in
        return RUMActionEvent
    }
    errorEventMapper: { RUMErrorEvent in
        return RUMErrorEvent
    }
    longTaskEventMapper: { RUMLongTaskEvent in
        return RUMLongTaskEvent
    }
)

DDRUMConfiguration *configuration = [[DDRUMConfiguration alloc] initWithApplicationID:@"<rum application id>"];

[configuration setViewEventMapper:^DDRUMViewEvent * _Nonnull(DDRUMViewEvent * _Nonnull RUMViewEvent) {
    return RUMViewEvent;
}];

[configuration setErrorEventMapper:^DDRUMErrorEvent * _Nullable(DDRUMErrorEvent * _Nonnull RUMErrorEvent) {
    return RUMErrorEvent;
}];

[configuration setResourceEventMapper:^DDRUMResourceEvent * _Nullable(DDRUMResourceEvent * _Nonnull RUMResourceEvent) {
    return RUMResourceEvent;
}];

[configuration setActionEventMapper:^DDRUMActionEvent * _Nullable(DDRUMActionEvent * _Nonnull RUMActionEvent) {
    return RUMActionEvent;
}];

[configuration setLongTaskEventMapper:^DDRUMLongTaskEvent * _Nullable(DDRUMLongTaskEvent * _Nonnull RUMLongTaskEvent) {
    return RUMLongTaskEvent;
}];

各マッパーは、(T) > T? のシグネチャを持つ Swift クロージャです。ここで、T は具体的な RUM イベントタイプです。これにより、イベントが送信される前にその一部を変更することができます。

たとえば、RUM Resource の url に含まれる機密情報をマスクするには、カスタム redacted(_:) > String 関数を実装し、それを resourceEventMapper で使用します:

let configuration = RUM.Configuration(
    applicationID: "<rum application id>",
    resourceEventMapper: { RUMResourceEvent in
        var RUMResourceEvent = RUMResourceEvent
        RUMResourceEvent.resource.url = redacted(RUMResourceEvent.resource.url)
        return RUMResourceEvent
    }
)

DDRUMConfiguration *configuration = [[DDRUMConfiguration alloc] initWithApplicationID:@"<rum application id>"];

[configuration setResourceEventMapper:^DDRUMResourceEvent * _Nullable(DDRUMResourceEvent * _Nonnull RUMResourceEvent) {
    return RUMResourceEvent;
}];

エラー、リソース、アクションのマッパーから nil を返すと、イベントは破棄され、Datadog に送信されません。ビューイベントマッパーから返される値は nil であってはなりません (ビューを除外するには、UIKitRUMViewsPredicate の実装をカスタマイズしてください。詳細は ビューの自動追跡について をご覧ください)。

イベントのタイプに応じて、一部の特定のプロパティのみを変更できます。

| イベントタイプ | 属性キー | 説明 | | | | | | RUMActionEvent | RUMActionEvent.action.target?.name | アクションの名前。 | | | RUMActionEvent.view.url | このアクションにリンクされたビューの URL。 | | RUMErrorEvent | RUMErrorEvent.error.message | エラーメッセージ。 | | | RUMErrorEvent.error.stack | エラーのスタックトレース。 | | | RUMErrorEvent.error.resource?.url | エラーが参照するリソースの URL。 | | | RUMErrorEvent.view.url | このエラーにリンクされたビューの URL。 | | RUMResourceEvent | RUMResourceEvent.resource.url | リソースの URL。 | | | RUMResourceEvent.view.url | このリソースにリンクされたビューの URL。 | | RUMViewEvent | RUMViewEvent.view.name | ビューの名前。 | | | RUMViewEvent.view.url | ビューの URL。 | | | RUMViewEvent.view.referrer | ページの初期ビューへのリンク URL。|

##RUM セッション ID の取得

RUM セッション ID を取得すると、トラブルシューティングの際に役立ちます。たとえば、セッション ID をサポートリクエスト、メール、またはバグレポートに添付することで、サポートチームが後で Datadog でユーザーセッションを見つけることができます。

ランタイム中に sessionStarted イベントを待たずに RUM セッション ID にアクセスできます。

RumMonitor.shared().currentSessionID(completion: { sessionId in
  currentSessionId = sessionId
})

##トラッキングの同意を設定 (GDPR の遵守)

GDPR 規制を遵守するため、RUM iOS SDK は初期化時に追跡に関する同意を求めます。

trackingConsent 設定は以下のいずれかの値で示されます。

1. .pending: RUM iOS SDK はデータの収集とバッチ処理を開始しますが、Datadog には送信しません。RUM iOS SDK は、バッチ処理が完了したデータをどうするかについての新たな同意値が得られるまで待機します。
2. .granted: RUM iOS SDK はデータの収集を開始し、Datadog へ送信します。
3. .notGranted: RUM iOS SDK はデータを収集しません。ログ、トレース、または RUM イベントは Datadog に送信されません。

RUM iOS SDK の初期化後にトラッキング同意値を変更するには、Datadog.set(trackingConsent:) API 呼び出しを使用します。RUM iOS SDK は新しい値に応じて動作を変更します。

たとえば、現在のトラッキング同意が .pending の場合は以下のようになります。

値を .granted に変更すると、RUM iOS SDK は現在および今後のすべてのデータを Datadog に送信します。 値を .notGranted に変更すると、RUM iOS SDK は現在のすべてのデータを消去し、今後のデータを収集しません。

##ユーザー属性の追加

Datadog.addUserExtraInfo(_:) API を使用して、以前に設定したプロパティに追加のユーザー属性を追加できます。

import DatadogCore

Datadog.addUserExtraInfo(["company": "Foo"])

##データ管理

iOS SDK は最初にイベントをローカルに保存し、取り込み仕様 の条件が満たされたときにのみイベントをアップロードします。

###すべてのデータのクリア

SDK によって保存されたすべての未送信データを Datadog.clearAllData() API を使用して削除するオプションがあります。

import DatadogCore

Datadog.clearAllData()

###データ収集の停止

Datadog.stopInstance() API を使用すると、名前付き SDK インスタンス (名前が nil の場合はデフォルトインスタンス) のデータ収集およびアップロードを停止できます。

import DatadogCore

Datadog.stopInstance()

このメソッドを呼び出すと、SDK や RUM などのすべてのアクティブな機能が無効になります。データ収集を再開するには、SDK を再初期化する必要があります。動的に設定を変更したい場合にこの API を使用できます。

##参考資料

お役に立つドキュメント、リンクや記事:

ddsdkios のソースコードSOURCE CODE RUM およびセッションリプレイDOCUMENTATION RUM iOS および tvOS モニタリングサポート対象バージョンDOCUMENTATION Apollo iOS 用の Datadog インテグレーションSOURCE CODE