コンテンツにスキップ

トラブルシューティング

SDK 初期化時の異常チェック

Debug 環境で Guance SDK を設定し、アプリケーションを初回実行した後、Xcode のデバッガコンソールを確認してください。SDK はアサーションを使用して複数の設定の正確性をチェックし、設定が誤っている場合はクラッシュして関連する警告を出力します。

例:SDK を設定する際に datakit metrics の書き込みアドレスを設定しなかった場合、プログラムはクラッシュし、コンソールに警告⚠️が出力されます。

*** Assertion failure in +[FTMobileAgent startWithConfigOptions:], FTMobileAgent.m:53
*** Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: 'datakit metrics の書き込みアドレスを設定してください'

Debug デバッグを有効にする

Debug 環境では FTMobileConfig の設定項目 enableSDKDebugLog = YES を有効にし、Release 環境では無効にすることを推奨します。SDK のデバッグログは [FTLog] をプレフィックスとして識別されるため、[FTLog] でフィルタリングできます。

注意:scheme で OS_ACTIVITY_MODE=disable を設定している場合、SDK のデバッグログが正常に出力されません。デバッグ時はこの設定を無効にすることを推奨します。

Release 版をリリースする際は、Debug デバッグを無効にすることを推奨します

ログ例

データ同期

//以下は正常な同期ログです
[FTLog][INFO] -[FTTrackDataManger flushWithEvents:type:] [line 143] ↵
                                                イベントのアップロードを開始(今回のアップロードイベント数:2)
[FTLog][INFO] -[FTRequestLineBody getRequestBodyWithEventArray:] [line 149]
Upload Datas Type:RUM
Line RequestDatas:
...... datas ......
[FTLog][INFO] -[FTTrackDataManger flushWithEvents:type:]_block_invoke [line 157] ↵
                                                Upload Response statusCode : 200

1.3.10 より前のバージョンでは Upload Response statusCode : 200 は出力されません。コンソールにエラーログがあるかどうか確認し、エラーログがなければアップロード成功です。

エラーログ:Network failure: ...... または サーバー異常、後でもう一度お試しください......

1.5.16 以降のバージョンでは、ログで [NETWORK] を検索すると、データ同期に関連するすべてのログを確認できます。

SDK 内部ログをキャッシュファイルに変換

// デフォルトパス:1.4.11-1.4.12 /Library/Caches/FTLogs/FTLog xxxx-xx-xx--xx/xx/xx/xxx.log
//         >= 1.4.13 /Documents/FTLogs/FTLog.log

// >= 1.4.11
 [[FTLog sharedInstance] registerInnerLogCacheToLogsDirectory:nil fileNamePrefix:nil];

// >= 1.4.13
//  方法1:デフォルトパス
 [[FTLog sharedInstance] registerInnerLogCacheToDefaultPath]
//  方法2:パスを指定
 NSString *filePath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES).firstObject 
stringByAppendingPathComponent:@"ExampleName.log"];
 [[FTLog sharedInstance] registerInnerLogCacheToLogsFilePath:filePath];

内部ログの完全性を保つため、SDK の初期化前にこの設定を行う必要があります

SDK は正常に動作しているがデータがない

  • Datakit が正常に動作しているかどうか確認する

  • SDK のアップロードアドレス datakitUrl または datawayUrl が正しく設定され、正しく初期化されていることを確認します。Debug モードでは、ログを参照してアップロードの問題を判断します。

  • datakit が対応するワークスペースにデータをアップロードしているか、オフライン状態になっていないかを確認します。この問題は、Guance にログインして「インフラストラクチャー」を確認することで判断できます。

データ収集成功の確認

Logger

FTLoggerConfig の設定項目 enableCustomLog = YES を設定し、カスタムログの収集・アップロードを有効にします。

SDK がログを収集すると、Xcode のデバッガコンソールに SDK のデバッグログが表示されます。

[FTLog][INFO] -[FTRecordModel initWithSource:op:tags:fields:tm:] [line 36] write data = {
    op = Logging;
    opdata =     {
        fields =         {
            message = "xxxxx収集されたログ内容XXXXX";
        };
        source = "df_rum_ios_log";
        tags =         {
             ...... 
        }
   }
}

op = Logging; が表示されていれば、Logger 機能が正常に有効になり、データが正常に収集されています。

RUM

SDK バージョンが 1.4.14 未満の場合、Resource データと Action データ(launch action を除く)は View にバインドされているため、View が収集されている状態でなければ正常に収集できません。

View の収集:FTRumConfig の設定項目 enableTraceUserView = YES を設定して自動収集を有効にするか、-startViewWithName で手動収集します。

Xcode のデバッガコンソールで SDK のデバッグログを確認します。

[FTLog][INFO] -[FTRecordModel initWithSource:op:tags:fields:tm:] [line 36] write data = {
    op = RUM;
    opdata =     {
        fields =       {
            .......
        };
        source = action;
        tags =         {
            ........
        }       
   }
}

op = RUM; が表示されていれば、RUM 機能が正常に有効になり、データが正常に収集されています。

Trace

enableLinkRumData = YES を設定すると、RUM Resourse データに表示を確認できます。Xcode のデバッガコンソールで SDK のデバッグログを確認します。

