Application Real-Time Monitoring Service:Integrate a mini program

Quick start

Install the SDK and initialize it in your mini program entry file:

npm install @arms/rum-miniapp

import ArmsRum from '@arms/rum-miniapp';

ArmsRum.init({
  pid: '<your-pid>',
  endpoint: '<your-endpoint>',
});

Replace <your-pid> and <your-endpoint> with the values generated in the ARMS console. For the full setup procedure, continue with the steps below.

Prerequisites

Before you begin, make sure that you have:

• An Alibaba Cloud account with ARMS activated

• A mini program project set up locally with npm support

• Access to the mini program platform's management console for domain whitelisting

Step 1: Create an application in the ARMS console

1. Log on to the ARMS console.

2. In the left-side navigation pane, choose Real User 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. Enter a name and description for your mini program, then click Create.

   Note

   The name must be unique.

   After the application is created, ARMS generates two values that you need for SDK initialization:

   • pid: A unique identifier for your mini program.

   • endpoint: The URL where the SDK sends monitoring data.

   Copy both values. You need them in the next step.

Step 2: Install and initialize the SDK

Mini programs only support npm-based installation.

1. Install the @arms/rum-miniapp package:

      npm install @arms/rum-miniapp

2. Initialize the SDK.

   Note

   Replace the pid and endpoint parameters in the following code with the values obtained from the ARMS console.

   Parameter	Required	Description
   pid	Yes	Application ID generated by the ARMS console
   endpoint	Yes	Reporting endpoint generated by the ARMS console. Example: https://aokcd*****-default-cn.rum.aliyuncs.com

      import ArmsRum from '@arms/rum-miniapp';
   
      ArmsRum.init({
        pid: '<your-pid>',              // Application ID from the ARMS console
        endpoint: '<your-endpoint>',    // Reporting endpoint from the ARMS console
      });

Step 3: Add the endpoint to your domain whitelist

Mini program platforms require all network request domains to be registered in a whitelist. Add your ARMS reporting endpoint to the server domain whitelist in your mini program platform's management console.

The endpoint follows this pattern: https://aokcd*****-default-cn.rum.aliyuncs.com

See also

• RUM SDK configuration options for mini programs: All available SDK configuration options for customizing monitoring behavior.