SDK配置参考

SDK 配置

使用CDN加载情况下，访问 SDK 监控实例，请使用全局命名空间 RumSDK.default。

const ArmsRum = window.RumSDK.default;
// 访问 RumSDK 需确保SDK已经完成加载
// 如果SDK加载前没有定义 __rum 配置，可在此初始化
ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
});
// 以下继续使用，NPM 和 CDN 一致
ArmsRum.setConfig('env', 'pre');

user 配置

示例

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  user: {
    name: 'your user.name',
    tags: 'your user.tags',
  },
});

reportConfig 配置

示例

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpint",
  reportConfig: {
    flushTime: 0, // 立即上报
    maxEventCount: 50, // 一次最多上报数量
  },
});

sessionConfig 配置

Storage存储了user.id和session信息 ：

• _arms_uid：唯一标识用户ID，对应user.id。

• _arms_session：具备语义化的Session信息。

  • sessionId：Session唯一标识。

  • sampled：是否命中采样。

  • startTime：Session的开始时间戳。

  • lastTime：Session最后一次活跃时间戳。

`${sessionId}-${sampled}-${startTime}-${lastTime}`

示例

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpint",
  sessionConfig: {
    sampleRate: 0.5, // 采样率50%
    maxDuration: 86400000,
    overtime: 3600000,
    storage: 'cookie',
  },
});

collectors 配置

Collector是RUM SDK用于收集页面监控数据的最小单元。目前RUM SDK内置了API、static Resource等丰富的采集器。

示例

关闭监听用户Click行为。

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  collectors: {
    action: false,
  },
});

evaluateApi 配置

evaluateApi提供对API（XMLHttpRequest/fetch）事件的自定义解析。以下为SDK传入的三个参数：

该函数支持异步函数，返回Promise<IApiBaseAttr>，IApiBaseAttr的定义如下：

示例

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpint",
  evaluateApi: async (options, response, error) => {
    let respText = '';
    // 当前为使用fetch请求的情况
    if (response && response.text) {
      respText = await response.text();
    }
    // 返回的字段会覆盖默认内容，不返回的字段会依然使用SDK自定生成内容
    return {
      name: 'my-custom-api',
      success: error ? 0 : 1,
      // 以下可选
      snapshots: JSON.stringify({
        params: 'page=1&size=10', // 请求入参
        response: respText.substring(0, 2000), // 返回值
        reqHeaders: '', // 请求头
        resHeaders: '', // 响应头
      }),
      properties: {
        prop_msg: 'custom msg',
        prop_num: 1,
      },
    };
  },
});

filters 配置

filters 用于过滤无需上报的事件，目前支持 resource 和 exception 两种事件。

MatchOption

type MatchOption = string | RegExp | ((value: string) => boolean);

• string：匹配任何以该值开头的URL，如https://api.aliyun.com可以匹配https://api.aliyun.com/v1/resource。

• RegExp：使用提供的RegExp和URL执行test。

• function：以URL作为参数进行计算，返回true表示匹配。

当传入为 MatchOption[] 时，条件顺序执行，有一项满足就会被过滤。

示例

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  filters: {
    // 过滤异常
    exception: [
      'Test error', // 以'Test error'开头的error.message
      /^Script error\.?$/, // 正则表达式匹配 error.message
      (msg) => {
        return msg.includes('example-error');
      },
    ],
    // 过滤资源或API
    resource: [
      'https://example.com/', // 以'https://example.com/'开头的resource
      /localhost/i,
      (url) => {
        return url.includes('example-resource');
      },
    ],
  },
});

whiteScreen 配置

白屏监控仅支持浏览器端（Chrome 40+，IE 9+）。

DetectionRule

CustomTestResult的类型声明：

type CustomTesterResult = {
  /**
   * 是否存在内容，如果为`true`则表示有内容，`false`表示发生白屏。
   */
  hasContent: boolean;

  /**
   * 错误信息
   */
  message?: string;

  /**
   * 异常的快照数据
   */
  snapshot?: Record<string, any>;
}

ConfigOptions

参数仅在关联方法中生效。

示例

