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

Instale e inicialize o SDK do Browser Monitoring do Application Real-Time Monitoring Service (ARMS) no seu miniprograma do Alipay para iniciar o monitoramento. Este tópico também descreve os parâmetros comuns do SDK, os métodos da API e os cenários avançados compatíveis com o Browser Monitoring do ARMS.

Pré-requisitos

O pid da aplicação que você deseja monitorar no Browser Monitoring do ARMS. Defina esse valor ao inicializar o SDK.
Um projeto de miniprograma do Alipay no qual seja possível instalar pacotes npm.

Uso básico

Siga as etapas abaixo para integrar o SDK do Browser Monitoring do ARMS ao seu miniprograma do Alipay:

Configure o domínio de segurança HTTP correspondente ao valor de region usado na inicialização do SDK:
- Se definir region como cn, adicione arms-retcode.aliyuncs.com ao domínio de segurança HTTP.
- Se definir region como sg, adicione arms-retcode-sg.aliyuncs.com ao domínio de segurança HTTP.
No projeto do miniprograma do Alipay, instale o pacote npm @arms/js-sdk para habilitar o módulo de relatório de logs.
```
npm install @arms/js-sdk
```
Adicione o código a seguir ao arquivo monitor.js no diretório /utils para concluir a inicialização.
```
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;
```
Nota
Você pode usar um nome e um local personalizados para o arquivo JS.

Para obter descrições de pid, region e dos demais parâmetros transmitidos para init(), consulte Common SDK parameters.

Parâmetros comuns do SDK

O Browser Monitoring do ARMS oferece parâmetros de SDK configuráveis para atender a requisitos adicionais. A tabela a seguir descreve os parâmetros mais utilizados.

Parâmetro	Tipo	Descrição	Obrigatório	Padrão
	pid		String		ID exclusivo do projeto. O ARMS gera esse ID automaticamente durante a criação de um site.	Sim	Nenhum
	uid		String		Identificador do usuário. Utilizado para buscar o usuário nos logs. Aceita valores personalizados. Se você não especificar esse parâmetro, o SDK gerará e atualizará o valor 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 da aplicação. Recomendamos configurar este parâmetro para visualizar relatórios segmentados por versão.	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 logs. Valor inteiro entre 1 e 100. Os logs de desempenho e de sucesso da API são amostrados na proporção de `1/sample`. Para mais detalhes sobre as métricas desses logs, consulte Statistical metrics.	Não	`1`
	behavior		Boolean		Define se o comportamento do usuário deve ser registrado em caso de erros, facilitando a solução de problemas.	Não	`false`
	enableLinkTrace		Boolean		Para mais informações sobre rastreamento ponta a ponta, consulte Diagnose API errors with front-to-back tracing.	Não	`false`

O Browser Monitoring do ARMS também disponibiliza outros parâmetros de SDK para necessidades específicas. Para a lista completa, consulte Browser Monitoring SDK configuration.

Métodos da API

Método	Parâmetro	Descrição
`setCommonInfo`	{[key: string]: string;}	Define campos básicos de log. Ideal para cenários como liberações canário.
`setConfig`	{[key: string]: string;}	Define o campo config. Para mais detalhes, consulte SDK reference.
`pageShow`	{}	Instrumenta o evento de exibição da página e relata dados de visualização de página (PV).
`pageHide`	{}	Instrumenta o evento de ocultação da página e relata dados de integridade.
`error`	String/Object	Instrumenta e relata logs de erro.
`api`	Consulte Frontend API reference	Relata logs de API.
`sum`/`avg`	String	Relata logs personalizados de soma e média.

Cenários avançados

O uso básico do SDK do Browser Monitoring do ARMS segue o caminho padrão, com relato automático de logs. Se essa abordagem não atender às suas necessidades, utilize um dos cenários avançados abaixo.

Relatar informações da API manualmente em vez de usar o relato automático

Defina disableHook como true para desativar o relato automático de logs de requisições my.httpRequest.
Chame manualmente o método api() para relatar as informações da API.

Desativar o relato automático e adotar instrumentação manual

Pare de usar os métodos hookApp e hookPage nos arquivos JS correspondentes a App e Page.
Para enviar dados de visualização de página (PV) da página atual, chame o método pageShow() dentro do método onShow da página.
```
import Monitor from '/utils/monitor';
Page({
    onShow: function() {
        Monitor.pageShow();
    }
})
```

Para enviar dados de integridade da página atual e coletar o tempo de permanência, chame o método pageHide() dentro dos métodos onHide e onUnload da página.

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

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

Nota

Não use pageShow() ou pageHide() junto com o método hookPage(). Caso contrário, ocorrerá duplicidade no relato de logs.

Application Real-Time Monitoring Service:Monitorar miniprogramas do Alipay