クイックスタート¶
本ドキュメントは 0.3.0 以降の最短の導入パスを提供します。完全なインストールとホスト連携の説明については、アプリ連携 を参照してください。
通常の uni-app¶
1. モジュールのインストール¶
同一バージョンのリリースパッケージから以下のディレクトリをプロジェクトにコピーします。バージョンは 0.3.0 以上である必要があります。
nativeplugins/GCUniPlugin はインストールしません。
2. Bridge のロードと API のインポート¶
アプリケーションのエントリで setup.js を 1 回ロードします。
import '@/uni_modules/GC-UniPlugin/setup.js';
import {
mobileAgent,
rum,
logger,
tracer
} from '@/uni_modules/GC-UniPlugin';
import {
gcErrorTracking,
gcViewTracking,
gcResourceTracking
} from '@/uni_modules/GC-JSPlugin';
3. 初期化¶
mobileAgent.sdkConfig({
datakitUrl: 'YOUR_DATAKIT_URL',
debug: true,
env: 'prod'
});
rum.setConfig({
androidAppId: 'YOUR_ANDROID_APP_ID',
iOSAppId: 'YOUR_IOS_APP_ID',
harmonyAppId: 'YOUR_HARMONY_APP_ID'
});
logger.setConfig({
enableCustomLog: true,
enableLinkRumData: true
});
tracer.setConfig({
traceType: 'ddTrace',
enableLinkRUMData: true
});
gcErrorTracking.startTracking();
gcResourceTracking.startTracking();
実際にリリースするプラットフォームに対応する RUM App ID のみを入力してください。パブリック DataWay を使用する場合は、datakitUrl を datawayUrl と clientToken に置き換えます。
4. View の自動収集を有効化¶
Vue 2 の場合は、ルートインスタンスを作成する前に呼び出す必要があります。
Vue 3 の場合は、createSSRApp() が返すアプリケーションインスタンスを渡す必要があります。
import App from './App';
import { createSSRApp } from 'vue';
export function createApp() {
const app = createSSRApp(App);
gcViewTracking.startTracking(app);
return { app };
}
初期化の順序は以下のようにすることを推奨します。
mobileAgent.sdkConfig
-> rum.setConfig
-> logger.setConfig / tracer.setConfig
-> GC-UniSessionReplay.setConfig（オプション）
-> gcErrorTracking / gcResourceTracking / gcActionTracking
-> gcViewTracking
ホストアプリ + uni ミニアプリ¶
uni ミニアプリプロジェクトでは GC-JSPlugin のみをインストールします。
import {
mobileAgent,
rum,
logger,
tracer,
gcErrorTracking,
gcViewTracking,
gcResourceTracking
} from '@/uni_modules/GC-JSPlugin';
Native SDK、RUM、Log、Trace は、uni ミニアプリを開く前にホストアプリによって初期化されます。uni ミニアプリは JS コレクターの起動とランタイム API の呼び出しのみを行います。例：
mobileAgent.bindRUMUserData({
userId: 'USER_ID'
});
mobileAgent.appendBridgeContext({
wgt_id: 'YOUR_WGT_ID'
});
gcErrorTracking.startTracking();
gcResourceTracking.startTracking();
iOS ホストがすでに Native Resource の自動収集を有効にしている場合は、重複収集を避けるために gcResourceTracking.startTracking({ enableIOS: false }) を呼び出してください。
ホストアプリに対応するモジュールが登録されていない場合、これらの呼び出しは安全に空操作にフォールバックされるため、通常のベースアプリで uni ミニアプリページをデバッグするのに便利です。ネイティブのトレースは、ホスト拡張を統合したホストアプリで検証する必要があります。