Surveiller les mini-programmes DingTalk - Application Real-Time Monitoring Service

Procédure

Pour surveiller un mini-programme DingTalk, importez et initialisez le package npm requis, instrumentez le mini-programme pour l'envoi des journaux, puis configurez le domaine de sécurité.

Importez et initialisez le package npm.

Importez le package npm arms/js-sdk dans le mini-programme DingTalk. Ce package permet d'envoyer les journaux.
```
npm install @arms/js-sdk                      
```

Ajoutez le code suivant au fichier monitor.js situé dans le répertoire /utils pour initialiser le package npm.

Remarque

Vous pouvez personnaliser le nom et le chemin de stockage du fichier JS.

import EAppLogger from 'arms/js-sdk/miniapp';
const Monitor = EAppLogger.init({
    pid: 'xxx',
    region: "cn", // The region where the mini program is deployed. Set the region parameter to cn if the mini program is deployed in China. Set the region parameter to sg if the mini program is deployed in or near Singapore. Set the region parameter to us if the mini program is deployed in or near the United States. 
});

export default Monitor;

Remarque

Pour plus d'informations sur la configuration des paramètres, consultez la section Paramètres SDK courants.

Définissez les noms de domaine de sécurité.
- Si le paramètre region est défini sur cn, ajoutez arms-retcode.aliyuncs.com au domaine de sécurité HTTP.
- Si le paramètre region est défini sur sg, ajoutez arms-retcode-sg.aliyuncs.com au domaine de sécurité HTTP.
- Si le paramètre region est défini sur us, ajoutez arms-retcode-us.aliyuncs.com au domaine de sécurité HTTP.

Autres méthodes API

Méthode	Syntaxe	Description
setCommonInfo	{[key: string]: string;}	Définit les champs de journal de base pour des scénarios tels que le déploiement canari.
setConfig	{[key: string]: string;}	Définit le champ config. Pour plus d'informations, consultez la section Référence SDK.
pageShow	{}	Instrumente les journaux PV (Page View).
pageHide	{}	Instrumente les journaux de santé.
error	String/Object	Instrumente les journaux d'erreur.
api	Pour plus d'informations, consultez la section Méthodes SDK.	Envoie les journaux de requête API.
sum/avg	String	Envoie les journaux personnalisés de somme et de moyenne.

Scénarios avancés

Si les méthodes de base ne répondent pas à vos besoins, reportez-vous aux scénarios avancés suivants :

Envoi manuel des journaux de requête API. L'envoi automatique est désactivé.
1. Définissez le paramètre disableHook sur true. Les journaux de la méthode dd.httpRequest ne sont pas envoyés automatiquement.
2. Appelez manuellement la méthode api pour envoyer les journaux de requête API.
Désactivez l'envoi automatique et activez l'instrumentation manuelle.
1. Les méthodes hookApp et hookPage ne sont plus utilisées dans les fichiers app.js et page.js.
2. Pour envoyer les journaux PV de la page, appelez la méthode pageShow dans la méthode onShow.
  
  Remarque
  N'appelez pas la méthode pageShow conjointement avec la méthode hookPage. Sinon, les journaux PV seront envoyés en double.
```
import Monitor from '/util/monitor';
Page({
    onShow: function() {
        Monitor.pageShow();
    }
})                         
```
3. Pour envoyer les journaux de santé indiquant le niveau de santé et le temps de navigation sur la page, appelez la méthode pageHide dans les méthodes onHide et onUnload.
  
  Remarque
  N'appelez pas la méthode pageHide conjointement avec la méthode hookPage. Sinon, les journaux de santé seront envoyés en double.
```
import Monitor from '/util/monitor';
  Page({

      onHide: function() {
          Monitor.pageHide();
      },
      onUnload: function() {
          Monitor.pageHide();
      }
      ... 
  })                    
```

Paramètres SDK courants

La fonctionnalité de surveillance frontend d'ARMS vous permet de définir divers paramètres SDK pour répondre à des exigences supplémentaires. Le tableau suivant décrit les paramètres courants adaptés aux scénarios décrits dans cette rubrique.


pid	String	L'ID unique du projet. Il est généré automatiquement par ARMS lors de la création d'un site.	Oui	Aucun
uid	String	L'ID de l'utilisateur. La valeur est un identifiant de l'utilisateur et peut être utilisée pour rechercher l'utilisateur. Vous pouvez spécifier une valeur personnalisée. Si vous ne spécifiez pas ce paramètre, il est généré automatiquement par le SDK et mis à jour tous les six mois.	Non	Généré automatiquement par le SDK
tag	String	Le tag d'entrée. Chaque journal porte un tag.	Non	Aucun
release	String	La version de l'application. Nous vous recommandons de configurer ce paramètre pour afficher les informations de rapport des différentes versions.	Non	`undefined`
environment	String	Le champ d'environnement. Valeurs valides : prod, gray, pre, daily et local. La valeur prod indique un environnement de production. La valeur gray indique un environnement de déploiement progressif. La valeur pre indique un environnement de préproduction. La valeur daily indique un environnement quotidien. La valeur local indique un environnement local.	Non	`prod`
sample	Integer	La configuration d'échantillonnage des journaux. La valeur est un entier compris entre 1 et 100. Les journaux de performance et les journaux d'API réussis sont échantillonnés selon le ratio `1/sample`. Pour plus d'informations sur les métriques des journaux de performance et des journaux d'API réussis, consultez la section Métriques statistiques.	Non	`1`
behavior	Boolean	Indique s'il faut enregistrer le comportement de l'utilisateur qui signale des erreurs pour faciliter le dépannage.	Non	`false`
enableLinkTrace	Boolean	Pour plus d'informations sur le traçage bout en bout, consultez la section Diagnostiquer les erreurs d'API avec le traçage frontal et arrière.	Non	`false`

La fonctionnalité de surveillance frontend d'ARMS propose également d'autres paramètres SDK pour répondre à vos besoins métier. Pour plus d'informations, consultez la section Référence SDK.