@coralogix/browser 2.3.0 → 2.4.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.4.0 (2025-04-08)
+
+### 🚀 Features
+
+- Allow passing labels to Custom logs (log, warn, debug, etc...) API.
+
 ## 2.3.0 (2025-04-01)
 
 ### 🚀 Features

package/README.md

@@ -54,7 +54,6 @@
 28. [CDN](#cdn)
 
     - [Specific Version](#specific-version-recommended)
-    - [Latest Version](#latest-version)
     - [Add the CDN Script to Your Application](#add-the-cdn-script-to-your-application)
     - [Initialization](#initialization)
       - [Via JS File](#via-js-file)
@@ -196,11 +195,30 @@ CoralogixRum.init({
 ```javascript
 import { CoralogixRum, CoralogixLogSeverity } from '@coralogix/browser';
 
+// send custom logs with different severity levels
 CoralogixRum.log(CoralogixLogSeverity.Info, 'this is a custom log');
 
+// send custom logs with extra data
 CoralogixRum.log(CoralogixLogSeverity.Error, 'this is an error custom log with extra data', { data: 'tbd' });
 
+// send custom logs with extra data, call the error severity log directly
 CoralogixRum.error('this is a custom log with error severity', { data: 'tbd' });
+
+// send custom logs with extra data and labels
+CoralogixRum.warning(
+  'this is a custom log message with warning severity',
+  {
+    data: 'tbd',
+  },
+  {
+    my_label_key: 'my label value',
+  }
+);
+
+// data is optional unless labels are provided, in which case data is required (can be null
+CoralogixRum.log(CoralogixLogSeverity.Info, 'this is a custom log message with info severity', null, {
+  my_label_key: 'my label value',
+});
 ```
 
 ### Instrumentation's
@@ -870,7 +888,7 @@ Coralogix Browser SDK is also provided for Flutter web.
 Add the following CDN to your `index.html` file:
 
 ```javascript
-<script src="https://cdn.rum-ingress-coralogix.com/coralogix/browser/latest/coralogix-browser-sdk.js"></script>
+<script src="https://cdn.rum-ingress-coralogix.com/coralogix/browser/[version]/coralogix-browser-sdk.js"></script>
 ```
 
 Then, in your Dart code, you can use the SDK as follows:

package/index.esm2.js

@@ -1148,7 +1148,8 @@ var CoralogixCustomLogInstrumentation = /** @class */ (function (_super) {
     CoralogixCustomLogInstrumentation.prototype.init = function () { };
     CoralogixCustomLogInstrumentation.prototype.disable = function () { };
     CoralogixCustomLogInstrumentation.prototype.enable = function () { };
-    CoralogixCustomLogInstrumentation.prototype.log = function (severity, message, data) {
+    CoralogixCustomLogInstrumentation.prototype.log = function (_a) {
+        var severity = _a.severity, message = _a.message, data = _a.data, labels = _a.labels;
         var span = this.tracer.startSpan(CoralogixEventType.LOG);
         span.setAttribute(CoralogixAttributes.EVENT_TYPE, CoralogixEventType.LOG);
         span.setAttribute(CoralogixAttributes.SOURCE, LogSource.CODE);
@@ -1160,6 +1161,9 @@ var CoralogixCustomLogInstrumentation = /** @class */ (function (_super) {
                 ? JSON.stringify(data, getCircularReplacer())
                 : data,
         }));
+        if (labels) {
+            setCustomLabelsForSpan(span, labels);
+        }
         span.end();
     };
     return CoralogixCustomLogInstrumentation;
@@ -4134,7 +4138,7 @@ function resolveUrlBlueprinters(urlBlueprinters) {
     return resolvedUrlBlueprinters;
 }
 
-var SDK_VERSION = '2.3.0';
+var SDK_VERSION = '2.4.0';
 
 function shouldDropEvent(cxRumEvent, options) {
     if (isDocumentErrorWithoutMessage(cxRumEvent)) {
@@ -4952,7 +4956,7 @@ var CoralogixRum = {
         var _a, _b;
         return (_b = (_a = getSessionManager()) === null || _a === undefined ? undefined : _a.getSession()) === null || _b === undefined ? undefined : _b.sessionId;
     },
-    log: function (severity, message, data) {
+    log: function (severity, message, data, labels) {
         if (!isInited) {
             console.debug('CoralogixRum must be initiated before using log');
             return;
@@ -4961,25 +4965,25 @@ var CoralogixRum = {
             console.warn('Log was reported, but custom instrumentation is disabled.');
             return;
         }
-        _customInstrumentation === null || _customInstrumentation === undefined ? undefined : _customInstrumentation.log(severity, message, data);
+        _customInstrumentation === null || _customInstrumentation === undefined ? undefined : _customInstrumentation.log({ severity: severity, message: message, data: data, labels: labels });
     },
-    debug: function (message, data) {
-        this.log(CoralogixLogSeverity.Debug, message, data);
+    debug: function (message, data, labels) {
+        this.log(CoralogixLogSeverity.Debug, message, data, labels);
     },
-    verbose: function (message, data) {
-        this.log(CoralogixLogSeverity.Verbose, message, data);
+    verbose: function (message, data, labels) {
+        this.log(CoralogixLogSeverity.Verbose, message, data, labels);
     },
-    info: function (message, data) {
-        this.log(CoralogixLogSeverity.Info, message, data);
+    info: function (message, data, labels) {
+        this.log(CoralogixLogSeverity.Info, message, data, labels);
     },
-    warn: function (message, data) {
-        this.log(CoralogixLogSeverity.Warn, message, data);
+    warn: function (message, data, labels) {
+        this.log(CoralogixLogSeverity.Warn, message, data, labels);
     },
-    error: function (message, data) {
-        this.log(CoralogixLogSeverity.Error, message, data);
+    error: function (message, data, labels) {
+        this.log(CoralogixLogSeverity.Error, message, data, labels);
     },
-    critical: function (message, data) {
-        this.log(CoralogixLogSeverity.Critical, message, data);
+    critical: function (message, data, labels) {
+        this.log(CoralogixLogSeverity.Critical, message, data, labels);
     },
     startTimeMeasure: function (key, labels) {
         if (!isInited) {

package/package.json

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

package/src/instrumentations/CoralogixCustomLogInstrumentation.d.ts

@@ -1,14 +1,22 @@
 import { InstrumentationBase, InstrumentationConfig } from '@opentelemetry/instrumentation';
 import { CoralogixLogSeverity } from '../types-external';
+import { CoralogixRumLabels } from '../types';
 export declare const CUSTOM_INSTRUMENTATION_VERSION = "1";
 export declare enum LogSource {
     CODE = "code"
 }
+interface CustomLogParams {
+    severity: CoralogixLogSeverity;
+    message: string;
+    data?: any;
+    labels?: CoralogixRumLabels;
+}
 export declare class CoralogixCustomLogInstrumentation extends InstrumentationBase {
     private stringifyCustomLogData;
     constructor(config: InstrumentationConfig);
     protected init(): void;
     disable(): void;
     enable(): void;
-    log(severity: CoralogixLogSeverity, message: string, data?: any): void;
+    log({ severity, message, data, labels }: CustomLogParams): void;
 }
+export {};

package/src/types.d.ts

@@ -106,13 +106,13 @@ export interface CoralogixOtelWebOptionsInstrumentations {
     web_vitals?: boolean | CoralogixWebVitalsInstrumentationConfig;
 }
 interface SendLog {
-    log: (severity: CoralogixLogSeverity, message: string, data?: any) => void;
-    debug: (message: string, data?: any) => void;
-    verbose: (message: string, data?: any) => void;
-    info: (message: string, data?: any) => void;
-    warn: (message: string, data?: any) => void;
-    error: (message: string, data?: any) => void;
-    critical: (message: string, data?: any) => void;
+    log: (severity: CoralogixLogSeverity, message: string, data?: any, labels?: CoralogixRumLabels) => void;
+    debug: (message: string, data?: any, labels?: CoralogixRumLabels) => void;
+    verbose: (message: string, data?: any, labels?: CoralogixRumLabels) => void;
+    info: (message: string, data?: any, labels?: CoralogixRumLabels) => void;
+    warn: (message: string, data?: any, labels?: CoralogixRumLabels) => void;
+    error: (message: string, data?: any, labels?: CoralogixRumLabels) => void;
+    critical: (message: string, data?: any, labels?: CoralogixRumLabels) => void;
 }
 export type UrlBlueprinter = (url: string) => string;
 export interface UrlBlueprinters {

package/src/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "2.3.0";
+export declare const SDK_VERSION = "2.4.0";