SDK配置参考

自定义APP版本

自定义设备App版本号后，SDK将会上报此版本号，不再使用默认获取的版本号。

withAppVersion(appVersion: string):AlibabaCloudRum

示例：

AlibabaCloudRum.withServiceId("${your_serviceId}")
      .withWorkspace("${your_workspace}")
      .withEndpoint("${your_endpoint}")
      .withAppVersion("${your_appVersion}")
      .start(this.context.getApplicationContext());

自定义应用环境

区分应用的环境。

withAppEnvironment(environment: string):AlibabaCloudRum

示例：

import {AppEnvironment} from '@alibabacloud_rum/harmony_sdk'

AlibabaCloudRum.withServiceId("${your_serviceId}")
      .withWorkspace("${your_workspace}")
      .withEndpoint("${your_endpoint}")
      .withAppEnvironment("${your_appEnvironment}")
      .start(this.context.getApplicationContext());

自定义应用包名

设置应用包名字段。

withAppBundleName(bundleName: string):AlibabaCloudRum

代码示例：

import {AppEnvironment} from '@alibabacloud_rum/harmony_sdk'

AlibabaCloudRum.withServiceId("${your_serviceId}")
      .withWorkspace("${your_workspace}")
      .withEndpoint("${your_endpoint}")
      .withAppBundleName("${your_appBundleName}")
      .start(this.context.getApplicationContext());

设置用户渠道ID

区分应用发布的渠道。

withChannelID(channelID: string): AlibabaCloudRum

示例：

AlibabaCloudRum.withServiceId("${your_serviceId}")
      .withWorkspace("${your_workspace}")
      .withEndpoint("${your_endpoint}")
      .withChannelID("${your_channelID}")
      .start(this.context.getApplicationContext());

设置设备ID

自定义设备ID。

withDeviceID(deviceID: string): AlibabaCloudRum

示例：

AlibabaCloudRum.withServiceId("${your_serviceId}")
      .withWorkspace("${your_workspace}")
      .withEndpoint("${your_endpoint}")
      .withDeviceID("${your_deviceId}")
      .start(this.context.getApplicationContext());

获取设备ID

如果在SDK启动时设置了withDeviceID接口，那么会返回自定义的设备ID。

static getDeviceID(): string

示例：

const deviceID = AlibabaCloudRum.getDeviceID();
console.log("ARSDK: "+deviceID);

自定义用户名称

SDK支持设置与用户相关的信息，从而完成性能数据与实际用户相关联的需求场景。

static setUserName(userName: string);

示例：

AlibabaCloudRum.setUserName("testName");

自定义用户扩展信息

SDK 支持设置更加详细的用户附加信息，从而满足数据分析与实际用户相关联的需求场景。

• 设置用户更加详细的附加信息

  static setUserExtraInfo(attributes: Map<string, Object>); 

  参数	类型	是否必填	说明	参数限制
  attributes	Map<string, Object>	是	用户附加信息	Map中kv最多64对 超过则保留其中64个，key长度小于256，超过则该key无效，且不包含特殊字符（只允许数字、字母、冒号、空格、斜杠、下划线、连字符、英文句号、@，空或空串无效）；value小于512，超过则截取

  示例：

  const userInfo = new Map<string, Object>();
  userInfo.set("aliasName", "lemonx");
  userInfo.set("userRegion", "hangzhou");
  userInfo.set("type", "svip");
  AlibabaCloudRum.setUserExtraInfo(userInfo);

• 追加用户更加详细的附加信息

  static addUserExtraInfo(attributes: Map<string, Object>); 

  参数	类型	是否必填	说明	参数限制
  attributes	Map<string, Object>	是	用户附加信息	Map中kv最多64对 超过则保留其中64个，key长度小于256，超过则该key无效，且不包含特殊字符（只允许数字、字母、冒号、空格、斜杠、下划线、连字符、英文句号、@，空或空串无效）；value小于512，超过则截取

  示例：

  const userInfo = new Map<string, Object>();
  userInfo.set("age", "18");
  AlibabaCloudRum.addUserExtraInfo(userInfo);

自定义全局属性

自定义全局属性设置后，新产生的数据会自动携带该业务属性信息，用于分析与业务属性相关联的需求。

static setExtraInfo(attributes: Map<string, Object>); 

示例：

const properties = new Map<string, Object>();
properties.set("param1", "test1");
properties.set("param2", "test2");
AlibabaCloudRum.setExtraInfo(userInfo);

追加全局属性。

static addExtraInfo(attributes: Map<string, Object>); 

示例：

const properties = new Map<string, Object>();
properties.set("param3", "test3");
AlibabaCloudRum.addExtraInfo(userInfo);

自定义异常

• 传参类型为 Error：调用接口并传入相应参数，可完成自定义异常数据的统计功能。

  static setCustomException(error: Error); //直接将 Exception 或 Throwable 对象传入即可

  参数	类型	是否必填	说明	参数限制
  error	Error	是	异常对象	系统抛出的异常对象，非null

  示例：

  try {
     throw new Error("Test");
  } catch (err) {
     AlibabaCloudRum.setCustomException(err);
  }

• 传参类型为自定义参数：更为灵活的重载配置如下，可用于业务型异常上报，对应参数可填充符合参数限制的任意内容，控制台直接展示。

  static setCustomException(errorType: string, causeBy?: string, errorDump?: string); 

  参数	类型	是否必填	说明	参数限制
  errorType	string	是	异常类型(必要)	字符串长度大于0，小于等于256，否则接口调用失败。
  causeBy	string	否	异常原因	字符串可为空或空串。 字符串小于等于512，超长截取。
  errorDump	string	否	异常信息	超出10000字符时会被切割

  示例：

  try {
      throw new Error("Test");
  } catch (err) {
      if (err instanceof Error) {
         AlibabaCloudRum.setCustomException(err.name, err.message, err.stack);
      }
  }

自定义事件

调用接口并传入相应参数，可完成自定义事件数据统计功能。

static setCustomEvent(eventName: string, group?: string, value?: number, snapshots?: string, attributes?: Map<string, string>)

示例：

AlibabaCloudRum.setCustomEvent("注册");

const info = new Map<string, string>();
info.set("eventNumber","10001");
info.set("eventName", "alibaba");
info.set("eventXX", "xxx");
AlibabaCloudRum.setCustomEvent("登录失败", "事件分组", undefined, "事件快照", info);

自定义日志

调用接口并传入相应参数，可完成自定义日志数据统计功能。

static setCustomLog(content: string, name: string, snapshots?: string, level?: string, attributes?: Map<string, Object>);

示例：

AlibabaCloudRum.setCustomLog("日志内容1");

const logInfo = new Map<string, string>();
logInfo.set("logXX","xxx");
AlibabaCloudRum.setCustomEvent("日志内容2", "日志名称", "日志快照", "ERROR", logInfo);