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

Example

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

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

Session storage

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

• _arms_uid -- unique user ID (user.id).

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

  • sessionId -- unique session ID.

  • sampled -- whether sampling was triggered.

  • startTime -- session start timestamp.

  • lastTime -- timestamp of the last activity.

Example

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

Example

Disable API request tracking:

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

Example

armsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  evaluateApi: async (options, response, error) => {
    // Returned fields override SDK defaults.
    // Omitted fields retain their default values.
    return {
      name: "my-custom-api",
      success: error ? 0 : 1,
      // Optional: attach diagnostic snapshots
      snapshots: JSON.stringify({
        params: "page=1&size=10",
        response: "",
        reqHeaders: "",
        resHeaders: "",
      }),
      properties: {
        prop_msg: "custom msg",
        prop_num: 1,
      },
    };
  },
});

MatchOption

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

• String -- matches any URL that starts with the given value. For example, "https://api.example.com" matches "https://api.example.com/v1/resource".

• RegExp -- matches URLs against a regular expression.

• Function -- return true to exclude the event. For exception filters, the function receives an Error object as the second argument.

When an array of MatchOption values is provided, they are evaluated in order. An event is excluded if any condition matches.

Example

armsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  filters: {
    // Exclude specific exception events
    exception: [
      "Test error",                         // Starts with "Test error"
      /^Script error\.?$/,                  // Exact regex match
      (msg, error) => {
        return msg.includes("example-error");
      },
    ],
    // Exclude specific resource or API events
    resource: [
      "https://example.com/",               // Starts with this URL
      /localhost/i,                          // Regex match
      (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 their limits are truncated.
    more_than_50_key_limit_012345678901234567890123456789: "yy",
    more_than_2000_value_limit: new Array(2003).join("1"),
    // Invalid types are removed:
    prop_null: null,
    prop_undefined: undefined,
    prop_bool: true,
  },
});

Example

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

getConfig

Retrieve the current SDK configuration.

const config = armsRum.getConfig();

setConfig

Update SDK configuration after initialization.

// Update a single key
armsRum.setConfig("env", "pre");

// Update multiple keys
const config = armsRum.getConfig();
armsRum.setConfig({
  ...config,
  version: "1.0.0",
  env: "pre",
});

sendCustom

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

armsRum.sendCustom({
  type: "CustomEventType1",
  name: "customEventName2",
  group: "customEventGroup3",
  value: 111.11,
  properties: {
    prop_msg: "custom msg",
    prop_num: 1,
  },
});

sendException

Report a custom exception. The name and message parameters are required.

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

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

armsRum.sendResource({
  name: "getListByPage",
  type: "api",
  duration: 800,
  message: "success",
  url: "https://www.example.com/data/getListByPage",
  properties: {
    prop_msg: "custom msg",
    prop_num: 1,
  },
});