@coralogix/browser 2.8.8 → 2.9.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 2.9.0 (2025-08-18)
+
+### 🚀 Features
+
+- **fingerprint:** Added user fingerprint. The fingerprint is generated and stored on each user’s machine for reuse, and will be used to calculate the unique users count.
+
+## 2.8.9 (2025-07-24)
+
+### 🩹 Fixes
+
+- **sdk:** improve SDK shutdown handling
+
 ## 2.8.8 (2025-07-20)
 
 ### 🩹 Fixes

package/README.md

@@ -420,6 +420,12 @@ CoralogixRum.init({
 });
 ```
 
+### Unique Users
+
+Starting with version `2.9.0`, the SDK calculates unique users based on the user’s `fingerprint`.<br>
+The fingerprint is generated and stored on each user’s machine for reuse.<br>
+In earlier versions, the SDK used user_id to calculate unique users, which is still supported for backward compatibility.<br>
+
 ### Network Extra Configuration
 
 The `networkExtraConfig` property is an array of configuration objects, each specifying custom rules for capturing network requests and responses. This feature collects data from `Fetch` and `XMLHttpRequest` calls, attaching specified request and response information, headers, and payloads to each network event.

package/index.esm2.js

@@ -1058,6 +1058,7 @@ var CoralogixFetchInstrumentation = (function (_super) {
             });
         });
     };
+    CoralogixFetchInstrumentation.prototype.disable = function () { };
     return CoralogixFetchInstrumentation;
 }(FetchInstrumentation));
 
@@ -1112,6 +1113,7 @@ var CoralogixXhrInstrumentation = (function (_super) {
                 Object.fromEntries(sanitizedHeaders);
         }
     };
+    CoralogixXhrInstrumentation.prototype.disable = function () { };
     return CoralogixXhrInstrumentation;
 }(XMLHttpRequestInstrumentation));
 
@@ -2455,6 +2457,7 @@ var MASK_INPUT_TYPES_DEFAULT = [
     'email',
     'tel',
 ];
+var FINGER_PRINT_KEY = 'cx-fingerprint';
 var idPatterns = [
     {
         pattern: new RegExp(UUID_REGEX),
@@ -3672,6 +3675,13 @@ var SessionManager = (function (_super) {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(SessionManager.prototype, "fingerPrint", {
+        get: function () {
+            return this._fingerPrint;
+        },
+        enumerable: false,
+        configurable: true
+    });
     SessionManager.prototype.updateCurrentPage = function (fragment) {
         if (this.isIdleActive) {
             this._currentPageFragment = undefined;
@@ -3690,6 +3700,7 @@ var SessionManager = (function (_super) {
         this.startIdleListener();
         this.clearPrevSession();
         this.setSession();
+        this.setFingerPrint();
     };
     SessionManager.prototype.stop = function () {
         this.stopIdleListener();
@@ -3777,6 +3788,17 @@ var SessionManager = (function (_super) {
             sessionExpirationDate: now + SESSION_EXPIRATION_TIME,
         };
     };
+    SessionManager.prototype.setFingerPrint = function () {
+        var generateFingerPrint = function () { return generateUUID(); };
+        var storedFingerPrint = CxGlobal.localStorage.getItem(FINGER_PRINT_KEY);
+        if (storedFingerPrint) {
+            this._fingerPrint = storedFingerPrint;
+            return;
+        }
+        var newFingerPrint = generateFingerPrint();
+        CxGlobal.localStorage.setItem(FINGER_PRINT_KEY, newFingerPrint);
+        this._fingerPrint = newFingerPrint;
+    };
     return SessionManager;
 }(SessionIdle));
 
@@ -3933,7 +3955,7 @@ function resolveUrlBlueprinters(urlBlueprinters) {
     return resolvedUrlBlueprinters;
 }
 
-var SDK_VERSION = '2.8.8';
+var SDK_VERSION = '2.9.0';
 
 function shouldDropEvent(cxRumEvent, options) {
     if (isDocumentErrorWithoutMessage(cxRumEvent)) {
@@ -4048,6 +4070,7 @@ var CoralogixSpanMapProcessor = (function () {
         var eventTypeContext = this._getEventTypeContext(attributes, eventType, span);
         var _e = span.spanContext(), spanId = _e.spanId, traceId = _e.traceId;
         var resourceAttributes = __assign(__assign({}, (_a = span.resource) === null || _a === void 0 ? void 0 : _a.attributes), { 'service.name': application });
+        var fingerPrint = getSessionManager().fingerPrint;
         var labels = JSON.parse(attributes[CoralogixAttributes.CUSTOM_LABELS]);
         var isErrorWithStacktrace = !!((_b = eventTypeContext === null || eventTypeContext === void 0 ? void 0 : eventTypeContext.error_context) === null || _b === void 0 ? void 0 : _b.original_stacktrace);
         var version_metadata = {
@@ -4068,7 +4091,7 @@ var CoralogixSpanMapProcessor = (function () {
             severity: severity,
             timestamp: timestamp,
             text: {
-                cx_rum: __assign(__assign({ platform: 'browser', timestamp: timestamp }, eventTypeContext), { browser_sdk: {
+                cx_rum: __assign(__assign({ fingerPrint: fingerPrint, platform: 'browser', timestamp: timestamp }, eventTypeContext), { browser_sdk: {
                         version: SDK_VERSION,
                     }, version_metadata: version_metadata, session_context: __assign(__assign(__assign(__assign({}, user_context), { session_id: sessionId, session_creation_date: sessionCreationDate, prev_session: prevSessionId
                             ? {
@@ -4451,8 +4474,10 @@ var CoralogixRum = {
         var _a, _b;
         var _this = this;
         try {
-            if (isInited && (options === null || options === void 0 ? void 0 : options.debug)) {
-                console.debug('CoralogixRum already initialized, skipping init');
+            if (isInited) {
+                if (options === null || options === void 0 ? void 0 : options.debug) {
+                    console.debug('CoralogixRum already initialized, skipping init');
+                }
                 return;
             }
             if (!CxGlobal.sessionStorage) {
@@ -4656,7 +4681,7 @@ var CoralogixRum = {
         };
     },
     shutdown: function () {
-        var _a;
+        var _a, _b;
         if (!isInited) {
             return;
         }
@@ -4670,6 +4695,9 @@ var CoralogixRum = {
         snapshotProcessor === null || snapshotProcessor === void 0 ? void 0 : snapshotProcessor.shutdown();
         exporter === null || exporter === void 0 ? void 0 : exporter.shutdown();
         isInited = false;
+        if ((_b = getSdkConfig()) === null || _b === void 0 ? void 0 : _b.debug) {
+            console.debug('Coralogix Browser SDK - shutdown has completed');
+        }
     },
     setApplicationContext: function (applicationContext) {
         var _a;
@@ -4716,6 +4744,13 @@ var CoralogixRum = {
         (_a = getSessionRecorder()) === null || _a === void 0 ? void 0 : _a.stopRecording();
     },
     startSessionRecording: function () {
+        var _a;
+        if (!isInited) {
+            if ((_a = getSdkConfig()) === null || _a === void 0 ? void 0 : _a.debug) {
+                console.debug('Coralogix Browser SDK - CoralogixRum must be initiated before starting session recording');
+            }
+            return;
+        }
         if (getSessionRecorder()) {
             getSessionRecorder().startRecording();
             return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coralogix/browser",
-  "version": "2.8.8",
+  "version": "2.9.0",
   "description": "Official Coralogix SDK for browsers",
   "license": "Apache-2.0",
   "author": "Coralogix",

package/src/constants.d.ts

@@ -18,6 +18,7 @@ export declare const RUM_INTERNAL_DATA_KEY = "rumInternalData";
 export declare const MASKED_TEXT = "***";
 export declare const MASK_CLASS_DEFAULT = "cx-mask";
 export declare const MASK_INPUT_TYPES_DEFAULT: InputType[];
+export declare const FINGER_PRINT_KEY = "cx-fingerprint";
 export declare const OPTIONS_DEFAULTS: Partial<CoralogixBrowserSdkConfig>;
 export declare const INSTRUMENTATIONS: readonly InternalInstrumentationConfig[];
 export declare const CoralogixAttributes: {

package/src/instrumentations/network/CoralogixFetchInstrumentation.d.ts

@@ -9,4 +9,5 @@ export declare class CoralogixFetchInstrumentation extends FetchInstrumentation
     private setNetworkSpanAttributes;
     private setRequestAttributes;
     private setResponseAttributes;
+    disable(): void;
 }

package/src/instrumentations/network/CoralogixXhrInstrumentation.d.ts

@@ -8,4 +8,5 @@ export declare class CoralogixXhrInstrumentation extends XMLHttpRequestInstrumen
     constructor(config: XMLHttpRequestInstrumentationConfig);
     private setNetworkSpanAttributes;
     private setResponseAttributes;
+    disable(): void;
 }

package/src/session/sessionManager.d.ts

@@ -10,6 +10,7 @@ export declare class SessionManager extends SessionIdle {
     private _cachedLogsSent;
     private _currentPageFragment;
     private _currentPageTimestamp;
+    private _fingerPrint;
     private debugMode;
     constructor(recordConfig?: SessionRecordingConfig);
     get currentPageTimestamp(): number;
@@ -21,6 +22,7 @@ export declare class SessionManager extends SessionIdle {
     get instrumentationsToSend(): Partial<Record<CoralogixEventType, boolean>> | undefined;
     get cachedLogsSent(): boolean;
     get sessionHasError(): boolean;
+    get fingerPrint(): string | undefined;
     set sessionHasError(value: boolean);
     set cachedLogsSent(val: boolean);
     updateCurrentPage(fragment: string): void;
@@ -38,5 +40,6 @@ export declare class SessionManager extends SessionIdle {
     private clearSessionWithErrorMode;
     private handleRefreshedSessions;
     private createNewSession;
+    private setFingerPrint;
     setSession: (afterIdle?: boolean) => Session;
 }

package/src/types.d.ts

@@ -324,6 +324,7 @@ export interface CxRumEvent extends EventTypeContext {
     isSnapshotEvent?: boolean;
     screenshot_context?: ScreenshotContext;
     screenshotId?: string;
+    fingerPrint: string;
 }
 export interface CxSpan {
     version_metadata: VersionMetaData;

package/src/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.8.8";
+export declare const SDK_VERSION = "2.9.0";