RUM 設定¶

RUM を取得する¶

標準 uni-app：

import { rum } from '@/uni_modules/GC-UniPlugin';

uni ミニプログラム：

import { rum } from '@/uni_modules/GC-JSPlugin';

uni ミニプログラムはホスト App が RUM の初期化を完了するため、rum.setConfig() を呼び出す必要はありません。本ページの自動コレクターと手動収集 API は、ホストの初期化完了後に使用できます。

RUM 初期化設定¶

rum.setConfig({
    androidAppId: 'YOUR_ANDROID_APP_ID',
    iOSAppId: 'YOUR_IOS_APP_ID',
    harmonyAppId: 'YOUR_HARMONY_APP_ID',
    errorMonitorType: 'all',
    deviceMonitorType: ['cpu', 'memory']
});

RUM ユーザーデータ追跡¶

Action¶

HarmonyOS でクリック、タップ、長押し、タブ切り替えの Action を自動収集する場合は、JS Action コレクターを明示的に起動する必要があります：

import { gcActionTracking } from '@/uni_modules/GC-JSPlugin';

gcActionTracking.startTracking();

Android、iOS の Native Action 自動収集は enableNativeUserAction で制御します。

API - startAction¶

RUM Action を起動します。

RUM は、この Action の間に発生する可能性のある Resource、Error、LongTask イベントをバインドします。0.1s 以内に複数回呼び出さないでください。同じ View には同時に 1 つの Action のみが関連付けられ、前の Action が終了していない場合、新しい Action は破棄されます。addAction とは相互に影響しません。

rum.startAction({
    actionName: 'action name',
    actionType: 'action type'
});

API - addAction¶

Action イベントを追加します。このデータは Error、Resource、LongTask に関連付けることができず、破棄ロジックはありません。

rum.addAction({
    actionName: 'action name',
    actionType: 'action type'
});

View¶

自動収集¶

gcViewTracking の使用を推奨します。これは、ページの onLoad、onReady、onShow、onHide、onUnload および App のフォアグラウンド/バックグラウンドイベントを統一的にリッスンし、ネイティブ RUM View API を自動的に呼び出します。

プロジェクトの main.js でできるだけ早く 1 回呼び出してください。Vue 2 ではルート Vue インスタンスを作成する前に呼び出します。Vue 3 では createSSRApp が返す app を渡す必要があります：

Vue 2¶

import App from './App';
import { gcViewTracking } from '@/uni_modules/GC-JSPlugin';
import Vue from 'vue';

gcViewTracking.startTracking();

const app = new Vue({
    ...App
});
app.$mount();

Vue 3¶

import App from './App';
import { gcViewTracking } from '@/uni_modules/GC-JSPlugin';
import { createSSRApp } from 'vue';

export function createApp() {
    const app = createSSRApp(App);
    gcViewTracking.startTracking(app);
    return { app };
}

収集ルール：

• ページが初めて表示されるとき、loading_time は onLoad から onReady までで計算され、単位はナノ秒です。
• コレクターの起動が遅すぎる、または完全なページライフサイクルを受信できなかった場合、信頼性をもって計算できないロード時間は -1 になります。ページが再表示されたとき、または App がフォアグラウンドに戻ったときは 0 になります。
• ページが非表示、アンロード、または App がバックグラウンドに入ると、現在の View は停止します。同じライフサイクル内での重複した onShow、resume は自動的に重複排除されます。
• ルーティングに失敗した場合、View は生成されません。同じルートの複数のページインスタンスは、それぞれ個別に状態を管理します。

互換収集方式¶

旧バージョンの mixin 方式は互換性のために残されています。新規プロジェクトでは gcViewTracking を優先的に使用し、2 つの自動収集方式を同時に有効にしないでください。重複した View が生成される可能性があります。

App.vue + 最初のページの組み合わせ設定は、SDK パッケージのサンプルプロジェクト Hbuilder_Example/App.vue および Hbuilder_Example/pages/index/index.vue を参照してください：

