クイックスタート¶
本ドキュメントは、UniApp RUM SDK の最短導入経路を提供し、最小限の手順で検証可能なデータ送信を実現することを目的としています。
前置準備¶
開始前に、以下の準備を完了してください。
- リアルユーザーモニタリング（RUM） で UniApp Android アプリと UniApp iOS アプリをそれぞれ作成し、各々の
RUM App IDを取得します。 - 送信先アドレスと認証方法を確認します。
- ローカル環境デプロイ：
datakitUrlを準備します。 -
パブリック DataWay：
datawayUrlとclientTokenを準備します。 -
datakit-uniapp-native-plugin をダウンロードし、
GCUniPluginとGC-JSPluginを準備します。
導入手順¶
GCUniPluginをプロジェクトのnativepluginsにコピーし、manifest.jsonでローカルプラグインを有効にします。GC-JSPluginをプロジェクトのuni_modulesにコピーします。App.vueでsdkConfigを呼び出し、SDK の初期化を完了します。rum.setConfigを呼び出して、Android と iOS のApp IDを設定します。- ページ、エラー、リクエストを自動収集する場合は、
GC-JSPluginの対応する機能をさらに導入します。 debugを有効にし、アプリを実行してデータが正常に送信されるか確認します。
最小初期化サンプル¶
<script>
var ftModule = uni.requireNativePlugin("GCUniPlugin-MobileAgent");
var rum = uni.requireNativePlugin("GCUniPlugin-RUM");
export default {
onLaunch: function() {
ftModule.sdkConfig({
datawayUrl: "https://open.dataway.url",
clientToken: "client-token",
debug: true,
env: "common"
});
rum.setConfig({
androidAppId: "YOUR_ANDROID_APP_ID",
iOSAppId: "YOUR_IOS_APP_ID"
});
}
}
</script>
View 自動収集サンプル¶
以下は Vue 2 の呼び出し方法です。Vue 3 の場合は gcViewTracking.startTracking(app) を呼び出してください。完全なサンプルは RUM View 自動収集 を参照してください。
Resource 自動収集サンプル¶
初回の uni.request 呼び出し前にグローバル収集を起動します。以降は元のリクエストメソッドを置き換える必要はありません。
import { gcResourceTracking } from '@/uni_modules/GC-JSPlugin';
gcResourceTracking.startTracking();
uni.request({
url: 'https://example.com/api'
});
iOS で rum.setConfig({ enableNativeUserResource: true }) によりネイティブ Resource 収集を有効にしている場合は、gcResourceTracking.startTracking({ enableIOS: false }) を呼び出して重複収集を防止してください。詳細は RUM Resource 自動収集 を参照してください。
導入の確認¶
debug: trueを有効にしたままアプリを実行します。- ページを開くか、
gcResourceTrackingを有効にした後に標準のuni.requestでネットワークリクエストを 1 回実行します。 - デバッグ環境で SDK の初期化とデータ同期のログが正常に出力されていることを確認します。
- コンソールに戻り、アプリに対応するプラットフォームの RUM データが表示されていることを確認します。