Como ativar os registros de depuração do NGINX nos roteadores

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Na Apigee, os roteadores são configurados para registrar apenas as mensagens de erro nos arquivos de registro de erros por padrão. No entanto, pode haver muitas situações em que você precise coletar mais informações para determinar por que um erro específico ocorreu. Uma das maneiras de fazer isso é configurar o roteador para operar no modo de depuração, para que você possa receber registros de depuração, que podem ajudar a obter mais informações sobre o erro e resolvê-lo mais rapidamente.

Este documento explica como ativar os registros de depuração no roteador do Apigee Edge para as solicitações em um host virtual específico. O registro de depuração pode ser ativado para capturar mais informações quando houver problemas, como solicitação malformada, 400 Bad Request - SSL Certificate Error, no Northbound (entre o aplicativo cliente e o roteador).

Antes de começar

  • Se você não estiver familiarizado com os registros de erros do NGINX e os níveis de registro, consulte a documentação do registro de erros do NGINX.
  • Reúna os nomes da organização, do ambiente e do host virtual das solicitações de API para as quais você precisa coletar informações de depuração.

Como ativar os registros de depuração do NGINX nos roteadores

Esta seção explica como ativar os registros de depuração nos roteadores de borda.

Como identificar o arquivo de configurações do host virtual relevante

As etapas a seguir descrevem como localizar o arquivo de configuração do host virtual relevante no roteador:

  1. Se você souber o nome da organização, o nome do ambiente e o host virtual da solicitação de API específica que quer depurar, determine o arquivo de configuração do host virtual da seguinte maneira:
    1. Navegue até o diretório /opt/nginx/conf.d/.
    2. Procure o arquivo ORG_NAME_ENV_NAME_VIRTUALHOST.conf no diretório conf.d usando o seguinte comando: 
      ls -ltrh | grep "ORG_NAME_ENV_NAME_VIRTUALHOST_NAME"

  2. Se você não souber o nome da organização, poderá identificar o arquivo de configuração do host virtual usando o nome do alias do host usado na solicitação de API da seguinte maneira:

    Navegue até o diretório /opt/nginx/conf.d/ e procure hostalias com que a solicitação foi feita usando o seguinte comando: 

    ls -ltrh | grep -r 'HOST_ALIAS_NAME'

    Exemplo de saída:

    Digamos que o nome do alias do host seja opdk.cert-test.com. Ao executar o ls -ltrh comando, você verá a saída mostrada abaixo:

Como ativar o registro de depuração para um host virtual específico no roteador

As etapas a seguir descrevem como ativar os registros de depuração nos roteadores da Apigee para um host virtual específico virtual.

  1. Abra o seguinte arquivo na máquina do roteador em um editor: /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf. Exemplo: 
    vi /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf
  2. Mude a seguinte linha: 
    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log error;

    a 

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log info;
  3. Salve as alterações.
  4. Execute o comando de recarga do NGINX. Exemplo: 
    sudo /opt/nginx/scripts/apigee-nginx reload
  5. O arquivo a seguir agora vai capturar registros de depuração: 
    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
  6. Se você quiser capturar registros de depuração em mais de um roteador, repita essas etapas em cada um de deles.

Como verificar se as informações de depuração estão registradas no arquivo de registro de erros do NGINX

  1. Depois que os clientes fizerem solicitações de API no alias do host e na porta associados à configuração do host virtual os registros de depuração serão capturados no seguinte arquivo:

    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log

  2. Verifique se as informações de depuração das solicitações de API estão sendo mostradas, conforme mostrado no exemplo a seguir:

    Exemplo de informações de depuração:

    2021/01/27 02:48:40 [warn] 27624#27624: *3777 a client request body is buffered to a temporary file /opt/apigee/var/log/edge-router/nginx/client_temp/0000000001, client: XX.XX.XX.XX, server: XX.XX.XX.XX, request: "POST /post-no-target HTTP/1.1", host: "XX.XX.XX.XX:443"

    As informações mostradas acima serão capturadas quando o cliente enviar uma solicitação POST com um payload grande. Esse registro será mostrado apenas quando o registro de depuração estiver ativado.

  3. Se você não encontrar informações de depuração adicionais, verifique se seguiu todas as etapas descritas em Como ativar o registro de depuração para um host virtual específico no roteador corretamente. Se você perdeu alguma etapa, repita todas as etapas corretamente.
  4. Se você ainda não conseguir receber as informações de depuração, entre em contato com o suporte do Apigee Edge.

Como desativar os registros de depuração para um host virtual específico no roteador

Esta seção explica como desativar os registros de depuração no roteador para um host virtual específico.

  1. Abra o seguinte arquivo na máquina do roteador em um editor: /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf Exemplo: 
    vi /opt/nginx/conf.d/ORG_NAME_ENV_NAME_VIRTUALHOST_NAME.conf

  2. Mude a seguinte linha: 

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log info;

    a 

    error_log /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log error;
  3. Salve as alterações.
  4. Execute o comando de recarga do NGINX. Exemplo: 
    /opt/nginx/scripts/apigee-nginx reload
  5. O arquivo a seguir agora vai capturar apenas registros de erro: 
    /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
  6. Se você quiser interromper os registros de depuração em mais de um roteador, repita essas etapas em cada um dos roteadores.

Como verificar se apenas informações de erro estão registradas no arquivo de registro de erros do NGINX

  1. Faça algumas solicitações de API no alias do host e na porta associados à configuração do host virtual específico ou aguarde que os clientes façam as solicitações.
  2. Verifique o seguinte arquivo: /opt/apigee/var/log/edge-router/nginx/ORG_NAME~ENV_NAME.PORT_error_log
  3. Verifique se você está vendo apenas as informações de erro e se as informações de depuração não estão mais registradas para as solicitações.
  4. Se você ainda encontrar informações de depuração adicionais sendo registradas, verifique se seguiu todas as etapas descritas em Como desativar os registros de depuração para um host virtual específico no roteador corretamente. Se você perdeu alguma etapa, repita todas as etapas corretamente.
  5. Se você ainda não conseguir receber as informações de depuração, entre em contato com o suporte do Apigee Edge.