Visão geral ddo Debug

Esta é a documentação da Apigee X.
Veja a documentação da Apigee Edge.

O Debug é uma ferramenta de solução de problemas e monitoramento de proxies de API em execução na Apigee. A ferramenta Debug permite que você examine os detalhes de cada etapa por meio de um fluxo de proxy da API. A Apigee permite coletar dados de depuração, que mostram todo o fluxo de solicitação/resposta dos proxies da API. Isso inclui todos os parâmetros de solicitação/resposta e as transformações aplicadas a eles no tempo de execução da política. Isso é importante para a depuração e a solução de problemas durante o desenvolvimento e a implantação do proxy de API.

Como usar a depuração

Crie e gerencie sessões de depuração usando a ferramenta Debug usando a IU ou a API, conforme descrito em Como usar o Debug. Também é possível fazer o download de sessões de depuração, visualizar e analisá-las off-line, conforme descrito em Como usar o Debug Off-line.

Uso do Debug do suporte da Apigee

Por padrão, a Apigee permite o uso da ferramenta Debug nos proxies de API para oferecer suporte.

Observações:

  • O suporte da Apigee tem permissão somente leitura aos dados do Debug.
  • O suporte da Apigee pode solicitar que você execute um rastreamento para coletar informações sobre um problema e que você forneça o ID da sessão de rastreamento ou um link para a sessão de rastreamento para que o suporte possa analisar o rastreamento capturado. Como as sessões de rastreamento salvas são válidas por apenas 24 horas, é recomendável fazer o download dela e anexá-la ao caso aberto com suporte para ativar a visualização off-line.

Para usuários da Apigee híbrida

Se você estiver usando a Apigee híbrida, leia as seções a seguir.

Arquitetua do Debug

O exemplo a seguir ilustra o processo de criação de uma nova sessão de depuração:

Visualização de alto nível de uma solicitação para iniciar uma sessão de depuração:
    1 Você inicia uma solicitação para começar uma sessão de depuração com a IU ou a API.
    2. O plano de gerenciamento emite uma solicitação de criação de sessão de depuração para o plano de execução usando o modelo pub/sub.
    3. O sincronizador, que se inscreve para depurar notificações da sessão, propaga a solicitação de criação para os processadores de mensagens.
    4. Os MPs coletam dados de depuração e os transmitem para um pod de coleta de dados.
    5. O fluentd grava imediatamente os dados de depuração no sistema de arquivos do pod.
    6. A UDCA pesquisa novos arquivos de dados no sistema de arquivos do pod.
    7. Quando encontra um novo arquivo de dados, a UDCA faz upload dele para o serviço UAP.
    8. É possível acessar os dados por meio dos serviços da Apigee, como a IU híbrida da Apigee ou as APIs da Apigee.

Os dados de Debug são mantidos no plano de gerenciamento por até 24 horas.

Pré-requisitos

Se você estiver usando a Apigee híbrida, antes de poder usar a depuração, verifique se os seguintes itens estão configurados:

Contas de serviço:

  • apigee-synchronizer (papel: gerenciador de sincronização da Apigee)
  • apigee-udca (papel: agente de análise da Apigee)

Para mais informações sobre a versão híbrida v1.3, consulte Criar contas de serviço, para sua plataforma, da seguinte maneira:

Sincronizadores: