手動導入¶
ft-plugin を使用しない場合の SDK 導入方法¶
Guance は Android Gradle Plugin Transformation によるコード注入でデータを自動収集します。ただし、互換性の問題により ft-plugin や ft-plugin-legacy を使用できない場合があります。影響を受ける範囲は次のとおりです。
- RUM の
Action、Resource android.util.Log- Java と Kotlin の
printlnコンソールログの自動取得 - シンボルファイルの自動アップロード
このような場合は、手動統合の方法を利用できます。
Application 起動イベント¶
ソースコードは DemoForManualSet.kt を参照してください。
ユーザー操作の手動追加¶
ボタンなどのイベントは、トリガー箇所で自ら追加する必要があります。ここでは Button の onClick イベントを例にします。ソースコードは ManualActivity.kt を参照してください。
OkHttp Resource / Trace の手動統合¶
OkHttp は addInterceptor と eventListener を使用して Resource と Trace を統合できます。例は次のとおりです。ソースコードは ManualActivity.kt を参照してください。
OkHttpClient.Builder builder = new OkHttpClient.Builder()
.addInterceptor(new FTTraceInterceptor())
.addInterceptor(new FTResourceInterceptor())
.eventListenerFactory(new FTResourceEventListener.FTFactory());
//.eventListenerFactory(new FTResourceEventListener.FTFactory(true));
OkHttpClient client = builder.build();
その他のネットワークフレームワークでは、FTRUMGlobalManager.startResource、stopResource、addResource および FTTraceManager.getTraceHeader を自前で実装する必要があります。具体的な実装方法は、ソースコードの例 ManualActivity.kt を参照してください。
OkHttp Visitor ID の手動統合¶
ft-sdk >= 1.7.6-alpha04 の場合は、まず Visitor ID に従って初期化を完了し、その後 FTVisitorIdInterceptor.install(builder) で業務用の OkHttpClient にインターセプターを導入します。Visitor ID ヘッダーのみを注入する場合、Resource または Trace のインターセプターをインストールする必要はありません。
Resource / Trace も同時に収集する場合は、前節の例で他のインターセプターを追加した後、builder.build() の前に install(builder) を呼び出してください。このメソッドは、Visitor ID を適用するインターセプターを FTResourceInterceptor の前に配置し、リダイレクト保護インターセプターを現在のネットワークインターセプターリストの末尾に追加します。他のインターセプターの設定が完了してから呼び出してください。
install(builder) を使用してください。addInterceptor(new FTVisitorIdInterceptor()) だけで導入すると、リダイレクト保護が欠落します。同じ Builder に対して install を繰り返し呼び出しても、Visitor ID インターセプターは重複インストールされず、Resource や Trace の収集も自動的に有効になりません。
OkHttp WebSocket Resource の手動統合¶
ft-sdk >= 1.7.5 の場合、WebSocket の自動インストルメンテーションに対応した ft-plugin を使用していないときは、FTWebSocket を使用して OkHttp WebSocket ハンドシェイクの Resource を明示的に収集できます。事前に FTRUMConfig.setEnableTraceUserResource(true) を有効にする必要があります。既存の Resource URL フィルタリングと RUM サンプリングルールは引き続き有効です。収集対象はハンドシェイクの成功、サーバー側による拒否、または失敗のみで、接続の存続時間は計測されず、メッセージ内容も収集されません。
呼び出し箇所が少ない場合は、FTWebSocket.newWebSocket() を直接使用できます。
プロジェクトが依存性注入で WebSocket factory を一元提供している場合は、一度ラップしてから WebSocket.Factory として注入できます。
wrap() は繰り返し呼び出しに対応しています。ft-plugin >= 1.3.8 を同時に有効にしている場合でも、同じリクエストでハンドシェイク Resource が収集されるのは 1 回だけです。サードパーティライブラリが内部で OkHttpClient を保持し、newWebSocket() の呼び出し箇所を公開しておらず、WebSocket.Factory の受け渡しも許可しない場合は、ft-plugin による自動インストルメンテーションが必要です。