A API Local está sendo descontinuada. Consulte o documento Descontinuação da API Local para ver mais informações e saber como migrar para nossa API de Nuvem de última geração.

Registros de suporte

Além de recuperar suas informações de suporte usando o support, você também pode recuperar registros do Docker e da AWS, bem como IDs de solicitação HTTP para resolver problemas.

Este documento abrange o seguinte:

Consulte o Suporte Direto para saber como abrir um tíquete.

Recuperar registros do Docker

Com a WADebug (preferencial)

Use a ferramenta WADebug para coletar e carregar registros automaticamente. Como parte da resposta, você receberá um run_id que pode ser mencionado no Suporte Direto para agilizar as investigações. É simples como executar este comando:

  wadebug logs --send

Observação: no modo de alta disponibilidade/multiconexão, em que os contêineres são instalados em um host ou mais, será necessário acessar cada host, instalar a WADebug e executar o comando acima. Você receberá um run_id de cada execução bem-sucedida do comando que mencionar ao Suporte Direto para agilizar as investigações.

Com o Docker

Caso não seja possível usar a ferramenta WADebug, utilize o comandodocker logs para recuperar os registros de cada contêiner separadamente. Por exemplo, para recuperar registros do contêiner waweb, execute o seguinte comando:

docker logs <container id of waweb> >> waweb.log

É possível usar as várias opções de comando docker logs para limitar o tamanho dos arquivos de registro. Por exemplo, para obter as últimas 1.000 linhas de registros do contêiner waweb, execute este comando:

docker logs <container id of waweb> --tail 1000 >> waweb.log

Para obter somente os registros do contêiner waweb de um intervalo de tempo específico, execute o comando com as opções --since e --until. Por exemplo:

docker logs <container id of waweb> --since 2020-01-20T20:00:00Z --until 2020-01-21T08:00:00Z >> waweb.log

Execute o comando com todos os contêineres do WhatsApp e envie esses arquivos ao WhatsApp para que sejam analisados e depurados. Consulte a documentação oficial sobre docker logs para mais opções.

Observação: todos os registros de contêiner estão no fuso horário GMT. É preciso passar registros de data e hora GMT para os parâmetros --since e --until.

Como usar o Docker Compose

Para obter todos os registros de todos os contêineres do WhatsApp, execute o seguinte comando:

WA_API_VERSION=new-whatsapp-version docker-compose logs > debug_output.txt

Observação: esse comando pode gerar arquivos de registro muito grandes. Consulte a seção "Como usar o Docker" para ver opções de como recuperar registros menores e mais relevantes.

Depois, você pode enviar esses arquivos ao WhatsApp para que sejam analisados e depurados.

Registros de falha

Implementamos um novo sistema de registro de falhas na versão 2.53, que salva arquivos de dump sempre que ocorre uma falha. Esses arquivos, conhecidos como dump de falha, ficam armazenados no diretório logs/ por 30 dias. Eles são armazenados no local em máquinas e podem ser recuperados da mesma forma que os arquivos de registro. Os dumps podem incluir dados de memória associados à cadeia com falha.

Recuperar registros do Kubernetes

Com kubectl

Para obter registros de um determinado serviço implantado (como o Webapp) em uma configuração que use o Kubernetes, execute o seguinte comando:

kubectl logs deployments/whatsapp-web-deployment > whatsapp-web-deployment.txt

Depois, você pode enviar esse arquivo ao WhatsApp para que seja analisado e depurado.

Recuperar registros da AWS

Siga as etapas abaixo para coletar os registros em uma configuração que use AWS:

Defina Rollback on Failure como No para garantir que os registros não sejam excluídos em caso de falha

É preciso definir isso durante a etapa de criação/atualização da pilha, conforme abaixo:

Obtenha eventos e registros de criação de pilha do CloudFormation no console do CloudWatch


Conecte à sua instância do EC2 (se criada com sucesso)

Siga as instruções do guia da AWS sobre como usar SSH para conectar à instância do EC2. Observe que durante a criação/atualização da pilha da WhatsApp Business API, é possível usar uma VPC privada ou pública. Com a VPC privada, siga as orientações na seção Securely Connect to Linux Instances Running in a Private Amazon VPC (em inglês).

Como obter os registros

Quando tiver acesso ao contêiner, reúna e anexe os seguintes registros ao tíquete do Suporte Direto.

  1. sudo docker logs ecs-agent > ecs-agent.log
  2. Compacte no formato ZIP e recupere /var/log de todas as instâncias do EC2 criadas pela pilha.
  3. Instale a WADebug em todas as instâncias do EC2 e execute os comandoswadebug logs para coletar os registros de todos os contêineres.
  4. Se não for possível usar WADebug na etapa 3, execute os seguintes comandos para coletar os registros de modo manual:
    • Execute docker ps -a para listar todos os contêineres em execução e compartilhe a saída.
    • Execute docker logs <docker container id of the core app> >> wacore.log e compartilhe os registros.
    • Execute docker logs <docker container id of the web app> >> waweb.log e compartilhe os registros.
    • Execute docker cp <docker container id of the web app>:/var/log/whatsapp/web.log ./web.log e compartilhe os registros.
    • Execute docker cp <docker container id of the web app>:/var/log/lighttpd/error.log ./error.log e compartilhe os registros.

Histórico de atividades

Se a instância do EC2 não for criada, a opção Activity History do grupo de dimensionamento automático correto será obrigatória. Para encontrar essa opção, acesse o console do EC2 -> Auto Scaling -> Auto Scaling Groups. Depois, selecione o grupo apropriado para a pilha com problemas e selecione a aba Activity History.

Como coletar IDs de solicitação HTTP

A partir da v2.21.3, a WhatsApp Business API gera IDs de solicitação únicos para cada solicitação HTTP recebida. Esses IDs são usados para ajudar a identificar os registros relacionados a uma determinada solicitação a fim de agilizar a solução de problemas. Caso você queira reportar um erro, inclua os valores dos cabeçalhos de resposta X-Request-ID e X-Internal-Request-IDS no tíquete para facilitar a identificação e reprodução do problema.