@coralogix/browser 2.9.0 → 2.11.0

package/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 2.11.0 (2025-11-23)
+
+### 🚀 Features
+
+- **trace:** allow custom propagator
+
+## 2.10.1 (2025-11-17)
+
+### 🩹 Fixes
+
+- **url-fragments:** Fix URL encoding of template placeholders in page_fragments. Template placeholders like `{id}`, `{lbid}` etc. added by URL blueprinters are now preserved in `page_fragments` instead of being percent-encoded to `%7Bid%7D`, `%7Blbid%7D`. This ensures consistency between `page_url_blueprint` and `page_fragments`.
+
+## 2.10.0 (2025-09-14)
+
+### 🚀 Features
+
+- **ignoreProxyUrlParams:** Added ignoreProxyUrlParams, which provides the ability to skip appending the Coralogix endpoint to the proxy URL.
+
 ## 2.9.0 (2025-08-18)
 
 ### 🚀 Features

package/README.md

@@ -657,6 +657,82 @@ CoralogixRum.init({
     },
   },
 });
+```
+
+#### Custom Propagation
+```javascript
+CoralogixRum.init({
+  // ...
+  traceParentInHeader: {
+    enabled: true,
+    options: {
+      // ...
+      /* for Custom propagation */
+      propagateCustomTraceHeader: new CustomPropagator()
+    },
+  },
+});
+
+// Example of CustomPropagator, Converts the 128-bit OpenTelemetry trace/span IDs into 64-bit decimal IDs
+
+import {
+  TextMapGetter,
+  TextMapSetter,
+  TextMapPropagator,
+  Context,
+  trace,
+} from '@opentelemetry/api';
+
+export class CustomPropagator implements TextMapPropagator {
+  inject(context: Context, carrier: any, setter: TextMapSetter) {
+    const span = trace.getSpan(context);
+    if (!span) return;
+
+    const spanContext = span.spanContext();
+    if (!spanContext) return;
+
+    // Custom trace ID = last 64 bits of OTel trace ID
+    const customTraceId = BigInt(
+      '0x' + spanContext.traceId.slice(16)
+    ).toString();
+    const customParentId = BigInt('0x' + spanContext.spanId).toString();
+
+    setter.set(carrier, 'my-custom-trace-id', customTraceId);
+    setter.set(carrier, 'my-custom-parent-id', customParentId);
+  }
+
+  extract(context: Context, carrier: any, getter: TextMapGetter): Context {
+    const traceIdHeader = getter.get(carrier, 'my-custom-trace-id');
+    const parentIdHeader = getter.get(carrier, 'my-custom-parent-id');
+
+    if (!traceIdHeader || !parentIdHeader) return context;
+
+    const traceId = BigInt(traceIdHeader as string)
+  .toString(16)
+      .padStart(32, '0');
+
+    const spanId = BigInt(parentIdHeader as string)
+  .toString(16)
+      .padStart(16, '0');
+
+    return trace.setSpan(
+      context,
+      trace.wrapSpanContext({
+        traceId,
+        spanId,
+        traceFlags: 1,
+        isRemote: true,
+      })
+    );
+  }
+
+  fields(): string[] {
+    return ['my-custom-trace-id', 'my-custom-parent-id'];
+  }
+}
+
+
+
 ```
 
 ### Before Send
@@ -696,6 +772,18 @@ CoralogixRum.init({
 });
 ```
 
+#### ignoreProxyUrlParams
+If you want the SDK to ignore the cxforward parameter and always send data to the proxy URL directly, you can use the ignoreProxyUrlParams option.
+By default, this option is disabled.
+```javascript
+CoralogixRum.init({
+  // ...
+  coralogixDomain: 'EU1',
+  proxyUrl: 'https://proxy.mycompany.com/rum',
+  ignoreProxyUrlParams: true,
+});
+```
+
 ### Collect IP Data
 
 Determines whether the SDK should collect the user's IP address and corresponding geolocation data. Defaults to true.

package/index.esm2.js

