Unity アプリの導入¶
Unity アプリのメトリクスデータを収集し、アプリケーションパフォーマンスを可視化して分析します。
参照順序¶
- 初めて導入する場合:まず接続方式の選択を参照してください。手動接続の場合はクイックスタートを参照してください
- 完全な導入:本記事を引き続きお読みください
- パラメータの詳細:SDK 初期化、RUM 設定、Log 設定、Trace 設定を参照してください
- カスタム機能:カスタムタグの使用、RUM 手動トラッキング、データ収集のマスキングを参照してください
- 高度なシナリオ:ネイティブと Unity のハイブリッド開発を参照してください
- 問題の調査:トラブルシューティングを参照してください
前提条件¶
注意
RUM Headless サービスを既にご利用の場合は、前提条件が自動的に設定されているため、そのままアプリを接続できます。
ローカル環境にデプロイする場合は、以下のデータ受信側の設定を完了する必要があります。パブリック DataWay を使用する場合は、DataKit を自前でデプロイする必要はありません。
- DataKit をインストールする
- RUM コレクタを設定する
- DataKit をパブリックアクセス可能に設定し、IP 地理位置情報ライブラリをインストールする
アプリの接続¶
- RUM > アプリを作成 > Android/iOS に移動します
- Unity Android と Unity iOS 用にそれぞれアプリを 2 つ作成し、Android と iOS の各プラットフォームから送信される RUM データをそれぞれ受信できるようにします
- 各プラットフォームのアプリに、対応するアプリ名とアプリ ID を入力します
- 「接続方式の選択」で Agent 自動接続または手動接続を選択し、「接続設定」を完了します。
接続方式の選択¶
アプリ設定ページで「Agent 自動接続」または「手動接続」を選択し、「接続設定」を完了します。既存のアプリの場合は、設定ページに直接移動して接続を続行できます。
| 接続方式 | ユースケース | 操作入口 |
|---|---|---|
| Agent 自動接続 | プログラミングアシスタントにプロジェクトを分析させ、SDK の導入を完了したい場合 | コンソールが生成したプロンプトをコピーし、アプリケーションのコードリポジトリでプログラミングアシスタントに実行させます |
| 手動接続 | SDK を自身でインストールしてパラメータを設定したい場合 | データ送信方式を確認し、本文とクイックスタートに従って設定を完了します |
Agent 自動接続¶
- 対象のアプリの設定ページで「Agent 自動接続」を選択します。
- 「接続設定」内のプロンプト全体をコピーし、対象のアプリの接続情報が使用されていることを確認します。
- アプリケーションのコードリポジトリでプログラミングアシスタントを開き、プロンプトを貼り付けると、Agent が接続ガイドに従ってプロジェクトを分析し、SDK の設定を完了します。
- アプリをビルドして実行し、ページアクセスなどの操作を発生させたうえで、対象のアプリのエクスプローラーでデータを受信していることを確認します。
クロスプラットフォームフレームワークを使用する場合は、Agent にフレームワークと対象プラットフォームを伝え、各プラットフォームに対応するアプリ情報をそれぞれ提供してください。
ページに個人用 API Key または一時認証コードが未準備である旨が表示された場合は、案内に従って補完したうえで、プロンプトを再度コピーしてください。
手動接続¶
アプリ設定ページで「手動接続」を選択し、データ送信方式を確認します:
- パブリック DataWay:RUM データを直接受信します。DataKit コレクタをインストールする必要はありません
- ローカル環境へのデプロイ:前提条件を満たしたうえで RUM データを受信します
以下のインストールとクイックスタートに従って、SDK のインストール、初期化、検証を完了してください。既存の SDK 設定がある場合は、重複した初期化を避けるため、まず内容を確認して再利用してください。
インストール¶
ソースコード:https://github.com/GuanceCloud/datakit-unity
デモ:https://github.com/GuanceCloud/datakit-unity/blob/dev/Assets/Scenes
- 最新の ft-sdk-unity.unitypackage をダウンロードします
Assets->Import Package->Custom Package...からft-sdk-unity.unitypackageをインポートします- JSON 解析用のサードパーティライブラリ
"com.unity.nuget.newtonsoft-json"を追加します。これはPackage Manager->Add Package by name ...で実行できます FTSDK.prefabを最初のシーンページにドラッグし、FTSDK.csの_InitSDKメソッド内で SDK を初期化しますFTViewObserver.prefabを他のシーンページにドラッグします。これはページViewのライフサイクル、およびアプリのスリープとウェイクアップを監視するために使用しますApplication.logMessageReceivedを通じて Unity のクラッシュデータと通常のログデータを監視および変換します。例についてはクイックスタートと RUM 手動トラッキングを参照してください
Assets/Plugins
├── Android
│ ├── FTUnityBridge.java // Android bridge
│ ├── InnerClassProxy.java // Android Inner Setting Proxy
│ ├── ft-sdk-release.aar // Android SDK
│ ├── gson-2.8.5.jar // Android SDK 依赖第三方库
├── iOS
│ ├── FTMobileSDK.xcframework // iOS SDK
│ ├── FTUnityBridge.mm // iOS bridge
├── FTSDK.cs // FTSDK.prefab 绑定脚本
├── FTSDK.prefab // SDK 初始化预制件
├── FTUnityBridge.cs // Unity bridge 桥接 iOS Android 等平台方法
├── FTViewObserver.cs // FTViewObserver.prefab 绑定脚本
├── FTViewObserver.prefab // View 页面监听预制件
├── UnityMainThreadDispatcher.cs // UnityMainThreadDispatcher.prefab 绑定脚本
├── UnityMainThreadDispatcher.prefab // 主线程消费队列预制件
- ネイティブの Android および iOS プロジェクトに既にネイティブ SDK が統合されている場合は、重複した設定を避けるため
_InitSDKメソッドをコメントアウトする必要があります。具体的なケースについてはネイティブと Unity のハイブリッド開発を参照してください - iOS Plugin Inspector の設定:
FTMobileSDK.xcframeworkは動的ライブラリであるため、Add to Embedded Binariesをチェックする必要があります。このオプションを選択すると、Unity が Xcode プロジェクトのオプションを設定し、プラグインファイルが最終的なアプリケーションバンドルにコピーされます。
ネイティブ SDK を既に統合している場合は、Android の
gson-2.8.5.jar、ft-sdk-release.aar、および iOS のFTMobileSDK.frameworkを Unity プロジェクトから削除できます。
Android の OkHttp リクエストおよび起動時間の機能はft-pluginと組み合わせて使用する必要があります。詳細な設定については Android SDK を参照してください。
初期化の説明¶
最小構成の初期化例についてはクイックスタートを参照してください。
SDKConfig の完全なパラメータ説明については SDK 初期化を参照してください。
詳細設定の参照先¶
高度なシナリオ¶
よくある質問¶
変数を追加してフィールドの競合を回避する¶
カスタムフィールドと SDK データの競合を避けるため、タグ名には プロジェクトの略称 をプレフィックスとして付けることを推奨します(例:custom_tag_name)。プロジェクト内で使用されている key の値はソースコードで確認できます。SDK のグローバル変数に RUM や Log と同じ変数が存在する場合、RUM および Log が SDK のグローバル変数を上書きします。
