Changelog¶

0.1.0-alpha.5¶

Added¶

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

Improved¶

• Native network SDK dependencies: Upgraded Android Agent to 1.7.6-alpha03, Hybrid sample Gradle Plugin 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: Added examples for Creator 2 Android engine HTTP requests and optionally enabled iOS NSURLConnection requests, showing 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 scene with camera, movement, and standalone HUD controls to check frame capture behavior and the current single-camera collection limitation.

For 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¶

Added¶

• Session Replay privacy components: Added a 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's asset directory; code override rules take precedence, and input boxes remain masked by default.

Improved¶

• Session Replay frame capture performance: Moved replay file read/write and native image encoding on Android and iOS out of the game thread. After updating the SDK, the native project must be rebuilt 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.

Fixed¶

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

0.1.0-alpha.3¶

Improved¶

• Android SDK dependencies: In the native dependency installer for Creator 2 and Creator 3, upgraded 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. Removed old diagnostic projects, copied SDK installation directories, and replay traffic benchmark tools from the maintained examples.
• SDK and example messaging: Removed unnecessary brand names and simplified SDK error messages and sample copy.

Fixed¶

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

0.1.0-alpha.2¶

Fixed¶

• Session Replay privacy masking: Fixed misalignment of input box and custom node masks in Creator 2 and Creator 3 when Camera projection changes the position or size of controls in captured frames. If the privacy boundary cannot be reliably projected, that frame is skipped to avoid capturing frames with incorrectly positioned masks.

0.1.0-alpha.1¶

Based on commit 2bbeeb86270b666e5eeddc6f220586df66f10362.

First prerelease providing Real User Monitoring (RUM), logs, distributed tracing, and experimental Session Replay for Cocos Creator applications running on Android and iOS native platforms.

Added¶

• RUM automatic collection and manual instrumentation: Collects scene switches, touch interactions, and JavaScript errors and unhandled Promise rejections supported by the runtime as needed. Supports manually recording View, Action, Error, Long Task, and network Resource to monitor key business processes. Configurable native crash, 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 strategies, 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 provided by the runtime, and injects trace headers. Supports manual Resource instrumentation and trace header generation for custom network integration. DNS, TCP, and SSL phased durations require manual instrumentation.
• Session Replay (experimental): Captures Cocos frames and correlates them with RUM sessions. Supports configuring sampling, additional sampling for error sessions, frame capture frequency, and image size. Supports masking and hiding nodes; masks input boxes and hides touch locations by default.
• Replay quality and traffic control: Configurable quality presets, per-frame size limits, and rolling-window image data budget. Adaptive capture adjusts frame capture frequency, quality, and size based on budget usage to help balance replay detail and data usage.
• Native Host Hybrid integration: Reuses an SDK already initialized in a native application that embeds Cocos. Integrate via guanceSdk.attach(), and manage the Cocos collection lifecycle with guanceSdk.enterCocos() and guanceSdk.leaveCocos() to avoid 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 tool: Provides an npm package with separate 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 not currently supported.
• Standalone Cocos apps initialize with guanceSdk.start(). Hybrid apps first initialize the SDK in the native host, then call guanceSdk.attach(). The two initialization methods are mutually exclusive.
• Configure RUM, logs, tracing, Session Replay, and automatic collection as needed. After generating the iOS native project, run pod install to install dependencies.