Changelog¶

0.1.0-alpha.7¶

Improvements¶

• Replay image size and capture frequency: Replace the rolling per-minute budget and adaptive frame-rate reduction with a per-frame size limit that covers the first frames of new Views and orientation changes. The capture interval now includes processing time, and display coordinates are preserved after image scaling.
• Integration examples and documentation: Unify the Creator 2/3 interactive game examples, add Replay API and Android real-device traffic references, and add Android 16 KB page-alignment configuration and an inspection tool to the Creator 3 example.

Fixes¶

• Creator 3 camera: Use a separate offscreen Camera to capture frames so the displayed view and Camera-dependent input coordinates are not affected.
• Creator 3 touch: Record Replay touches consumed by UI controls while preserving normal input dispatch and avoiding duplicate recording.

Upgrade Notes¶

The two npm packages must be upgraded together; re-run the installer with --replay and rebuild the native project. Remove imagePolicy.maxBytesPerMinute and imagePolicy.adaptiveCapture, and use frame capture frequency, image size, and per-frame size limits instead. A per-frame limit is not equivalent to a rolling traffic quota. For details, see Upgrade to alpha.7.

0.1.0-alpha.6¶

New Features¶

• Standalone Replay package: Split Session Replay into an optional @cloudcare/cocos-session-replay package that provides Creator 2/3 entry points, a node privacy component, and the native Bridge. The base package no longer includes Replay.
• Composition API: Provide Replay configuration, start/stop control, privacy, and camera selection through withSessionReplay(baseSdk), and add a public plugin API to the base package.

Improvements¶

• Installation and publishing: Support the --replay / --no-replay native integration switches and preserve the markers of managed resources. The two npm packages use exactly matching versions and support publish validation and resumable publishing.

Upgrade Notes¶

When upgrading from the all-in-one package, install both packages at the same version, complete the composition before start() / attach(), move the Replay type imports to the standalone package, and call setReplayCamera() on the composed instance. Re-run the installer and build the native project. See Package Split Migration.

0.1.0-alpha.5¶

New Features¶

• iOS Swift Package Manager integration: Creator 2, Creator 3, and Hybrid native hosts support selecting CocoaPods or SPM through project configuration, with CocoaPods remaining the default. The installer preserves the existing selection and restores SPM references after CMake regeneration in Creator 3.

Improvements¶

• Native network SDK dependencies: Upgrade the Android Agent to 1.7.6-alpha03, the Gradle Plugin in the Hybrid example to 1.3.9-alpha01, and the iOS Agent and Session Replay used by CocoaPods and SPM to 1.6.8-alpha.5. The new iOS version supports enabling NSURLConnection Resource collection and trace correlation through separate switches; both new switches are disabled by default.
• Network verification examples: Add examples for Creator 2 Android engine HTTP requests and optionally enabled iOS NSURLConnection requests, explaining how to verify the Resources actually uploaded and how to avoid overlap between JS automatic collection or manual instrumentation and native collection.
• Creator 3 Replay example: Add a native 3D validation scene with camera, motion, and standalone HUD controls for inspecting frame capture behavior and the current single-camera collection limitation.

For the network collection switches and how to avoid duplicate collection, see Android Network Collection Recommendations and iOS Network Collection Recommendations. For SPM integration steps, see iOS Native Build.

0.1.0-alpha.4¶

New Features¶

• Session Replay privacy component: Add a ReplayPrivacy editor component for Creator 2 and Creator 3 that masks or hides nodes and prefabs in captured replay frames. The installer copies the component to the project's assets directory; code-based override rules take precedence, and text inputs remain masked by default.

Improvements¶

• Session Replay frame capture performance: Move replay file I/O and native image encoding on Android and iOS off the game thread. After updating the SDK, rebuild the native project to include the asynchronous Bridge.
• Hybrid privacy example: Add privacy component examples and mask alignment test controls to the maintained Creator 2 and Creator 3 Hybrid examples.

Fixes¶

• Android Session Replay playback: Upgrade ft-session-replay:0.1.9-alpha02 to 0.1.9-alpha03 in the native dependency installer so that segment compression is consistent with the Browser SDK format, restoring playback of affected multi-segment sessions. Validated with the artifact published to Maven, comparing the old version, the new version, and a return to the old version across native pages and Cocos pages.

