Application Real-Time Monitoring Service:Sample configurations for the RUM SDK for minigames

SDK parameters

User parameters

Example

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

reportConfig parameters

Example

armsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  reportConfig: {
    flushTime: 0, // Specify that data is immediately reported.
    maxEventCount: 50, // Specify the maximum number of data entries reported at a time.
  },
});

sessionConfig parameters

The user ID and session information is stored in the local cache of the minigame:

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

• _arms_session: the semantic session information.

  • sessionId: the unique session ID.

  • sampled: indicates whether sampling was triggered.

  • startTime: the start timestamp of the session.

  • lastTime: the timestamp when the session was last active.

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

Example

armsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  sessionConfig: {
    sampleRate: 0.5, // Specify a 50% sampling rate.
    maxDuration: 86400000,
    overtime: 3600000,
  },
});

collectors parameters

The SDK uses collectors, such as API and Exception, to collect minigame monitoring data.

Example

In the following example, the collection of user interaction data is disabled.

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

evaluateApi parameters

The evaluateApi function provides custom parsing for API request events.

This function can be called asynchronously. Promise<IApiBaseAttr> is returned. The following table describes IApiBaseAttr.

Example

armsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  evaluateApi: async (options, response, error) => {
    // The returned fields will overwrite the default content. If the fields are not returned, the default content is used.
    return {
      name: 'my-custom-api',
      success: error ? 0 : 1,
      // Optional.
      snapshots: JSON.stringify({
        params: 'page=1&size=10', // The input parameter.
        response: '', // The returned value.
        reqHeaders: '', // The request header.
        resHeaders: '', // The response header.
      }),
      properties: {
        prop_msg: 'custom msg',
        prop_num: 1,
      },
    };
  },
});

filters parameters

The filters parameters exclude resource and exception events that do not need to be reported.

MatchOption

type MatchOption = string | RegExp | ((value: string, error?: Error) => boolean);

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

• RegExp: specifies a regular expression and URL.

• function: uses a function to determine whether a URL is matched. If true is returned, the URL is matched. When filtering exceptions, a second parameter, which is an Error object, is passed in.

When the input is MatchOption[], the preceding conditions are evaluated in order, and it will be excluded if any condition is met.

Example

armsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  filters: {
    // Exclude exception events
    exception: [
      'Test error', // Filter error messages starting with 'Test error'.
      /^Script error\.?$/, // Specify a regular expression.
      (msg, error) => {
        return msg.includes('example-error');
      },
    ],
    // Exclude resource or API events
    resource: [
      'https://example.com/', // Filter resources starting with 'https://example.com/'.
      /localhost/i,
      (url) => {
        return url.includes('example-resource');
      },
    ],
  },
});

properties parameters

Properties provided by RUM can be configured for all events.

You can use evaluateApi, sendCustom, sendException, and sendResource to add properties to an event. The properties take effect only for the event.

Global properties and event properties are merged when they are stored. Event properties have a higher priority than global properties. If the same key is used when merging, the event properties overwrite the global properties. The number of key-value pairs cannot exceed 20 after merging. If the number exceeds 20, the pairs are sorted based on keys and the excess ones are removed.

Example

Globally configured properties are attached to all reported events.

armsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  properties: {
    prop_string: 'xx',
    prop_number: 2,
    // If the length of the key or value exceeds the limit, the excess part is truncated.
    more_than_50_key_limit_012345678901234567890123456789: 'yy',
    more_than_2000_value_limit: new Array(2003).join('1'),
    // The following invalid key-value pairs will be removed.
    prop_null: null,
    prop_undefined: undefined,
    prop_bool: true,
  },
});

Other parameters

The SDK allows you to configure common properties that are resolved based on IP addresses and UserAgent. Proactively configured parameters have a higher priority than automatically resolved parameters.

For more information about configuration items about the preceding parameters, see Common attributes.

Example

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

SDK API

The SDK provides APIs for modifying and reporting custom data and dynamically modifying SDK configurations.

getConfig

You can use this function to obtain the SDK configurations.

setConfig

You can use this function to modify the SDK configurations.

// Set a specific key
armsRum.setConfig('env', 'pre');

// Overwrite the following settings
const config = armsRum.getConfig();
armsRum.setConfig({
  ...config,
  version: '1.0.0',
  env: 'pre',
});

sendCustom

To report custom data, you must specify the type and name parameters. The following table describes the parameters related to data reporting. You need to define the business semantics.

armsRum.sendCustom({
  // Required.
  type: 'CustomEvnetType1',
  name: 'customEventName2',
  // Optional.
  group: 'customEventGroup3',
  value: 111.11,
  properties: {
    prop_msg: 'custom msg',
    prop_num: 1,
  },
});

sendException

To report custom exception data, you must specify the name and message parameters.

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

sendResource

To report custom resource data, you must specify the name, type, and duration parameters.

armsRum.sendResource({
  // Required.
  name: 'getListByPage',
  message: 'success',
  duration: 800,
  // Optional.
  url: 'https://www.aliyun.com/data/getListByPage',
  properties: {
    prop_msg: 'custom msg',
    prop_num: 1,
  },
});