@coralogix/browser

Official Coralogix SDK for Browsers

Links

• Coralogix Real User Monitoring

Usage

To use Coralogix SDK for Browsers, call CoralogixRum.init(options) at the soonest available moment after the page load. This will initialize the SDK based on the options you provided.

import { CoralogixRum } from '@coralogix/browser';

CoralogixRum.init({
  application: 'app-name',
  environment: 'production',
  public_key: 'abc-123-456',
  coralogixDomain: 'EU2',
  version: 'v1.0.3',
  labels: {
    payment: 'visa',
  },
  ignoreErrors: ['some error message to ignore'],
});

More properties: instrumentations, traceParentInHeader, ignoreUrls, debug

To provide contextual information or transmit manual logs, utilize the exported functions of CoralogixRum. Keep in mind that these functions will remain inactive until you've invoked CoralogixRum.init().

import { CoralogixRum } from '@coralogix/browser';

// Update user context dynamically
CoralogixRum.setUserContext({
  user_id: '123',
  user_name: 'name',
  user_email: '[e-mail]',
  user_metadata: {
    role: 'admin',
    // ...
  }
})

// Update custom labels dynamically
CoralogixRum.setLabels({
   paymentMethod: 'visa',
   userTheme: 'black'
  // ...
})

// Update application context dynamically
CoralogixRum.setApplicationContext({
  application: 'app-name',
  version: '1.0.0'
})

CoralogixRum.log(CoralogixLogSeverity.Error, 'this is a log', { key: 'value' })
CoralogixRum.error('this is a log with error severity', { key: 'value' })