Duas ferramentas importantes à sua disposição para a integridade e o monitoramento do sistema são os registros e os alertas de sistema da Experience API.
Registros da Experience API
Esses registros oferecem uma visão geral detalhada de suas chamadas de API do back end, incluindo eventos, visualizações de página, cliques e chamadas do tipo choose. Eles permitem que você verifique que suas chamadas de API estão corretas e identifique problemas de implementação. Você também pode usar registros para solucionar comportamentos inesperados e encontrar a causa.
Para acessar os registros da API, acesse Settings › API Logs.
Detalhes do registro da API
A linha do tempo agrupa as chamadas de API em chamadas bem-sucedidas, chamadas com erros e chamadas com avisos. Passe o mouse sobre uma barra para obter mais detalhes.
Abaixo da linha do tempo, uma tabela lista as chamadas recentes de API que ocorreram no intervalo de tempo selecionado. Pressione Load More para ver mais chamadas de API.
Os campos a seguir estão disponíveis. Para exibir mais campos, clique em Columns na parte superior da página de registros da API.
|
Coluna |
Detalhes |
|---|---|
|
Endpoint |
O tipo de chamada de API, como choose ou pageview |
|
Detail |
Detalhes sobre o tipo de solicitação, como que tipo de evento foi chamado |
|
Request ID |
Um identificador exclusivo para cada chamada de API |
|
Status |
Exibe o código de status. 200 ou 204 significa que tudo correu bem. Outros códigos são descritos ao lado do código. |
|
User ID |
O ID do usuário fornecido na solicitação da API |
|
Session ID |
O ID da sessão fornecido na solicitação da API |
|
Timestamp |
Exibido com precisão de segundos |
|
Request Duration |
O tempo que a solicitação passou nos servidores da Dynamic Yield (exclui o tempo em trânsito) |
Você pode detalhar qualquer chamada de API para ver mais detalhes clicando em qualquer lugar na linha. Essa resposta só está disponível para registros com menos de 32 KB. Se a resposta exceder esse limite, ela não aparecerá no registro (não significa que houve um erro na resposta em si ou que ela não foi entregue corretamente).
Selecionando um intervalo de tempo
Você pode especificar o intervalo de tempo usando o seletor de datas:
Você também pode ampliar um intervalo de tempo específico clicando e arrastando uma caixa acima do intervalo que deseja.
Um banner indicando o intervalo de tempo que você definiu será exibido. Você pode desfazer o zoom clicando em X.
Filtro de registros
Clique nos filtros à direita para filtrar as chamadas de API por data, duração, tipo, status ou erros. O número de chamadas por filtro aparece ao lado de cada opção de filtro.
Várias seleções sob o mesmo tipo de filtro (por exemplo, Choose e Pageview no filtro de Tipo) são consideradas com a lógica “OU”, enquanto várias seleções sob filtros de tipos diferentes (por exemplo, Pageview na seção de tipo e Erros na seção de status) são considerados com a lógica “E”.
Você também pode filtrar usando a ferramenta de pesquisa para especificar um userID ou um requestID.
Casos de uso
|
Caso de uso |
Resolução |
|---|---|
|
Durante a implementação inicial, estou fazendo chamadas para a API para verificar se todos os atributos foram recebidos com os valores pretendidos (contexto, tipo, etc.) e sem avisos. |
Abra o registro da API e monitore as chamadas recebidas usando o botão de atualizar para ver as últimas chamadas. |
|
Durante a implementação, notei que há alguns avisos nas chamadas da API. |
Selecione a linha no registro da API para ver mais detalhes. Você pode ver os avisos completos, incluindo, por exemplo, SKUs específicos ausentes. |
|
Na produção (ou em qualquer outro ambiente de alto volume), eu suspeito que existem algumas chamadas de API problemáticas, mas não tenho certeza exatamente quando elas estão acontecendo. |
Você pode ampliar um intervalo de tempo específico que tenha um volume alto de erros ou avisos. Você também pode usar filtros para visualizar apenas Chamadas de API com os erros ou avisos que você está procurando. |
|
Em uma plataforma de alto volume, quero ver o que um usuário está fazendo. |
Digite o ID do usuário na barra de pesquisa para filtrar o registro. |
|
Alguém quer me falar sobre um problema compartilhando um marcador ou referência ao problema. |
Isso pode ser feito inserindo o ID do usuário na barra de pesquisa. Se você não tiver o ID do usuário, insira o ID da solicitação e use-a para procurar o ID do usuário nos resultados filtrados. |
|
Eu sei que há erros/avisos e quero saber “quando quebrou”, para que eu possa (a) entender o escopo do problema, (b) correlacioná-lo com as alterações que fiz |
Amplie até um intervalo de tempo suspeito e, em seguida, use os filtros para restringir os resultados para um tipo específico de erro ou aviso. |
|
Eu apliquei uma correção a algum erro/aviso e quero ver se não há mais solicitações com esse tipo de problema |
Use o controle de intervalo de tempo e/ou filtros para ver se/quando um problema parou de ocorrer e se foi resolvido total ou parcialmente. |
Alertas
Os alertas fornecem visibilidade sobre a integridade de sua implementação de API, permitindo que você comunique facilmente problemas contínuos de implementação com seus departamentos de TI/P&D e agilize a resolução dos problemas subjacentes.
Como funciona?
- Os erros e avisos da API que ocorrem com frequência são exibidos como um alerta no Painel do administrador
- Clique em Exibir resumo do problema para abrir um pop-up que fornece informações sobre o problema, incluindo tipo, causa e frequência. Ou clique em Exibir registros para ir diretamente para a tela de registros da API.
- A partir daqui, você pode ver os registros de erros ou copiá-los para sua área de transferência para compartilhá-los com a TI/P&D.
- É provável que o número de alertas da API seja significativamente maior do que o número de erros de API no registro. Isso ocorre porque um único registro de erros da API pode apresentar vários problemas, acionando assim vários alertas.
- Para que um alerta seja exibido no painel do administrador, ele deve ocorrer mais de 50 vezes. Isso é definido para garantir que apenas erros significativos e importantes sejam alertados.
- Os registros de erros são salvos por 7 dias. Se você tentar visualizar registros de erros mais antigos que 7 dias, a tela de registros da API não exibirá nenhum resultado.