应用实时监控服务ARMS：SDK 配置参考

SDK 配置（基础配置）

endpoint 为必填项，为完整的上报地址 URL。可在 ARMS 控制台「用户体验监控 > 应用列表」中创建应用后获取。

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

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

app 配置

app 对象用于描述应用的扩展信息，便于在 ARMS 控制台中按维度筛选与聚合。

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 对象用于标识当前用户，便于在 ARMS 控制台中按用户维度排查问题。

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