빠른 시작¶
이 문서는 Cocos Creator SDK의 최단 연동 경로를 제공하여 RUM, Log, Trace 데이터 업로드를 검증 가능한 방식으로 완료할 수 있도록 돕습니다.
이 페이지의 예시는 현재 SDK 버전 조합을 사용합니다.
사전 준비¶
- 실제 사용자 모니터링(RUM)에서 Android와 iOS 앱을 각각 생성하고 앱 ID 2개를 확보합니다.
-
다음 중 하나의 업로드 방식을 준비합니다.
-
로컬 환경 배포:
datakitUrl준비. -
공용망 DataWay:
datawayUrl및clientToken준비. -
@cloudcare/cocos-sdk를 설치하고 프로젝트 설치 프로그램을 실행합니다. 자세한 단계는 앱 연동을 참조하세요. - Cocos Creator를 다시 열고 Android 또는 iOS 네이티브 프로젝트를 생성합니다.
- CocoaPods를 사용하는 iOS 프로젝트에서는
Podfile이 있는 디렉터리에서pod install을 실행한 후.xcworkspace를 엽니다. SPM 사용 시 iOS 네이티브 빌드에 따라 구성한 후 컴파일하면 새 프로젝트에 Pods를 설치할 필요가 없습니다.
아래 최소 예시는 기본 패키지만 사용합니다. 세션 리플레이가 필요하면 Replay 설치 파라미터에 따라 별도 패키지를 설치하고 --replay를 실행한 다음, 결합된 SDK 인스턴스로 초기화하세요.
최소 초기화¶
아래 예시는 Creator 3를 사용합니다. Creator 2에서는 import 경로를 @cloudcare/cocos-sdk/creator2로만 변경하면 됩니다.
import { guanceSdk } from '@cloudcare/cocos-sdk/creator3';
export function startObservability(): void {
guanceSdk.start({
sdk: {
datakitUrl: 'https://your-datakit.example.com',
serviceName: 'cocos-game',
env: 'prod',
debug: true,
},
rum: {
androidAppId: 'android-rum-app-id',
iosAppId: 'ios-rum-app-id',
sampleRate: 1,
},
logger: {
enableCustomLog: true,
enableLinkRumData: true,
sampleRate: 1,
},
trace: {
traceType: 'ddTrace',
enableLinkRumData: true,
sampleRate: 1,
},
autoTrack: {
scenes: true,
actions: true,
errors: true,
network: true,
},
});
}
첫 번째로 데이터 수집이 필요한 씬이 로드되기 전에 startObservability()를 호출하고, 전체 앱 수명 주기 동안 한 번만 초기화되도록 하십시오.
앱의 메인이 Android/iOS 네이티브 페이지이고 하나 또는 소수의 페이지만 Cocos를 사용하는 경우 guanceSdk.start()를 다시 호출하지 마십시오. 이 경우 네이티브 호스트가 SDK 초기화를 한 번 수행하고 Cocos는 attach()로 연결해야 합니다. 자세한 내용은 네이티브와 Cocos 혼합 개발을 참조하세요.
공용망 DataWay를 사용하는 경우 sdk를 다음과 같이 변경합니다.
sdk: {
datawayUrl: 'https://open.dataway.url',
clientToken: 'client-token',
serviceName: 'cocos-game',
env: 'prod',
debug: true,
},
datakitUrl과 datawayUrl 중 하나만 선택합니다. datawayUrl을 사용할 때는 반드시 clientToken도 함께 전달해야 합니다.
사용자 지정 로그 출력¶
초기화 후 다음을 호출합니다.
연동 검증¶
- Android 또는 iOS 네이티브 빌드로 앱을 실행합니다. 브라우저 미리보기에서는 데이터가 업로드되지 않습니다.
- 씬을 전환하고 터치 동작을 한 번 트리거한 다음 네트워크 요청을 실행합니다.
- Cocos 콘솔과 네이티브 로그에 초기화 또는 Bridge 오류가 있는지 확인합니다.
- RUM > 탐색기로 이동하여 해당 Android 또는 iOS 앱을 선택합니다.
- View, Action 또는 Resource 데이터가 존재하는지 확인하고 로그 탐색기에서 사용자 지정 로그를 확인합니다.
- 검증이 완료되면 프로덕션 환경에서
debug를 비활성화합니다.
다음 단계¶
- 기본 파라미터 및 사용자 바인딩: SDK 초기화
- RUM 및 자동 수집: RUM 구성
- 로그: Log 구성
- 분산 추적: Trace 구성
- 세션 리플레이: Cocos Creator 세션 리플레이(실험적)
- 네이티브 앱에서 Cocos 부분 사용: 네이티브와 Cocos 혼합 개발
- 수동 수집: RUM 수동 계측
- 데이터 없음 또는 빌드 실패: 문제 해결