SCREENSHOT 截图检测法

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpint",
  whiteScreen: {
    detectionRules: [{
      target: '#root',
      test_when: ['LOAD', 'ERROR', 'ROUTE_CHANGE', 'LEAVE'],
      delay: 5000,
      tester: 'SCREENSHOT',
      configOptions: {
        colorRange: ['rgb(255, 255, 255)', 'rgb(0, 0, 0)'],
        threshold: 0.9,
        pixels: 10,
        horizontalOffset: 210,
        verticalOffset: 50,
      },
    }],
  },
});

SAMPLE 采样法

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpint",
  whiteScreen: {
    detectionRules: [{
      target: '#root',
      test_when: ['LOAD', 'ERROR', 'ROUTE_CHANGE', 'LEAVE'],
      delay: 5000,
      tester: 'SAMPLE',
      configOptions: {
        sampleMethod: 2,
        checkPoints: 10,
        threshold: 0.9,
        whiteBoxElements: ['.el-skeleton'],
      },
    }],
  },
});

CUSTOM 自定义检测函数

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpint",
  whiteScreen: {
    detectionRules: [{
      target: '#root',
      test_when: ['LOAD', 'ERROR', 'ROUTE_CHANGE', 'LEAVE'],
      delay: 5000,
      tester: async (element) => {
        // 自定义检测函数主题
        return {
          hasContent: false,
          message: '自定义的错误信息',
          snapshot: {
            // 键值对可自定义
            checkPoints: 100,
            rate: 0.99,
            checkdata: '......',
          },
        };
      },
    }],
  },
});

properties 配置

Properties是RUM提供的自定义属性，可为任何上报事件配置该属性。

使用evaluateApi、sendCustom、sendException、sendResource等可以单独为某个事件增加properties，仅对单个事件生效。

全局properties和事件properties在存储时会进行合并。事件properties优先级高于全局properties，合并时相同的key，事件properties会覆盖全局properties。合并后properties键值对数量不可超过20对，超出会基于key进行排序后移除。

示例

全局配置properties时，所有上报的事件都会拥有。

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  properties: {
    prop_string: 'xx',
    prop_number: 2,
    // key 和 value 超出范围会被截断
    more_than_50_key_limit_012345678901234567890123456789: 'yy',
    more_than_2000_value_limit: new Array(2003).join('1'),
    // 以下不符合要求的键值对会被移除
    prop_null: null,
    prop_undefined: undefined,
    prop_bool: true,
  },
});

其他配置

RUM SDK支持配置基于IP和UserAgent等解析所得到的公共属性，主动配置字段优先级高于自动解析。

以上字段具体可配置项请参考日志数据说明中公共属性部分。

示例

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  geo: {
    country: 'your custom cuntry info',
    city: 'your custom city info',
  },
});

SDK API

RUM SDK开放API，用于修改上报自定义数据，动态修改SDK配置等。

getConfig

获取SDK配置。

setConfig

修改SDK配置。

// 指定 key 设置
ArmsRum.setConfig('env', 'pre');

// 覆盖设置
const config = ArmsRum.getConfig();
ArmsRum.setConfig({
  ...config,
  version: '1.0.0',
  env: 'pre',
});

sendCustom

上报自定义数据，必须包含type和name两个属性，否则无法上报。属性的具体业务意义可参考下表，实际使用需要自行定义业务语义。

ArmsRum.sendCustom({
  // 必选
  type: 'CustomEvnetType1',
  name: 'customEventName2',
  // 可选
  group: 'customEventGroup3',
  value: 111.11,
  properties: {
    prop_msg: 'custom msg',
    prop_num: 1,
  },
});

sendException

上报自定义异常数据，必须包含name和message两个属性，否则无法上报。

ArmsRUM.sendException({
  // 必选
  name: 'customErrorName',
  message: 'custom error message',
  // 可选
  file: 'custom exception filename',
  stack: 'custom exception error.stack',
  line: 1,
  column: 2,
  properties: {
    prop_msg: 'custom msg',
    prop_num: 1,
  },
});

sendResource

上报自定义资源，必须包含name、type和duration三个属性，否则无法上报。

ArmsRum.sendResource({
  // 以下必选
  name: 'getListByPage',
  message: 'success',
  duration: 800,
  // 以下可选
  url: 'https://www.aliyun.com/data/getListByPage',
  properties: {
    prop_msg: 'custom msg',
    prop_num: 1,
  },
});