クイックスタート¶
本ドキュメントは、Unity RUM SDK の最短導入経路を提供し、最小限の手順で検証可能なデータ送信を実現することを目的としています。
事前準備¶
開始前に、以下の準備を完了してください。
- リアルユーザーモニタリング(RUM) で Unity Android アプリと Unity iOS アプリをそれぞれ作成し、対応する
App IDを取得します。 - 送信先URLと認証方式を確認します。
- ローカル環境デプロイ:
datakitUrlを準備します。 - パブリック DataWay:
datawayUrlとclientTokenを準備します。 - プロジェクトに
ft-sdk-unity.unitypackageがインポートされていることを確認します。 - プロジェクトに
"com.unity.nuget.newtonsoft-json"がインストールされていることを確認します。
導入手順¶
FTSDK.prefabを最初のシーンにドラッグ&ドロップします。- アプリケーション起動時に
FTUnityBridge.Install(...)を呼び出します。 RUMConfigを初期化し、Android と iOS のApp IDを渡します。- 必要に応じて
LogConfigとTraceConfigを初期化します。 - アプリケーションを実行し、ページの表示、ログ出力、またはネットワークリクエストを1回トリガーします。
- Unity コンソールと Guance プラットフォームで、データが正常に送信されたことを確認します。
最小初期化例¶
FTUnityBridge.Install(new SDKConfig
{
// ローカル環境のデプロイでは datakitUrl を使用します
datakitUrl = "http://10.0.0.1:9529",
// パブリック DataWay では datawayUrl + clientToken を使用します
// datawayUrl = "https://open.dataway.url",
// clientToken = "client-token",
env = "prod",
debug = true,
});
FTUnityBridge.InitRUMConfig(new RUMConfig
{
androidAppId = "androidAppId",
iOSAppId = "iOSAppId",
sampleRate = 1.0f,
});
datakitUrlとdatawayUrlはどちらか一方を選択してください。パブリック DataWay を使用する場合は、clientTokenも併せて渡してください。
オプション:Log と Trace の初期化¶
FTUnityBridge.InitLogConfig(new LogConfig
{
enableCustomLog = true,
enableLinkRumData = true,
sampleRate = 1.0f,
});
FTUnityBridge.InitTraceConfig(new TraceConfig
{
enableNativeAutoTrace = true,
enableLinkRumData = true,
sampleRate = 1.0f,
});
オプション:Unity 例外の監視補完¶
Unity の例外を RUM Error として変換したい場合は、Application.logMessageReceived をリッスンします。
void OnEnable()
{
Application.logMessageReceived += LogCallBack;
}
void OnDisable()
{
Application.logMessageReceived -= LogCallBack;
}
void LogCallBack(string condition, string stackTrace, LogType type)
{
if (type == LogType.Exception)
{
FTUnityBridge.AddError(stackTrace, condition);
}
}
導入の成功確認¶
debug = trueを有効にしたままアプリケーションを実行します。- ページを開くか、ネットワークリクエストを1回実行します。
- Unity コンソールに、SDK の初期化とデータ同期に関するログが出力されることを確認します。
- Guance コンソールに戻り、アプリに対応する RUM データが表示されていることを確認します。
さらに詳しく調査する必要がある場合は、トラブルシューティング を参照してください。
次のステップ¶
- 完全なインストールと初期化の手順については、アプリケーション導入 を参照してください。
- すべての初期化パラメータの説明については、SDK 初期化 を参照してください。
- RUM、Log、Trace の詳細設定については、RUM 設定、Log 設定、Trace 設定 を参照してください。
- プロジェクトがネイティブと Unity のハイブリッド開発の場合は、ネイティブと Unity のハイブリッド開発 を参照してください。
- View、Action、Resource、Error、LongTask を手動で収集する必要がある場合は、データ収集カスタムルール を参照してください。