Simple Log Service:WebTracking JavaScript SDK for mini programs

Prerequisites

• WebTracking is enabled for the Logstore. For more information, see Use WebTracking to collect front-end logs.

• The WebTracking domain is added to the list of allowed request domains in your mini program management console. Mini program platforms require this allowlist for data security. The domain format is https://${project}.${host}, where project and host are the values configured in the SDK.

Limitations

• Each log upload is limited to 10 MB.

• Supported platforms: WeChat Mini Program, WeChat Mini Game, Alipay Mini Program, ByteDance Mini Program, DingTalk Mini Program, QQ Mini Program, QQ Mini Game, and Baidu Mini Program.

Step 1: Install and configure the SDK

1. Install Node.js.

2. Run the following command to install the SDK dependency:

   npm install --save @aliyun-sls/web-track-mini

3. Add the following code to configure the SDK:

   Important

   For quick apps, add extra configuration options for the request module before creating the SlsTracker object. The following example uses the requesttask module:

   // Define the quickappSDK object to encapsulate the request API.
   const quickappSDK = {     
         request: requesttask.request
       }
   
   const tracker = new SlsTracker({
         ...opts,
         platformSDK: quickappSDK,
         platformRequestName: 'request',
       })

   import SlsTracker from '@aliyun-sls/web-track-mini'
   
   const opts = {
     host: '${host}', // The endpoint of the region. For example, cn-hangzhou.log.aliyuncs.com.
     project: '${project}', // The name of the project.
     logstore: '${logstore}', // The name of the Logstore.
     time: 10, // The interval for sending logs, in seconds. Default: 10.
     count: 10, // The number of logs to send in each batch. Default: 10.
     topic: 'topic',// A custom log topic.
     source: 'source',
     tags: {
       tags: 'tags',
     },
   }
   
   const tracker = new SlsTracker(opts)  // Create an SlsTracker object.

   Parameter	Required	Description
   host	Yes	The Simple Log Service endpoint for your region. Example: cn-hangzhou.log.aliyuncs.com. For endpoints in other regions, see Endpoints.
   project	Yes	The name of the project.
   logstore	Yes	The name of the Logstore.
   time	No	The interval, in seconds, at which logs are sent. The default value is 10.
   count	No	The number of logs to send in each batch. The default value is 10.
   topic	No	The log topic. Specify a custom topic to identify logs.
   source	No	The log source. Specify a custom source to identify logs.
   tags	No	The log tags. Specify custom tags to identify logs.