SDK configuration reference

SDK configuration (basic)

The endpoint parameter is required and must be the complete endpoint URL. You can obtain this URL from the ARMS console under Real User Monitoring > application list after creating an application.

import armsRum from '@arms/rum-electron';

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  enable: true,
  env: 'prod',
  version: '1.0.0',
});

App configuration

The app object provides extended application metadata for filtering and aggregating data by different dimensions in the ARMS console.

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  app: {
    name: 'MyElectronApp',
    version: '2.1.0',
    channel: 'stable',
    env: 'prod',
    type: 'electron',
    package: 'com.example.my-app',
    framework: 'react',
  },
});

User configuration

The user object identifies the current user, enabling user-level troubleshooting in the ARMS console.

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  user: {
    name: 'test-user',
    tags: 'vip,enterprise',
  },
});

sessionConfig configuration

The sessionConfig option controls session sampling and lifecycle policies.

The sampleRate must be a number between 0 and 1. A value of 1 means 100% of sessions are captured, while 0.1 means 10% are captured. Lowering the sample rate reduces data volume and cost.

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  sessionConfig: {
    sampleRate: 1,
    maxDuration: 4 * 60 * 60 * 1000,  // Session lasts for a maximum of 4 hours
    overtime: 30 * 60 * 1000,          // Session times out after 30 minutes of inactivity
  },
});

collectors configuration (main process)

The collectors option enables or disables individual main-process collectors. Each collector accepts a boolean or an ICollectorConfig object for fine-grained control.

The crash collector uses Electron's crashReporter module to capture native crashes in both the main and renderer processes and supports parsing minidump files with WASM.

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  collectors: {
    jsError: true,
    consoleError: false,
    crash: true,
    api: {
      enable: true,
      // You can further configure filters and other options in ICollectorConfig
    },
    application: true,
  },
});

browserCollectors configuration (renderer process)

The browserCollectors option configures the collectors automatically injected into the Browser SDK in the renderer process. Each collector accepts a boolean or an ICollectorConfig object.

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  autoInject: true,
  browserCollectors: {
    perf: true,
    webvitals: true,
    exception: true,
    whiteScreen: true,
    api: true,
    staticResource: true,
    click: false,       // Disable click event collection
    longTask: true,
  },
});

tracing configuration

The tracing option configures distributed tracing. Pass a boolean to enable or disable it, or an ITracingOption object for detailed configuration.

 propagatorTypes supports multiple propagation protocols. Select a protocol based on the tracing system your backend uses. allowedUrls supports string or regular expression matching; trace headers are injected only into matching requests.

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  tracing: {
    enable: true,
    sample: 0.5,
    propagatorTypes: ['tracecontext', 'b3'],
    allowedUrls: [
      'https://api.example.com',
      /\/api\/v\d+\//,
    ],
    tracestate: true,
    baggage: false,
  },
});

Other configurations

// Initialize manually in the renderer process
import armsRum from '@arms/rum-electron/browser';
armsRum.init({ endpoint: '<YOUR-ENDPOINT>' });

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  autoInject: true,
  partition: 'persist:main',
  spaMode: 'hash',
  parseViewName: (url: string) => {
    // Custom logic to parse the page view name
    const match = url.match(/\/app\/([^/?#]+)/);
    return match ? match[1] : url;
  },
  beforeReport: (bundle: any) => {
    // Return the modified data to continue reporting.
    // Return null or undefined to drop the data.
    console.log('beforeReport', bundle);
    return bundle;
  },
  properties: {
    department: 'engineering',
    region: 'cn-hangzhou',
  },
});

• Use the partition option to specify a custom Electron session partition. If your BrowserWindow uses a partition configuration, you must specify the same value here to ensure the preload script is correctly registered for the corresponding session.

• Possible values for spaMode are:

  • false: Disables SPA route tracking. This is the default behavior, where only full page loads are tracked.

  • true or 'auto': Automatically detects the routing mode, prioritizing hash changes over pathname changes.

  • 'hash': Hash routing mode (for example, React HashRouter).

  • 'history': History API routing mode (for example, React BrowserRouter).

SDK API

init(config: IElectronConfig): Promise<ArmsRum>

import { app } from 'electron';
import armsRum from '@arms/rum-electron';

// Call init before app.ready
armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  env: 'prod',
  version: '1.0.0',
});

app.whenReady().then(() => {
  // Create BrowserWindow instances, etc.
});

getConfig(): IElectronConfig

const config = armsRum.getConfig();
console.log('Current config:', config.endpoint, config.env);

// Update a single option.
setConfig<T extends keyof IElectronConfig>(key: T, value: IElectronConfig[T]): void

// Update multiple options.
setConfig(config: Partial<IElectronConfig>): void

// Update a single option
armsRum.setConfig('enable', false);
armsRum.setConfig('env', 'daily');

// Update multiple options
const config = armsRum.getConfig();
armsRum.setConfig({
  ...config,
  enable: true,
  env: 'prod',
  version: '2.0.0',
});

registerSession(partition: string): Promise<ArmsRum>

import armsRum from '@arms/rum-electron';
import { BrowserWindow } from 'electron';

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
}).then(() => {
  // Register the preload script for the custom partition
  armsRum.registerSession('persist:main');
});

// Then, create a window that uses this partition
const win = new BrowserWindow({
  webPreferences: {
    partition: 'persist:main',
    // ...
  },
});