Monitorar miniprogramas do Alipay - Application Real-Time Monitoring Service: Central de Documentação do Alibaba Cloud

Uso básico

Importe e inicialize o pacote npm.
1. No projeto do miniprograma, importe o pacote npm @arms/js-sdk para facilitar o envio de logs.
```
npm install @arms/js-sdk
```
2. Adicione as informações abaixo ao arquivo monitor.js no diretório /utils para inicializar o pacote.
  
  Nota
  Especifique o nome e o caminho de armazenamento do arquivo JavaScript (JS).
```
import AlipayLogger from '@arms/js-sdk/miniapp';
const Monitor = AlipayLogger.init({
    pid: 'xxx',
    region: 'cn', // The region where the application is deployed. Set region to cn if the application is deployed in China and set region to sg if the application is deployed outside China.
});

export default Monitor;              
```
  Nota
  Para mais detalhes sobre as configurações de parâmetros, consulte Parâmetros comuns do SDK.
Configure os domínios de segurança.
- Se region estiver definido como cn, adicione arms-retcode.aliyuncs.com ao domínio de segurança HTTP.
- Caso region esteja definido como sg, adicione arms-retcode-sg.aliyuncs.com ao domínio de segurança HTTP.

Outros métodos de API

Método	Parâmetro	Descrição
setCommonInfo	{[key: string]: string;}	Define campos básicos de log para cenários como liberação gradual.
setConfig	{[key: string]: string;}	Define o campo config. Para mais informações, consulte Referência do SDK.
pageShow	{}	Instrumenta dados de PV.
pageHide	{}	Instrumenta dados de integridade.
error	String/Object	Instrumenta logs de erro.
api	Para mais informações, consulte Métodos do SDK.	Envia logs de API.
sum/avg	String	Envia logs personalizados de soma e média.

Cenários avançados

Se o uso básico não atender às suas necessidades, consulte os cenários avançados a seguir:

Envie manualmente os resultados das solicitações de API.
1. Defina disableHook como true. Os logs de my.httpRequest não serão enviados automaticamente.
2. Chame manualmente o método api() para enviar as operações de API.
Desative o envio automático e ative a instrumentação manual.
1. Não use os métodos hookApp e hookPage nos arquivos app.js e page.js.
2. Para enviar os dados de PV da página, chame o método pageShow() no método onShow.
  
  Nota
  Não chame o método pageShow() juntamente com o método hookPage(). Caso contrário, os logs de PV serão enviados duplicadamente.
```
import Monitor from '/util/monitor';
Page({
    onShow: function() {
        Monitor.pageShow();
    }
})
```
3. Para enviar os dados de integridade da página (saúde e tempo de navegação), chame o método pageHide() nos métodos onHide e onUnload.
  
  Nota
  Não chame o método pageHide() juntamente com o método hookPage(). Caso contrário, os logs serão enviados duplicadamente.
```
import Monitor from '/util/monitor';
  Page({

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

Parâmetros comuns do SDK

O monitoramento de navegador do ARMS oferece diversos parâmetros de SDK. Configure-os para atender a requisitos adicionais. A tabela a seguir descreve os parâmetros comuns adequados aos cenários apresentados neste tópico.


pid	String	ID exclusivo do projeto. O ARMS gera esse ID automaticamente durante a criação de um site.	Sim	Nenhum
uid	String	ID do usuário. Funciona como identificador e permite buscar o usuário. Defina um valor personalizado. Se você não especificar este parâmetro, o SDK gerará e atualizará o ID automaticamente a cada seis meses.	Não	Gerado automaticamente pelo SDK
tag	String	Tag de entrada. Cada log carrega uma tag associada.	Não	Nenhum
release	String	Versão do aplicativo. Configure este parâmetro para visualizar informações de relatórios de diferentes versões.	Não	`undefined`
environment	String	Campo de ambiente. Valores válidos: prod, gray, pre, daily e local. O valor prod indica um ambiente online. O valor gray indica um ambiente de liberação gradual. O valor pre indica um ambiente de staging. O valor daily indica um ambiente diário. O valor local indica um ambiente local.	Não	`prod`
sample	Integer	Configuração de amostragem de log. O valor deve ser um número inteiro de 1 a 100. Os logs de desempenho e os logs de API bem-sucedida são amostrados na proporção de `1/sample`. Para mais informações sobre as métricas desses logs, consulte Métricas estatísticas.	Não	`1`
behavior	Boolean	Define se o comportamento do usuário que gera erros deve ser registrado para facilitar a solução de problemas.	Não	`false`
enableLinkTrace	Boolean	Para mais informações sobre rastreamento ponta a ponta, consulte Diagnosticar erros de API com rastreamento ponta a ponta.	Não	`false`

O monitoramento de navegador do ARMS também fornece outros parâmetros de SDK. Para mais informações, consulte Referência do SDK.

Uso básico

Outros métodos de API

Cenários avançados

Parâmetros comuns do SDK

Tópicos relacionados