RUM 設定¶

RUM 初期化設定¶

var rum = uni.requireNativePlugin("GCUniPlugin-RUM");
rum.setConfig({
    androidAppId: 'YOUR_ANDROID_APP_ID',
    iOSAppId: 'YOUR_IOS_APP_ID',
    errorMonitorType: 'all',
    deviceMonitorType: ['cpu', 'memory']
});

RUM ユーザーデータ追跡¶

var rum = uni.requireNativePlugin("GCUniPlugin-RUM");

Action¶

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 を優先して使用し、両方の自動収集方式を同時に有効にしないでください。重複した View が生成される可能性があります。

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

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

// 手順 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¶

自動収集¶

SDK 0.2.7 以上では gcResourceTracking の使用を推奨します。標準の uni.request にグローバルインターセプターをインストールし、Resource 識別子を自動生成し、Trace 設定に準拠したリクエストヘッダーを注入し、リクエストの成功または失敗によって生成される RUM Resource を収集します。

リクエストを開始する前に 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 のみ対応。アプリケーション起動時、最初の uni.request 呼び出し前に実行する必要があります。
• startTracking は 1 回のみ呼び出す必要があります。複数回呼び出してもインターセプターは再インストールされません。
• Trace が設定されている場合、Trace 許可リストに一致するリクエストには Trace Header が注入されます。ビジネスコードで明示的に設定された同名のリクエストヘッダーが優先されます。
• 既存の success、fail、complete コールバックは変更されません。
• gcRequest.request は 0.2.7 以降、非推奨の互換 API としてのみ維持されます。グローバルコレクターを有効にした後は uni.request を置き換える必要はなく、両方の収集方法を並行して使用しないでください。

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

手動収集¶

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

API - startResource¶

API - stopResource¶

API - addResource¶

content object¶