Monitor DingTalk mini programs

Background information

For background information about the DingTalk mini program, see DingTalk mini program Migrate an instance across regions based on Global Replica.

Procedure

To monitor a DingTalk mini program, install and initialize the Node Package Manager (NPM) package, report monitoring data, and then configure security domains.

1. Install and initialize the NPM package.
   1. Install the NPM package named alife-logger in the DingTalk mini program. This module can then be used to report logs.

      npm install alife-logger                      

   2. Add the following to /utils Directory in the monitor.js file to complete the initialization.
      Note You can specify the name and storage path of the JavaScript (JS) file.

      import EAppLogger from 'alife-logger/eapp';
      const Monitor = EAppLogger.init({
          pid: 'xxx',
          region: "cn",
      });
      
      export default Monitor;            

      Note For detailed configuration of parameters, see Common parameters of SDK.
2. You can use the following methods to automatically collect and report page views (PVs), error, API requests, performance, and health data.
   1. In app.js, use the Monitor.hookApp(options) Method silently captures the Error class log. Of which options That is, the corresponding Object configuration for the App layer.

      import Monitor from '/util/monitor';
      
      App(Monitor.hookApp({
        onError(err) {
            console.log('onError:', err);
        },
        onLaunch() {
          console.log('onLaunch');
        },
      
        onShow(options) {
        },
        onHide() {
        }
      }));                         

   2. In the JS file of the Page by Monitor.hookPage(options) Method to silently report the API request, PV, and Health data.

      import Monitor from '/util/monitor';
      
      Page(Monitor.hookPage({
         data: {},
          onLoad(query) {
          },
          onReady() {
      
          },
          onShow() {
      
          },
          onLoad(query) {
      
          },
          onHide() {
      
          },
          onUnload() {
      
          }
      }));

3. Set security domains.
   • If region Set as cn , add the arms-retcode.aliyuncs.com to the HTTP security Domains.
   • If region Set as sg , add the arms-retcode-sg.aliyuncs.com to the HTTP security Domains.

Basic API methods for automatic tracking

Other API methods

Advanced scenarios

If the basic methods cannot meet your needs, see the following advanced scenarios:

• Manually report the API operations. Automatic reporting is disabled.

  1. Soon disableHook Set as true , not reported silently dd.httpRequest The requested log.
  2. Manually called api() Method to report API-related information.

• Disable automatic reporting and enable manual tracking.

  1. No longer used in App and Page JS files. hookApp , hookPage Method.

  2. To send the PV data of the current Page, on the Page onShow Call under method pageShow() Method.

     Note Do not interact with hookPage() Method uses this method at the same time. Otherwise, PV logs may be reported repeatedly.

     import Monitor from '/util/monitor';
     Page({
         onShow: function() {
             Monitor.pageShow();
         }
     })

  3. To send Health-class data for the current Page, statistics on the Health of the current Page and Page stay time, on the Page onHide and onUnload Call under method pageHide() Method.

     Note Do not interact with hookPage() METHOD. This method is used at the same time. Otherwise, repeated log reporting may occur.

     import Monitor from '/util/monitor';
       Page({
     
           onHide: function() {
               Monitor.pageHide();
           },
           onUnload: function() {
               Monitor.pageHide();
           }
           ... 
       })                      

Common parameters of SDK

ARMS browser monitoring provides a series of SDK parameters. You can configure the parameters to meet additional requirements. The following table describes the common parameters suitable for the scenarios described in this topic.

ARMS browser monitoring also provides other SDK parameters. For more information, see SDK reference.