0.1.0-alpha.3¶

Improvements¶

• Android SDK dependencies: In the native dependency installer for Creator 2 and Creator 3, upgrade the Android Agent SDK from 1.7.6-alpha01 to 1.7.6-alpha02 and Session Replay from 0.1.9-alpha01 to 0.1.9-alpha02.
• Hybrid integration examples: Keep one minimal Hybrid integration project for each Creator generation. Remove the old diagnostic project, copied SDK installation directories, and the replay traffic benchmark tool from the maintained examples.
• SDK and example messaging: Remove unnecessary brand names and simplify SDK error messages and example copy.

Fixes¶

• npm publishing: Check the package metadata before publishing to detect whether the version already exists and verify its publish tag. Publish the latest prerelease to the latest tag until the first stable version is released.

0.1.0-alpha.2¶

Fixes¶

• Session Replay privacy masking: Fix the issue in Creator 2 and Creator 3 where text input and custom node masks become misaligned when the Camera projection changes the position or size of controls in captured frames. If a privacy boundary cannot be reliably projected, skip that frame to avoid capturing frames with incorrectly positioned masks.

0.1.0-alpha.1¶

Released from commit 2bbeeb86270b666e5eeddc6f220586df66f10362.

This first prerelease provides Real User Monitoring (RUM), logs, Distributed Tracing, and experimental Session Replay for Cocos Creator applications running on the Android and iOS native platforms.

New Features¶

• RUM automatic collection and manual instrumentation: Collect scene switches, touch interactions, and runtime-supported JavaScript errors and unhandled Promise rejections on demand. Supports manually recording Views, Actions, Errors, Long Tasks, and network Resources to monitor critical business flows. Native crash, Android ANR, UI jank, and device performance monitoring are configurable.
• Log Collection: Supports reporting custom logs and optional collection of Console output. Log level filtering, sampling, and cache policies are configurable, and logs are associated with the current RUM session to troubleshoot issues together with user behavior.
• Network monitoring and trace correlation: Automatically collect basic request and response information and total duration for fetch and XMLHttpRequest provided by the runtime, and inject a Trace Header. Manual Resource instrumentation and Trace Header generation are supported for custom network integrations. DNS, TCP, and SSL per-phase durations require manual instrumentation.
• Session Replay (experimental): Capture the Cocos screen and associate it with the RUM session. Sampling, additional sampling for error sessions, frame capture frequency, and image size are configurable. Supports masking and hiding nodes; text inputs are masked and touch positions are hidden by default.
• Replay quality and traffic control: Quality presets, per-frame size limits, and rolling-window image data budgets are configurable. Adaptive capture adjusts frame capture frequency, quality, and size based on budget usage, helping balance replay detail against data usage.
• Native host Hybrid integration: Reuse the SDK already initialized in the native application that embeds Cocos. Integrate with guanceSdk.attach(), and use guanceSdk.enterCocos() and guanceSdk.leaveCocos() to manage the Cocos collection lifecycle, avoiding duplicate initialization of the host SDK.
• User and business context: Supports binding and unbinding users and adding global and event-level custom attributes to filter monitoring data by user, environment, and business context. Supports reporting via DataKit or DataWay.
• Project installation tool: Provides an npm package with separate Creator 2 and Creator 3 entry points, installation commands, and build extensions to help configure the Android and iOS native Bridge and dependencies.

Integration Requirements¶

• Supports Cocos Creator 2.4.5–2.4.15 and 3.6.3–3.8.x; versions 3.0–3.6.2 are supported on a best-effort basis.
• Requires Android API 21+ or iOS 12+. Web, mini-game, and desktop targets are not currently supported.
• Standalone Cocos applications are initialized with guanceSdk.start(). Hybrid applications initialize the SDK in the native host first and then call guanceSdk.attach(). The two initialization methods are mutually exclusive.
• Configure RUM, logs, Distributed Tracing, Session Replay, and automatic collection as needed. After generating the iOS native project, run pod install to install the dependencies.