Mini Program Access¶

By importing the SDK file, you can collect performance metrics, error logs, and resource request data from Mini Programs, and report them to the TrueWatch platform to visualize and analyze the performance of Mini Programs.

Prerequisites (DataKit Access)¶

• Install DataKit;
• Configure the RUM Collector;
• Make DataKit publicly accessible and install the IP geolocation database.

Getting Started¶

1. Go to Real User Monitoring (RUM) > Create App > Mini Program;
2. Enter the app name;
3. Enter the app ID;

4. Select the app access method:

5. Public DataWay: Receives RUM data directly without installing the DataKit collector.

6. Local Deployment: Receives RUM data after meeting the prerequisites.

Access Methods¶

Usage¶

Import the code in the Mini Program's app.js file as follows:

Note: The import must be placed before App() initialization.

const { datafluxRum } = require('@cloudcare/rum-miniapp')
// Initialize Rum
datafluxRum.init({
  datakitOrigin: '<DATAKIT ORIGIN>',// Required, Datakit domain address. You need to add the domain to the whitelist in the WeChat Mini Program management console.
  site: "http://172.16.212.186:9529", // Domain of the site corresponding to the public DataWay
  clientToken: "a993f53a8ea04bc6b9350e5e670a3a3b", // Client token required for public DataWay reporting, generated when creating the app in the TrueWatch console.
  applicationId: '<App ID>', // Required, app ID generated by the dataflux platform
  env: 'testing', // Optional, Mini Program environment
  version: '1.0.0', // Optional, Mini Program version
  service: 'miniapp', // Service name of the current app
  trackInteractions: true,
  traceType: 'ddtrace', // Optional, default is ddtrace. Currently supports 6 types: ddtrace, zipkin, skywalking_v3, jaeger, zipkin_single_header, w3c_traceparent
  allowedTracingUrls: ['https://api.example.com/v1/', /https:\/\/.*\.my-api-domain\.com\/v2\//], // Matches full request URL
  allowTraceHeaderWithoutSession: true, // Injects Trace Header even if the Session is not sampled, without reporting RUM data
})

const { datafluxRum } = require('./lib/dataflux-rum-miniapp.js')
// Initialize Rum
datafluxRum.init({
  datakitOrigin: '<DATAKIT ORIGIN>',// Required, Datakit domain address. You need to add the domain to the whitelist in the WeChat Mini Program management console.
  site: "http://172.16.212.186:9529", // Domain of the site corresponding to the public DataWay
  clientToken: "a993f53a8ea04bc6b9350e5e670a3a3b", // Client token required for public DataWay reporting, generated when creating the app in the TrueWatch console.
  applicationId: '<App ID>', // Required, app ID generated by the dataflux platform
  env: 'testing', // Optional, Mini Program environment
  version: '1.0.0', // Optional, Mini Program version
  service: 'miniapp', // Service name of the current app
  trackInteractions: true,
  traceType: 'ddtrace', // Optional, default is ddtrace. Currently supports 6 types: ddtrace, zipkin, skywalking_v3, jaeger, zipkin_single_header, w3c_traceparent
  allowedTracingUrls: ['https://api.example.com/v1/', /https:\/\/.*\.my-api-domain\.com\/v2\//], // Matches full request URL
  allowTraceHeaderWithoutSession: true, // Injects Trace Header even if the Session is not sampled, without reporting RUM data
})

Configuration¶

Initialization Parameters¶

Trace Header URL Matching¶

allowedTracingUrls uses the full request URL for matching. Strings use prefix matching; RegExp and Function receive the full URL. To specify a different propagation type for a specific rule, use an object containing both match and traceType:

allowedTracingUrls: [
  'https://api.example.com/v1/',
  /https:\/\/.*\.my-api-domain\.com\/v2\//,
  function (url) {
    return url.indexOf('https://internal.example.com/') === 0
  },
  { match: 'https://otel.example.com/', traceType: 'w3c_traceparent' },
]

allowedTracingOrigins is only for backward compatibility: both strings and regular expressions match against the request Origin. If both parameters are configured, the SDK only uses allowedTracingUrls.

Trace Header for Non-Sampled Sessions¶

allowTraceHeaderWithoutSession defaults to false. When set to true, even if the current Session is not sampled by RUM, the SDK still injects Trace Headers into requests that match allowedTracingUrls. This configuration does not force sampling or create a new Session, nor does it report View, Action, Resource, Error, or other RUM data for the non-sampled Session.

Notes¶

1. The DataKit domain corresponding to datakitOrigin must be added to the request whitelist in the Mini Program management console.
2. Because the current WeChat Mini Program request resource APIs wx.request and wx.downloadFile do not return the profile field on iOS systems, the collected resource information related to timing data may be incomplete. There is currently no solution: request, downloadFile, API support status.
3. When trackInteractions (user action collection) is enabled, due to the limitations of WeChat Mini Programs, the content and structure data of controls cannot be collected. Therefore, in the Mini Program SDK, we adopt declarative programming. By setting the data-name attribute in the wxml file, you can add names to interactive elements for easier identification of operation records later. For example:

<button bindtap="bindSetData" data-name="setData">
  setData
</button>