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

Installez et initialisez le SDK de surveillance du navigateur d'Application Real-Time Monitoring Service (ARMS) dans votre mini-programme Alipay pour commencer à le surveiller. Cette rubrique décrit également les paramètres courants du SDK, les méthodes API et les scénarios avancés pris en charge par la surveillance du navigateur ARMS.

Prérequis

Le pid de l'application que vous souhaitez surveiller dans la surveillance du navigateur ARMS. Vous définissez cette valeur lors de l'initialisation du SDK.
Un projet de mini-programme Alipay dans lequel vous pouvez installer des packages npm.

Utilisation de base

Suivez les étapes ci-dessous pour intégrer le SDK de surveillance du navigateur ARMS à votre mini-programme Alipay :

Définissez le domaine de sécurité HTTP correspondant à la valeur region utilisée pour initialiser le SDK :
- Si vous définissez region sur cn, ajoutez arms-retcode.aliyuncs.com au domaine de sécurité HTTP.
- Si vous définissez region sur sg, ajoutez arms-retcode-sg.aliyuncs.com au domaine de sécurité HTTP.
Dans votre projet de mini-programme Alipay, installez le package npm @arms/js-sdk afin de pouvoir utiliser le module pour envoyer les journaux.
```
npm install @arms/js-sdk
```
Ajoutez le code suivant au fichier monitor.js situé dans le répertoire /utils pour finaliser l'initialisation.
```
import AlipayLogger from '@arms/js-sdk/miniapp';
const Monitor = AlipayLogger.init({
    pid: 'xxx',
    region: 'cn', // Specify the region where your application is deployed. Set this to cn for China or sg for regions outside China.
});

export default Monitor;
```
Remarque
Vous pouvez utiliser un nom et un emplacement personnalisés pour le fichier JS.

Pour obtenir une description des paramètres pid, region et des autres paramètres transmis à init(), consultez la section Paramètres courants du SDK.

Paramètres courants du SDK

La surveillance du navigateur ARMS met à disposition des paramètres de SDK que vous pouvez configurer pour répondre à des besoins supplémentaires. Le tableau suivant décrit les paramètres les plus utilisés.

Paramètre	Type	Description	Obligatoire	Valeur par défaut
	pid		String		L'identifiant unique du projet. Il est généré automatiquement par ARMS lors de la création d'un site.	Oui	Aucune
	uid		String		L'identifiant de l'utilisateur. Cette valeur sert d'identifiant pour l'utilisateur et permet de le rechercher. Vous pouvez spécifier une valeur personnalisée. Si vous ne définissez pas ce paramètre, le SDK le génère et le met à jour automatiquement tous les six mois.	Non	Généré automatiquement par le SDK
	tag		String		Le tag d'entrée. Chaque journal comporte un tag.	Non	Aucune
	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 de l'échantillonnage des journaux. La valeur est un entier compris entre 1 et 100. Les journaux de performance et les journaux d'API réussies 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éussies, consultez 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 l'analyse de trace bout en bout, consultez Diagnostiquer les erreurs d'API avec le traçage front-to-back.	Non	`false`

La surveillance du navigateur ARMS propose également davantage de paramètres de SDK pour répondre à des besoins plus spécifiques. Pour obtenir la liste complète, consultez la section Configuration du SDK de surveillance du navigateur.

Méthodes API

Méthode	Paramètre	Description
`setCommonInfo`	{[key: string]: string;}	Définit les champs de journal de base. Utilisez cette méthode pour des scénarios tels qu'un déploiement canari.
`setConfig`	{[key: string]: string;}	Définit le champ de configuration. Pour plus d'informations, consultez Référence du SDK.
`pageShow`	{}	Instrumente l'événement d'affichage de page et envoie les données de vues de page (PV).
`pageHide`	{}	Instrumente l'événement de masquage de page et envoie les données de santé.
`error`	String/Object	Instrumente et envoie les journaux d'erreurs.
`api`	Consultez Référence de l'API frontend	Envoie les journaux d'API.
`sum`/`avg`	String	Envoie les journaux personnalisés de somme et de moyenne.

Scénarios avancés

L'utilisation de base du SDK de surveillance du navigateur ARMS constitue le chemin par défaut, où le SDK envoie automatiquement les journaux. Si l'utilisation de base ne répond pas à vos besoins, utilisez l'un des scénarios avancés suivants.

Envoyer manuellement les informations d'API au lieu d'utiliser l'envoi automatique

Définissez disableHook sur true pour désactiver l'envoi automatique des journaux pour les requêtes my.httpRequest.
Appelez manuellement la méthode api() pour envoyer les informations d'API.

Désactiver l'envoi automatique et passer à l'instrumentation manuelle

Cessez d'utiliser les méthodes hookApp et hookPage dans les fichiers JS correspondant à App et Page.
Pour envoyer les données de vues de page (PV) de la page actuelle, appelez la méthode pageShow() dans la méthode onShow de la page.
```
import Monitor from '/utils/monitor';
Page({
    onShow: function() {
        Monitor.pageShow();
    }
})
```

Pour envoyer les données de santé de la page actuelle et collecter le temps de séjour sur la page, appelez la méthode pageHide() dans les méthodes onHide et onUnload de la page.

import Monitor from '/utils/monitor';
  Page({

      onHide: function() {
          Monitor.pageHide();
      },
      onUnload: function() {
          Monitor.pageHide();
      }
      // Other page lifecycle methods.
  })

Remarque

N'utilisez pas pageShow() ni pageHide() conjointement avec la méthode hookPage(). Sinon, les journaux seront envoyés plusieurs fois.

Application Real-Time Monitoring Service:Surveiller les mini-programmes Alipay