Changelog¶

0.1.0-alpha.7¶

Enhancements¶

• Replay image size and capture frequency: Replaced the rolling minute budget and adaptive downsampling with a per-frame size limit. The limit covers the first frames of new Views and orientation changes. The capture period includes processing time, and display coordinates are retained after image scaling.
• Integration examples and instructions: Unified the Creator 2/3 interactive game examples, added Replay API and Android real-device traffic references; the Creator 3 example adds Android 16 KB page alignment configuration and checking tools.

Bug Fixes¶

• Creator 3 camera: Uses a separate offscreen Camera to capture frames, avoiding impact on the displayed rendering and input coordinates that depend on the Camera.
• Creator 3 touch: Records Replay touches consumed by UI controls while preserving normal input dispatch and avoiding duplicate recording.

Upgrade Notes¶

The two npm packages must be upgraded in lockstep. Re-run the installer with --replay and rebuild the native project. Delete imagePolicy.maxBytesPerMinute and imagePolicy.adaptiveCapture; use capture frequency, image size, and per-frame size limit instead. The per-frame limit is not equivalent to a rolling traffic quota. 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, providing Creator 2/3 entry points, node privacy components, and the native Bridge. The base package no longer includes Replay.
• Composition API: Provides Replay configuration, start/stop, privacy, and camera selection through withSessionReplay(baseSdk), and adds a public plugin API to the base package.

Enhancements¶

• Installation and publishing: Supports the --replay / --no-replay native integration switch and preserves markers for managed resources. The two npm packages use identical versions and support publish validation and resuming interrupted publishes.

Upgrade Notes¶

When upgrading from the all-in-one package, install both packages of the same version, complete the composition before start() / attach(), move Replay type imports to the standalone package, and call setReplayCamera() through the composed instance. Re-run the installer and build the native project. See Package 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; CocoaPods remains the default. The installer preserves the existing selection and restores SPM references after CMake regeneration in Creator 3.

Enhancements¶

• Native network SDK dependencies: Upgraded the Android Agent to 1.7.6-alpha03 and the Hybrid example's Gradle Plugin to 1.3.9-alpha01; the iOS Agent and Session Replay used by CocoaPods and SPM were upgraded to 1.6.8-alpha.5. The new iOS version supports enabling NSURLConnection Resource collection and Trace correlation through independent switches; both new switches are disabled by default.
• Network verification examples: Added a Creator 2 Android engine HTTP request example and an optional iOS NSURLConnection request example, illustrating how to verify the Resources actually uploaded and avoid overlap between JS automatic collection or manual instrumentation and native collection.
• Creator 3 Replay example: Added a native 3D verification scenario with camera, movement, and standalone HUD controls for checking frame capture behavior and the current single-camera capture limitation.

Network collection switches and ways to avoid duplicate collection are described in Android network collection recommendations and iOS network collection recommendations. SPM integration steps are described in iOS native build.

0.1.0-alpha.4¶

New Features¶

• Session Replay privacy component: Added the ReplayPrivacy editor component for Creator 2 and Creator 3 to mask or hide nodes and prefabs in captured replay frames. The installer copies the component to the project assets directory; code override rules take precedence, and input fields are still masked by default.

Enhancements¶

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

Bug Fixes¶

• Android Session Replay playback: Upgraded ft-session-replay:0.1.9-alpha02 to 0.1.9-alpha03 in the native dependency installer to make segment compression consistent with the Browser SDK format and restore playback of affected multi-segment sessions. Verified using the artifacts published to Maven, by switching between the old version, the new version, and back to the old version across native pages and Cocos pages.

0.1.0-alpha.3¶

Enhancements¶

• Android SDK dependencies: In the native dependency installers for Creator 2 and Creator 3, upgraded 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: Kept one minimal Hybrid integration project for each Creator generation. Removed old diagnostic projects, copied SDK installation directories, and replay traffic benchmark tools from the maintained examples.
• SDK and example wording: Removed unnecessary brand names and simplified SDK error messages and example copy.

Bug Fixes¶

• npm publishing: Check package metadata before publishing to detect whether the version already exists and verify its release identifier. Before the first stable release is published, the latest prerelease version is published to the latest tag.

0.1.0-alpha.2¶

Bug Fixes¶

• Session Replay privacy mask: Fixed the issue in Creator 2 and Creator 3 where input box and custom node masks were misaligned when Camera projection changed the position or size of controls in captured frames. If privacy boundaries cannot be reliably projected, the frame is skipped to avoid capturing frames with incorrectly positioned masks.

0.1.0-alpha.1¶

New Features¶

• RUM automatic collection and manual instrumentation: Supports on-demand collection of scene switches, touch interactions, and JavaScript errors and unhandled Promise rejections supported by the runtime. Supports manually recording Views, Actions, Errors, Long Tasks, and network Resources to monitor critical business flows. Configurable native crashes, Android ANR, UI jank, and device performance monitoring.
• Log collection: Supports reporting custom logs and on-demand collection of Console output. Configurable log-level filtering, sampling, and caching policies, with association to the current RUM session to troubleshoot issues alongside user behavior.
• Network monitoring and trace correlation: Automatically collects basic request and response information and total duration for fetch and XMLHttpRequest available in the runtime, and injects Trace Headers. Supports manual Resource instrumentation and Trace Header generation for custom network integrations. Phased DNS, TCP, and SSL timings require manual instrumentation.
• Session Replay (experimental): Captures Cocos frames and associates them with RUM sessions. Configurable sampling, extra sampling for error sessions, capture frequency, and image size. Supports masking and hiding nodes; masks input fields and hides touch positions by default.
• Replay quality and traffic control: Configurable quality presets, per-frame size limits, and rolling-window image data budget. Adaptive capture adjusts capture frequency, quality, and size based on budget usage, helping balance replay detail and data usage.
• Hybrid integration in native hosts: Reuses the SDK already initialized by the native application that embeds Cocos. Integrate via guanceSdk.attach(), and use guanceSdk.enterCocos() and guanceSdk.leaveCocos() to manage the Cocos collection lifecycle, avoiding reinitializing 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 through DataKit or DataWay.
• Project installation tooling: Provides an npm package with standalone Creator 2 and Creator 3 entry points, installation commands, and build extensions to assist in configuring 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; 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 currently not supported.
• Standalone Cocos apps are initialized with guanceSdk.start(). Hybrid apps initialize the SDK in the native host first, 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 dependencies.