// step 1. GC-JSPlugin をプロジェクトの uni_modules に追加します
// step 2. App.vue に Router 監視を追加します
<script>
import { gcWatchRouter } from '@/uni_modules/GC-JSPlugin';
export default {
    mixins: [gcWatchRouter],
}
</script>

// step 3. 最初の page ページに pageMixin を追加します
<script>
import { gcPageMixin } from '@/uni_modules/GC-JSPlugin';
export default {
    mixins: [gcPageMixin],
}
</script>

指定したページのみを収集する場合は、SDK パッケージのサンプルプロジェクト Hbuilder_Example/pages/rum/index.vue を参照してください：

<script>
import { gcPageViewMixinOnly } from '@/uni_modules/GC-JSPlugin';
export default {
    mixins: [gcPageViewMixinOnly],
}
</script>

手動収集¶

rum.onCreateView({
    viewName: 'Current Page Name',
    loadTime: 100000000
});

rum.startView({
    viewName: 'Current Page Name'
});
rum.stopView();

API - onCreateView¶

ページロード時間のレコードを作成します。

API - startView¶

ページに入ります。

API - stopView¶

ページを離れます。

Error¶

自動収集¶

import { gcErrorTracking } from '@/uni_modules/GC-JSPlugin';

gcErrorTracking.startTracking();

手動収集¶

rum.addError({
    message: 'Error message',
    stack: 'Error stack'
});

API - addError¶

Resource¶

自動収集¶

0.3.0 以降は gcResourceTracking の使用を推奨します。これは、Android、iOS、HarmonyOS の標準の uni.request をインターセプトし、リクエストの成功または失敗によって生成された RUM Resource を自動的に収集します。Trace がすでに初期化されている場合は、設定されたリンクタイプに基づいて Trace Header を生成し、リクエストヘッダーに追加します。enableLinkRUMData を有効にすると、RUM Resource と Trace を関連付けることができます。ビジネスコードで既に設定されている同名のリクエストヘッダーは上書きされません。

リクエストを発行する前に startTracking を 1 回呼び出し、その後は引き続き uni.request を直接使用してください：

import { gcResourceTracking } from '@/uni_modules/GC-JSPlugin';

gcResourceTracking.startTracking();

uni.request({
    url: requestUrl,
    method: method,
    header: header,
    timeout: 30000,
    success(res) {
        console.log('success:' + JSON.stringify(res));
    },
    fail(err) {
        console.log('fail:' + JSON.stringify(err));
    },
    complete() {
        console.log('complete');
    }
});

startTracking 設定：

// iOS で rum.setConfig({ enableNativeUserResource: true }) によりネイティブ収集がすでに有効になっている場合：
gcResourceTracking.startTracking({
    enableIOS: false
});

使用上の注意：

• App Android、App iOS、App HarmonyOS をサポートします。アプリケーションの起動段階で、最初の uni.request 呼び出しの前に実行する必要があります。
• startTracking は 1 回だけ呼び出す必要があります。繰り返し呼び出してもインターセプターが重複してインストールされることはありません。
• Trace がすでに初期化されている場合、リクエストには自動的に Trace Header が追加されます。ビジネスコードで明示的に設定された同名のリクエストヘッダーが優先されます。
• 既存の success、fail、complete コールバックは変更されません。
• gcRequest.request は 0.2.7 以降、非推奨の互換 API としてのみ保持されます。グローバルコレクターを有効にした後は uni.request を置き換える必要はなく、2 つの収集方式を並行して使用しないでください。

gcRequest.request の旧設定は、まだ移行していないプロジェクトの参考としてのみ提供されます：

手動収集¶

startResource、stopResource、addResource を手動で呼び出して実装します。GCResourceTracking.js を参照してください。

API - startResource¶

API - stopResource¶

API - addResource¶

content object¶