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에서 클릭, Tap, 길게 누르기 및 Tab 전환 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는 동시에 하나의 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에서 가능한 한 빨리 한 번 호출하십시오. 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를 참조하십시오:

// 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을 한 번 호출한 후, 계속해서 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은 한 번만 호출해야 하며, 반복 호출해도 인터셉터가 중복 설치되지 않습니다.
• Trace가 초기화된 경우 요청에 자동으로 Trace Header가 추가됩니다. 비즈니스 코드에서 명시적으로 설정한 동일한 이름의 요청 헤더가 우선합니다.
• 기존 success, fail, complete 콜백은 그대로 유지됩니다.
• gcRequest.request는 0.2.7부터 폐기된 호환 API로만 유지됩니다. 전역 수집기를 활성화한 후에는 uni.request를 대체할 필요가 없으며, 두 가지 수집 방식을 병렬로 사용하지 마십시오.

gcRequest.request의 이전 설정은 아직 마이그레이션되지 않은 프로젝트에서만 참조하십시오:

수동 수집¶

startResource, stopResource, addResource를 수동으로 호출하여 직접 구현할 수 있습니다. GCResourceTracking.js를 참조하십시오.

API - startResource¶

API - stopResource¶

API - addResource¶

content object¶