Application Real-Time Monitoring Service:Surveiller une application mini-programme WeChat

Contexte

Pour plus d'informations sur les applications mini-programmes WeChat, consultez la documentation des applications mini-programmes WeChat.

Utilisation de base

Pour surveiller une application mini-programme WeChat avec ARMS Browser Monitoring, suivez les trois étapes ci-dessous :

1. Obtenez le SDK de surveillance des applications mini-programmes WeChat et initialisez-le :

   1. Dans le répertoire /utils de votre projet d'application mini-programme WeChat, créez un fichier nommé wxLogger.js. Copiez le contenu du fichier JS du SDK de surveillance et collez-le dans le fichier wxLogger.js.

   2. Dans le répertoire /utils, créez un fichier nommé monitor.js et ajoutez le code suivant au fichier monitor.js pour initialiser le SDK.

      Remarque

      Vous pouvez personnaliser les noms de fichiers et les emplacements de stockage.

      • Si votre projet utilise des modules Node.js (require), ajoutez le code suivant :

        const WXLogger = require('./wxLogger.js');
        const Monitor = WXLogger.init({
          pid: 'xxx',
          region: 'cn', // Specify the deployment region: set to cn for China, or sg for regions near Singapore.
        });
        export default Monitor;

      • Si votre projet utilise des modules ES (import), ajoutez le code suivant :

        import WXLogger from './wxLogger.js';
        const Monitor = WXLogger.init({
          pid: 'xxx',
          region: 'cn', // Specify the deployment region: set to cn for China, or sg for regions near Singapore.
        });
        export default Monitor;

      Définissez region sur la région de déploiement de votre application : cn pour la Chine, ou sg pour les régions hors de Chine proches de Singapour.

      Remarque

      Pour connaître la configuration détaillée des paramètres, consultez les paramètres du SDK.

2. Activez l'instrumentation automatique pour collecter les données PV, les erreurs, les API, les performances et l'état de santé :

   1. Dans app.js, utilisez la méthode Monitor.hookApp(options) pour capturer automatiquement les journaux d'erreurs. Le paramètre options correspond à la configuration Object de la couche App.

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

   2. Dans le fichier JS de chaque page, utilisez la méthode Monitor.hookPage(options) pour signaler automatiquement les requêtes API, les PV et les données de santé.

      import Monitor from '/utils/monitor';
      
      // After you use hookPage, lifecycle APIs are automatically instrumented.
      Page(Monitor.hookPage({
        data: {},
        onLoad(query) {
        },
        onReady() {
          // The page is loaded.
        },
        onShow() {
        },
        onHide() {
        },
        onUnload() {
        }
      }));

3. Configurez le domaine de sécurité : ajoutez le domaine ARMS correspondant à votre valeur region à la liste des domaines de requête valides de votre application mini-programme WeChat.

   • Si region est défini sur cn, ajoutez https://arms-retcode.aliyuncs.com à la liste des domaines de requête valides.

   • Si region est défini sur sg, ajoutez https://arms-retcode-sg.aliyuncs.com à la liste des domaines de requête valides.

Paramètres du SDK

ARMS Browser Monitoring propose des paramètres de configuration du SDK que vous pouvez définir pour répondre à des besoins supplémentaires. Le tableau suivant décrit les paramètres de configuration courants applicables aux applications mini-programmes WeChat.

ARMS Browser Monitoring propose également des paramètres de configuration SDK supplémentaires pour répondre à d'autres besoins. Pour plus d'informations, consultez les paramètres de configuration du SDK.

API d'instrumentation automatique

Le tableau suivant décrit les méthodes fournies par le SDK de surveillance des applications mini-programmes WeChat pour l'instrumentation automatique du cycle de vie.

Autres API de configuration

Le tableau suivant décrit les méthodes que vous pouvez appeler pour configurer le SDK de surveillance des applications mini-programmes WeChat et signaler des données.

Cas d'utilisation avancés

Lorsque les méthodes d'instrumentation automatique décrites dans la section Utilisation de base ne répondent pas à vos besoins, utilisez l'une des configurations avancées suivantes :

• Signalez manuellement les informations API au lieu d'utiliser l'instrumentation automatique :

  1. Définissez disableHook sur true pour désactiver la génération automatique de journaux pour les requêtes wx.request.

  2. Appelez manuellement la méthode api() pour signaler les informations API.

• Désactivez l'instrumentation automatique et instrumentez vos pages manuellement :

  1. N'utilisez pas les méthodes hookApp ou hookPage dans les fichiers JS de App et Page.

  2. Pour envoyer les données PV de la page actuelle, appelez la méthode pageShow() dans la méthode onShow de la page.

     Remarque

     N'utilisez pas cette méthode conjointement avec

     hookPage()

     . Sinon, des données PV en double seront signalées.

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

  3. Pour envoyer les données de santé de la page actuelle, qui incluent l'état de santé de la page et le temps passé sur la page, appelez la méthode pageHide() dans les méthodes onHide et onUnload de la page.

     Remarque

     N'utilisez pas cette méthode conjointement avec

     hookPage()

     . Sinon, des données de santé en double seront signalées.

     import Monitor from '/utils/monitor';
     
     Page({
       onHide: function() {
         Monitor.pageHide();
       },
       onUnload: function() {
         Monitor.pageHide();
       }
       // Other lifecycle methods.
     })