[FTLog][INFO] -[FTRecordModel initWithSource:op:tags:fields:tm:] [line 36] write data = {
    op = RUM;
    opdata =     {
        fields =         {
            duration = 5873084;
            "request_header" = "Accept:*/*\nx-datadog-parent-id:12914452039873665275\nx-datadog-trace-id:6849912365449426814\nx-datadog-origin:rum\nAccept-Language:en-US,en;q=0.9\nAccept-Encoding:gzip, deflate\nx-datadog-sampling-priority:2";
            ......
        };
        source = resource;
        tags =         {
            ......
            "span_id" = 12914452039873665275;
            "trace_id" = 6849912365449426814;
            ......
        };
    };

op = RUM; かつ source = resource; のデータを探し、tags に span_id と trace_id が含まれていれば、Trace 機能が正常に有効になっています。

データ欠落

一部データの欠落

  1. RUM の特定の Session データや Log、Trace 内の数件のデータが欠落する場合

まず、RUM、Log、Trace のサンプリング設定を確認します。SDK 1.6.8 以降では、sessionSamplingRate、logSamplingRate、traceSamplingRate の使用を推奨します。単位は 0~100 のパーセントで、0 は無効、100 は全サンプリングです。1 未満の正数も有効な小数のサンプリングレートで、例えば 0.1 は 0.1% を意味します。「1 未満」というだけで機能が無効になっていると判断しないでください。セッションサンプリングで選択されなかった場合や、ログ/Trace が比率に応じて選択されなかった場合も、一部のデータが欠落します。旧属性の sampleRate / samplerate は整数パーセントのみをサポートし、非推奨としてマークされており、将来のバージョンで削除される可能性があります。リモートの旧フィールドの比率単位については、リモート設定フィールド を参照してください。

  1. RUM の Resource イベントまたは Action イベント(launch action を除く)が欠落する場合

View の自動収集が有効になっているか、Open API による手動収集が使用されているかを確認する必要があります。Resource イベントと Action イベントは View にバインドされているため、View が収集されている状態でなければ正常に収集できません。

  1. SDK バージョンが 1.4.14 以下の場合に一部のデータが欠落し、Xcode のデバッガコンソールに次のようなデバッグログが表示されるとき
*********このデータの形式が正しくありません********
(null)*** 1717051153966272768
******************

SDK に渡す NSDictionary 型のパラメータが以下の要件を満たしているか確認してください:

  • すべてのディクショナリのキーが NSString であること

  • すべてのオブジェクトが NSString、NSNumber、NSArray、NSDictionary、または NSNull であること

  • NSNumber が NaN または無限大ではないこと

キーと値にはいずれも NSString を使用することを推奨します。

  1. データをアップロードするデバイスのネットワーク、および datakit をインストールしたデバイスのネットワークと負荷の問題を確認します。

Error データの欠落、Crash タイプのデータ

  • Crash 収集機能が有効になっているか確認します

  • SDK の初期化が Crash の前に完了しているか確認します

  • Crash をキャプチャする機能を持つ他のサードパーティ製コンポーネントを使用しているか確認します。使用している場合は、FTMobileSDK の初期化をそのコンポーネントの後に行います

  • Xcode のデバッグ段階かどうか確認します

SDK はUNIX シグナルとMach 例外を使用してクラッシュをキャプチャします。この 2 つのキャプチャ方法はいずれも、Xcode でデフォルトで有効になっている Debug executable の影響を受けます。これは SDK がこれらの例外をキャプチャする前にインターセプトするため、デバッグ段階でもクラッシュを正常にキャプチャしたい場合は、手動で Debug executable 機能を無効にするか、Xcode のデバッグ接続なしでテストを行ってください。 注意:Debug executable を無効にすると、ブレークポイントデバッグ機能が無効になります。

troubleshooting_debug_executable

バージョン互換性の問題

RUM Resource イベントのパフォーマンスメトリクス欠落

影響バージョン:SDK バージョン 1.3.10 以下

SDK は iOS 9 以降をサポートしていますが、RUM Resource イベントのパフォーマンスメトリクスは iOS 10 以降でサポートされている API を使用して収集する必要があります。そのため、ユーザーデバイスの OS が iOS 10 未満の場合、収集された Resource イベントにはパフォーマンスメトリクス部分が含まれません。

RUM Error データの carrier 属性に -- が表示される

iOS 16.4 以降では、CoreTelephony の CTCarrier は非推奨となり、代替の API もありません。非推奨のメソッドを使用すると静的値 -- が返されます。

WebView

[xxViewController retain]: message sent to deallocated instance xxx

影響バージョン:SDK バージョン 1.4.10 以下

原因:WebView を使用する際に WebView にオブザーバーを追加したものの、オブザーバーが解放される直前に WebView からそのオブザーバーを削除しなかった場合に発生します。SDK 内部で WebView への強参照が保持されているため WebView は解放されません。その後、監視対象の KeyPath が変化するとオブザーバーに通知されますが、オブザーバーはすでに解放されているため、EXC_BAD_ACCESS エラーが発生します。

修正の推奨事項:

  • SDK バージョンをアップグレードする

  • または、オブザーバーが解放される直前にそのオブザーバーを削除します。

   - (void)createWebView{
     [self.webView.scrollView addObserver:self forKeyPath:@"contentSize" options:NSKeyValueObservingOptionNew context:nil];
   }
   -(void)dealloc{
     [self.webView.scrollView removeObserver:self forKeyPath:@"contentSize"]
   }

フィードバック

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