Application Real-Time Monitoring Service:Monitorar um mini programa do WeChat

Informações básicas

Para obter informações básicas sobre mini programas do WeChat, consulte a documentação de mini programas do WeChat.

Uso básico

Para monitorar um mini programa do WeChat com o ARMS Browser Monitoring, conclua as três etapas a seguir:

1. Obtenha o SDK de monitoramento de mini programas do WeChat e inicialize-o:

   1. No diretório /utils do projeto de mini programa do WeChat, crie um arquivo chamado wxLogger.js. Copie o conteúdo do arquivo JS do SDK de monitoramento e cole-o no arquivo wxLogger.js.

   2. No diretório /utils, crie um arquivo chamado monitor.js e adicione o código abaixo ao arquivo monitor.js para inicializar o SDK.

      Nota

      Você pode personalizar os nomes dos arquivos e os locais de armazenamento.

      • Se o projeto utilizar módulos Node.js (require), adicione o seguinte código:

        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;

      • Caso o projeto utilize módulos ES (import), adicione este código:

        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;

      Defina region como a região de implantação da aplicação: cn para China ou sg para regiões fora da China próximas a Singapore.

      Nota

      Para obter detalhes sobre as configurações de parâmetros, consulte

      Parâmetros do SDK

      .

2. Ative a instrumentação automática para coletar dados de PV, erros, API, desempenho e integridade:

   1. Em app.js, use o método Monitor.hookApp(options) para capturar logs de erro automaticamente. O parâmetro options corresponde à configuração Object da camada 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. No arquivo JS de cada página, use o método Monitor.hookPage(options) para relatar automaticamente solicitações de API, PV e dados de integridade.

      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. Configure o domínio de segurança: adicione o domínio do ARMS correspondente ao valor da sua region na lista de domínios de solicitação válidos do mini programa do WeChat.

   • Se region estiver definido como cn, adicione https://arms-retcode.aliyuncs.com à lista de domínios de solicitação válidos.

   • Se region estiver definido como sg, adicione https://arms-retcode-sg.aliyuncs.com à lista de domínios de solicitação válidos.

Parâmetros do SDK

O ARMS Browser Monitoring oferece parâmetros de configuração do SDK que atendem a requisitos adicionais. A tabela a seguir descreve os parâmetros de configuração comuns aplicáveis a mini programas do WeChat.

O ARMS Browser Monitoring também disponibiliza parâmetros adicionais de configuração do SDK para atender a outros requisitos. Para mais informações, consulte Parâmetros de configuração do SDK.

APIs de instrumentação automática

A tabela abaixo lista os métodos fornecidos pelo SDK de monitoramento de mini programas do WeChat para instrumentação automática do ciclo de vida.

Outras APIs de configuração

A tabela a seguir apresenta os métodos que você pode chamar para configurar o SDK de monitoramento de mini programas do WeChat e relatar dados.

Casos de uso avançados

Quando os métodos de instrumentação automática descritos em Uso básico não atenderem às suas necessidades, adote uma das configurações avançadas abaixo:

• Relate informações de API manualmente em vez de usar a instrumentação automática:

  1. Defina disableHook como true para desativar o relato automático de logs para solicitações wx.request.

  2. Chame manualmente o método api() para relatar informações da API.

• Desative a instrumentação automática e instrumente suas páginas manualmente:

  1. Não utilize os métodos hookApp ou hookPage nos arquivos JS do App e da Page.

  2. Para enviar dados de PV da página atual, chame o método pageShow() dentro do método onShow da página.

     Nota

     Não use este método juntamente com

     hookPage()

     . Caso contrário, o sistema relatará dados duplicados de PV.

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

  3. Para enviar dados de integridade da página atual, incluindo saúde da página e tempo de permanência, invoque o método pageHide() nos métodos onHide e onUnload da página.

     Nota

     Não combine este método com

     hookPage()

     . Isso evita o envio de dados de integridade duplicados.

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