Application Real-Time Monitoring Service:Integrate a mini program

Procedure

1. Log on to the ARMS console.

2. In the left-side navigation pane, choose User Experience Monitoring > Application List. In the top navigation bar, select a region.

3. On the Applications page, click Add Application.

4. In the Create Application panel, click Mini Program.

5. In the Mini Program panel, enter the name and description of the mini program, and click Create.

   Note

   The name must be unique.

   Then, an address to which monitoring data is reported (endpoint) and a mini program ID (pid) are automatically generated for the app.

6. Initialize the OpenRUM SDK.

   To initialize the OpenRUM SDK, use a npm package.

   1. Introduce the npm package.

      npm install @arms/rum-miniapp

   2. Initialize the SDK.

      Note

      Replace the pid and endpoint parameters in the following code with the address and mini program ID obtained from the ARMS console.

      import ArmsRum from '@arms/rum-miniapp';
      ArmsRum.init({
        pid: "your app id",
        endpoint: "your endpint"
      });

7. Configure the address.

   Add the address to the domain name whitelist of the server.

   Sample address: https://aokcd*****-default-cn.rum.aliyuncs.com

SDK parameters

User parameters

Example

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

reportConfig parameters

Example

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

Collectors parameters

OpenRUM SDK uses Collectors, such as api and static Resource, to collect page 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: {
    action: false,
  }
});

EvaluateApi parameters

The evaluateApi function provides custom parsing for request and httpRequest events.

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

Example

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

    // 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,
      snapshots: JSON.stringify({
        params: 'page=1&size=10', // The input parameter.
        response: respText.substring(0, 2000), // The returned value.
        reqHeaders: '', // The request header.
        resHeaders: ''' // The response header.
      })
    }
  }
});

SDK API

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

getConfig

You can use the function to obtain the SDK configurations.

setConfig

You can use the function to modify the SDK configurations.

// Set the environment type.
ArmsRum.setConfig('env', 'pre');

// The following content may be overwritten.
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 fields. The following table describes the parameters related to data reporting. You need to define the business semantics.

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

sendException

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

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

sendResource

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

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