Application Real-Time Monitoring Service:RUM SDK configuration reference for mini programs

Example

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  user: {
    name: getYourUserName(),
    tags: getYourTags(),
  }
});

Example

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  reportConfig: {
    flushTime: 0,          // Report data immediately
    maxEventCount: 50      // Send up to 50 events per batch
  }
});

Local cache

The SDK stores user ID and session data in the mini program's local cache:

• _arms_uid: the unique user ID (user.id).

• _arms_session: session metadata in the format ${sessionId}-${sampled}-${startTime}-${lastTime}, where:

  • sessionId: the unique session ID.

  • sampled: whether sampling was triggered.

  • startTime: the session start timestamp.

  • lastTime: the last activity timestamp.

Example

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  sessionConfig: {
    sampleRate: 0.5,          // 50% sampling rate
    maxDuration: 86400000,    // 24-hour max session
    overtime: 3600000,        // 1-hour inactivity timeout
  },
});

Example

Disable user interaction tracking:

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

Example

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  evaluateApi: async (options, response, error) => {
    const respText = JSON.stringify(response);

    // Returned fields overwrite defaults. Omitted fields keep default values.
    return {
      name: 'my-custom-api',
      success: error ? 0 : 1,
      snapshots: JSON.stringify({
        params: 'page=1&size=10',
        response: respText.substring(0, 2000),
        reqHeaders: '',
        resHeaders: ''
      })
    }
  }
});

MatchOption

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

Three matching modes are available:

• String: matches any URL that starts with the specified value. For example, 'https://api.aliyun.com' matches https://api.aliyun.com/v1/resource.

• RegExp: matches URLs against a regular expression.

• Function: a custom function that returns true to exclude the event.

When MatchOption[] is provided, conditions are evaluated in order. An event is excluded if any condition matches.

Example

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  filters: {
    // Exclude exception events
    exception: [
      'Test error',                    // Prefix match
      /^Script error\.?$/,             // Regex match
      (msg) => {
        return msg.includes('example-error');  // Custom function
      },
    ],
    // Exclude resource and API events
    resource: [
      'https://example.com/',          // Prefix match
      /localhost/i,                     // Regex match (case-insensitive)
      (url) => {
        return url.includes('example-resource');
      },
    ],
  },
});

Example

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  properties: {
    prop_string: 'xx',
    prop_number: 2,
    // Keys or values exceeding the length limit are truncated
    more_than_50_key_limit_012345678901234567890123456789: 'yy',
    more_than_2000_value_limit: new Array(2003).join('1'),
    // Invalid values are removed
    prop_null: null,
    prop_undefined: undefined,
    prop_bool: true,
  },
});

Example

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  geo: {
    country: '<your-country>',
    city: '<your-city>',
  },
});

getConfig

Retrieve the current SDK configuration:

const config = ArmsRum.getConfig();

setConfig

Update SDK configuration after initialization:

// Update a single parameter
ArmsRum.setConfig('env', 'pre');

// Update multiple parameters
const config = ArmsRum.getConfig();
ArmsRum.setConfig({
  ...config,
  version: '1.0.0',
  env: 'pre',
});

sendCustom

Report a custom event. Both type and name are required.

ArmsRum.sendCustom({
  type: 'CustomEventType1',
  name: 'customEventName2',
  group: 'customEventGroup3',
  value: 111.11
});

sendException

Report a custom exception. Both name and message are required.

ArmsRum.sendException({
  // Required
  name: 'customErrorName',
  message: 'custom error message',
  // Optional
  file: 'custom exception filename',
  stack: 'custom exception error.stack',
  line: 1,
  column: 2
});

sendResource

Report a custom resource event. The name, type, and duration parameters are required.

ArmsRum.sendResource({
  // Required
  name: 'getListByPage',
  message: 'success',
  duration: 800,
  // Optional
  url: 'https://www.example.com/data/getListByPage',
});