Application Real-Time Monitoring Service：SDK 配置參考

SDK 配置（基礎配置）

endpoint 為必填項，為完整的上報地址 URL。可在CloudMonitor 2.0 控制台「使用者體驗監控 > 應用列表」中建立應用後擷取。

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

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

app 配置

app 對象用於描述應用的擴充資訊，便於在CloudMonitor 2.0 控制台中按維度篩選與彙總。

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 配置

user 對象用於標識目前使用者，便於在CloudMonitor 2.0 控制台中按使用者維度排查問題。

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

sessionConfig 配置

sessionConfig 控制會話（Session）的採樣與生命週期策略。

sampleRate 取值範圍為 0~1，1 表示 100% 採集，0.1 表示 10% 採樣。降低採樣率可減少上報量與費用。

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>'sessionConfig: {
    sampleRate: 1,
    maxDuration: 4 * 60 * 60 * 1000,  // 會話最長 4 小時overtime: 30 * 60 * 1000,          // 30 分鐘無活動則逾時
  },
});

collectors 配置（主進程採集器）

collectors 控制主進程中各採集器的啟用/禁用。每個採集器支援傳入 boolean 或 ICollectorConfig 對象進行細粒度配置。

crash 採集器通過 Electron 的 crashReporter 機制捕獲原生崩潰（主進程/渲染進程 Crash），並支援通過 WASM 解析 minidump 檔案。

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>'collectors: {
    jsError: true,
    consoleError: false,
    crash: true,
    api: {
      enable: true,
      // 可在 ICollectorConfig 中進一步配置過濾器等
    },
    application: true,
  },
});

browserCollectors 配置（渲染進程採集器）

browserCollectors 控制自動注入到渲染進程的 Browser SDK 中的採集器。每個採集器支援傳入 boolean 或 ICollectorConfig 對象。

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>'autoInject: true,
  browserCollectors: {
    perf: true,
    webvitals: true,
    exception: true,
    whiteScreen: true,
    api: true,
    staticResource: true,
    click: false,       // 關閉點擊事件採集longTask: true,
  },
});

tracing 配置

tracing 控制分布式鏈路追蹤（Tracing）的啟用與策略。支援傳入 boolean 快速開關，或傳入 ITracingOption 對象進行詳細配置。

propagatorTypes 支援多種傳播協議，可根據後端服務使用的鏈路追蹤體系選擇對應的協議。allowedUrls 支援字串或正則匹配，僅匹配的請求才會注入追蹤頭。

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,
  },
});

其他配置

// 渲染進程中手動初始化
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) => {
    // 自訂頁面名稱解析邏輯const match = url.match(/\/app\/([^/?#]+)/);
    return match ? match[1] : url;
  },
  beforeReport: (bundle: any) => {
    // 返回修改後的資料繼續上報，返回 null/undefined 則丟棄該條資料console.log('beforeReport', bundle);
    return bundle;
  },
  properties: {
    department: 'engineering',
    region: 'cn-hangzhou',
  },
});

• partition 用於指定自訂 Electron session partition。當你的 BrowserWindow 使用了 partition 配置時，需要在此處指定相同的值，以確保 preload 指令碼正確註冊到對應的 session。

• spaMode 取值含義如下：

  • false：禁用 SPA 路由追蹤（預設行為，僅追蹤完整頁面載入）

  • true / 'auto'：自動檢測，優先 hash 後 pathname

  • 'hash'：Hash 路由模式（如 React HashRouter）

  • 'history'：History API 路由模式（如 React BrowserRouter）

SDK API

init(config: IElectronConfig): Promise<ArmsRum>

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

//在 app.ready 之前調用 init
armsRum.init({
  endpoint: '<YOUR-ENDPOINT>'env: 'prod',
  version: '1.0.0',
});

app.whenReady().then(() => {
  // 建立 BrowserWindow 等
});

getConfig(): IElectronConfig

const config = armsRum.getConfig();
console.log('當前配置:', config.endpoint, config.env);

// 方式一：按索引值對修改單個配置項
setConfig<T extends keyof IElectronConfig>(key: T, value: IElectronConfig[T]): void

// 方式二：傳入設定物件批量修改
setConfig(config: Partial<IElectronConfig>): void

// 修改單個配置項
armsRum.setConfig('enable', false);
armsRum.setConfig('env', 'daily');

// 批量修改配置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(() => {
  // 為自訂 partition 註冊 preload
  armsRum.registerSession('persist:main');
});

// 之後建立使用該 partition 的視窗
const win = new BrowserWindow({
  webPreferences: {
    partition: 'persist:main',
    // ...
  },
});