@@ -2660,7 +2660,7 @@ var getUrlFragments = function (url) {
             if (url.startsWith('blob:')) {
                 return url;
             }
-            return new URL(url).pathname.substring(1) || BASE_PATH;
+            return decodeURIComponent(new URL(url).pathname.substring(1)) || BASE_PATH;
         }
         catch (err) {
             console.warn('Coralogix Browser SDK - Error parsing URL', err);
@@ -3262,13 +3262,23 @@ var Request = (function () {
         this.resolvedHeaders = {};
         this.init();
     }
+    Request.prototype.getResolvedUrl = function (config) {
+        var coralogixDomain = config.coralogixDomain, proxyUrl = config.proxyUrl, ignoreProxyUrlParams = config.ignoreProxyUrlParams;
+        var cxEndpoint = "".concat(CoralogixDomainsApiUrlMap[coralogixDomain]).concat(this.requestConfig.suffix);
+        if (!proxyUrl)
+            return cxEndpoint;
+        if (ignoreProxyUrlParams)
+            return proxyUrl;
+        return "".concat(proxyUrl, "?").concat(PROXY_CX_FORWARD_PARAMETER, "=").concat(encodeURIComponent(cxEndpoint));
+    };
     Request.prototype.init = function () {
-        var _a = getSdkConfig(), proxyUrl = _a.proxyUrl, coralogixDomain = _a.coralogixDomain, public_key = _a.public_key;
-        var _b = this.requestConfig, suffix = _b.suffix, headers = _b.headers;
-        var cxEndpoint = "".concat(CoralogixDomainsApiUrlMap[coralogixDomain]).concat(suffix);
-        this.resolvedUrl = proxyUrl
-            ? "".concat(proxyUrl, "?").concat(PROXY_CX_FORWARD_PARAMETER, "=").concat(encodeURIComponent(cxEndpoint))
-            : cxEndpoint;
+        var _a = getSdkConfig(), proxyUrl = _a.proxyUrl, ignoreProxyUrlParams = _a.ignoreProxyUrlParams, coralogixDomain = _a.coralogixDomain, public_key = _a.public_key;
+        var headers = this.requestConfig.headers;
+        this.resolvedUrl = this.getResolvedUrl({
+            proxyUrl: proxyUrl,
+            ignoreProxyUrlParams: ignoreProxyUrlParams,
+            coralogixDomain: coralogixDomain,
+        });
         if (public_key) {
             headers['Authorization'] = "Bearer ".concat(public_key);
         }
@@ -3809,12 +3819,12 @@ var reportInternalEvent = function (event, message) {
 
 function handlePropagators(config, tracerProvider) {
     return __awaiter(this, void 0, void 0, function () {
-        var propagators, _a, propagateB3TraceHeader, propagateAwsXrayTraceHeader, singleHeader, multiHeader;
+        var propagators, _a, propagateB3TraceHeader, propagateAwsXrayTraceHeader, propagateCustomTraceHeader, singleHeader, multiHeader;
         var _b, _c;
         return __generator(this, function (_d) {
             if ((_b = config.traceParentInHeader) === null || _b === void 0 ? void 0 : _b.enabled) {
                 propagators = [];
-                _a = ((_c = config.traceParentInHeader) === null || _c === void 0 ? void 0 : _c.options) || {}, propagateB3TraceHeader = _a.propagateB3TraceHeader, propagateAwsXrayTraceHeader = _a.propagateAwsXrayTraceHeader;
+                _a = ((_c = config.traceParentInHeader) === null || _c === void 0 ? void 0 : _c.options) || {}, propagateB3TraceHeader = _a.propagateB3TraceHeader, propagateAwsXrayTraceHeader = _a.propagateAwsXrayTraceHeader, propagateCustomTraceHeader = _a.propagateCustomTraceHeader;
                 if (!propagateAwsXrayTraceHeader && !propagateB3TraceHeader) {
                     propagators = __spreadArray(__spreadArray([], __read$1(propagators), false), [
                         new W3CBaggagePropagator(),
@@ -3833,6 +3843,9 @@ function handlePropagators(config, tracerProvider) {
                         propagators.push(new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER }));
                     }
                 }
+                if (propagateCustomTraceHeader) {
+                    propagators.push(propagateCustomTraceHeader);
+                }
                 tracerProvider.register({
                     propagator: new CxPropagator(config, new CompositePropagator({
                         propagators: propagators,
@@ -3955,7 +3968,7 @@ function resolveUrlBlueprinters(urlBlueprinters) {
     return resolvedUrlBlueprinters;
 }
 
-var SDK_VERSION = '2.9.0';
+var SDK_VERSION = '2.11.0';
 
 function shouldDropEvent(cxRumEvent, options) {
     if (isDocumentErrorWithoutMessage(cxRumEvent)) {

package/package.json

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

package/src/Request.d.ts

@@ -7,6 +7,7 @@ export declare class Request {
     private resolvedUrl;
     private resolvedHeaders;
     constructor(requestConfig: RequestConfig);
+    private getResolvedUrl;
     private init;
     send(body: BodyInit): Promise<Response>;
 }

package/src/types.d.ts

@@ -1,4 +1,4 @@
-import { Attributes } from '@opentelemetry/api';
+import { Attributes, TextMapPropagator } from '@opentelemetry/api';
 import { CoralogixDomainsApiUrlMap } from './constants';
 import { CoralogixLogSeverity } from './types-external';
 import { ErrorSource } from './instrumentations/CoralogixErrorInstrumentation';
@@ -88,6 +88,7 @@ export interface TraceHeaderConfiguration {
             singleHeader?: boolean;
             multiHeader?: boolean;
         };
+        propagateCustomTraceHeader?: TextMapPropagator;
     };
 }
 export interface CoralogixOtelWebOptionsInstrumentations {
@@ -149,6 +150,7 @@ export interface CoralogixBrowserSdkConfig {
     maskClass?: string | RegExp;
     beforeSend?: (event: EditableCxRumEvent) => BeforeSendResult;
     proxyUrl?: string;
+    ignoreProxyUrlParams?: boolean;
     collectIPData?: boolean;
     trackSoftNavigations?: boolean;
     memoryUsageConfig?: MemoryUsageConfig;

package/src/version.d.ts

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