Este tópico descreve como usar o recurso de monitoramento de frontend do Application Real-Time Monitoring Service (ARMS) para monitorar miniprogramas do DingTalk. O conteúdo também aborda configurações gerais, métodos e cenários avançados desse recurso.
Procedimento
Para monitorar um miniprograma do DingTalk, importe e inicialize o pacote npm necessário para o monitoramento, instrumente o miniprograma para relatar logs e configure o domínio de segurança.
-
Importe e inicialize o pacote npm.
-
Importe o pacote npm
arms/js-sdkpara o miniprograma do DingTalk. Use esse pacote para relatar logs.npm install @arms/js-sdk -
Adicione o código abaixo ao arquivo monitor.js no diretório /utils para inicializar o pacote npm.
NotaVocê pode personalizar o nome e o caminho de armazenamento do arquivo 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;NotaPara obter mais informações sobre as configurações de parâmetros, consulte Parâmetros comuns do SDK.
-
-
Defina os domínios de segurança.
Se o parâmetro region estiver definido como
cn, adicione arms-retcode.aliyuncs.com ao domínio de segurança HTTP.Se o parâmetro region estiver definido como
sg, adicione arms-retcode-sg.aliyuncs.com ao domínio de segurança HTTP.Se o parâmetro region estiver definido como
us, adicione arms-retcode-us.aliyuncs.com ao domínio de segurança HTTP.
Outros métodos da API
|
Método |
Sintaxe |
Descrição |
|
setCommonInfo |
{[key: string]: string;} |
Define campos básicos de log para cenários como lançamento canário. |
|
setConfig |
{[key: string]: string;} |
Define o campo config. Para obter mais informações, consulte a Referência do SDK. |
|
pageShow |
{} |
Instrumenta logs de PV. |
|
pageHide |
{} |
Instrumenta logs de integridade. |
|
error |
String/Object |
Relata logs de erro. |
|
api |
Para obter mais informações, consulte os Métodos do SDK. |
Relata logs de requisição de API. |
|
sum/avg |
String |
Relata logs personalizados de soma e média. |
Cenários avançados
Se os métodos básicos não atenderem aos seus requisitos, considere os seguintes cenários avançados:
-
Relate manualmente os logs de requisição de API com o relatório automático desativado.
Defina o parâmetro disableHook como
true. Os logs do método dd.httpRequest não serão relatados automaticamente.Chame manualmente o método
apipara relatar os logs de requisição de API.
-
Desative o relatório automático e ative a instrumentação manual.
Não use os métodos
hookAppehookPagenos arquivos app.js e page.js.-
Para relatar os logs de PV da página, chame o método
pageShowno métodoonShow.NotaNão chame o método pageShow junto com o método
hookPage. Caso contrário, os logs de PV serão relatados repetidamente.import Monitor from '/util/monitor'; Page({ onShow: function() { Monitor.pageShow(); } }) -
Para relatar logs de integridade que indicam o nível de saúde e o tempo de navegação na página, chame o método
pageHidenos métodosonHideeonUnload.NotaNão chame o método pageHide junto com o método
hookPage. Caso contrário, os logs de integridade serão relatados repetidamente.import Monitor from '/util/monitor'; Page({ onHide: function() { Monitor.pageHide(); }, onUnload: function() { Monitor.pageHide(); } ... })
Parâmetros comuns do SDK
O recurso de monitoramento de frontend do ARMS permite configurar diversos parâmetros do SDK para atender a requisitos adicionais. A tabela a seguir descreve os parâmetros comuns adequados aos cenários descritos neste tópico.
|
|
|
|
|
pid | String | ID exclusivo do projeto. O ARMS gera esse ID automaticamente ao criar um site. | Sim | Nenhum |
uid | String | ID do usuário. Esse valor identifica o usuário e permite buscá-lo. Você pode especificar um valor personalizado. Se você não especificar esse parâmetro, o SDK gerará e atualizará o identificador automaticamente a cada seis meses. | Não | Gerado automaticamente pelo SDK |
tag | String | Tag de entrada. Cada log carrega uma tag. | Não | Nenhum |
release | String | Versão do aplicativo. Configure este parâmetro para visualizar informações de relatório de diferentes versões. | Não |
|
environment | String | Campo de ambiente. Valores válidos: prod, gray, pre, daily e local.
| Não |
|
sample | Integer | Configuração de amostragem de logs. O valor é um número inteiro de 1 a 100. Os logs de desempenho e de sucesso de API são amostrados na proporção de | Não |
|
behavior | Boolean | Especifica se deve registrar o comportamento do usuário que relata erros para facilitar a solução de problemas. | Não |
|
enableLinkTrace | Boolean | Para obter mais informações sobre rastreamento ponta a ponta, consulte Diagnosticar erros de API com rastreamento ponta a ponta. | Não |
|
O recurso de monitoramento de frontend do ARMS também fornece outros parâmetros do SDK para atender aos seus requisitos de negócios. Para obter mais informações, consulte a Referência do SDK.