Como aumentar a depuração do registro em log para o proxy Edge Encryption

Aumente o nível de registro em log para interpretar os logs e depurar problemas com o proxy.

No momento, há três opções para aumentar a depuração do registro em log no proxy Edge Encryption. Aumentar o nível de registro em log para depurar problemas fornece informações ao suporte técnico para analisar o problema com o benefício de declarações de log mais detalhadas.

Dependendo do problema que está sendo depurado, configure a depuração do registro em log de uma das três maneiras:

• Depuração de problemas diferentes da conectividade SSL
• Métricas de tempo de registro em log para solicitações por meio do proxy
• Depuração de problemas com conectividade SSL entre o proxy Edge Encryption e a instância

Para todos os casos de depuração, você pode exibir e interpretar os logs por conta própria ou abrir um incidente para obter uma interpretação do suporte técnico da ServiceNow fornecendo a descrição do problema e como ele é reproduzido.

Depuração de problemas com a aplicação Edge Encryption diferente da conectividade SSL

Use este método para depurar problemas com a aplicação Edge Encryption, sem parar e reiniciar o proxy. Essas etapas aumentam o nível de registro em log e ajudam a solucionar problemas de causa raiz com mais declarações de log detalhadas.

Antes de Iniciar

Função necessária: admin

Nota:

As mudanças feitas no arquivo $proxy_installation_location/conf/log4j2.properties são aceitas pelo proxy em cerca de 60 segundos após você fazer suas mudanças. Você não precisa reiniciar os proxies.

Procedimento

1. No arquivo $proxy_installation_location/conf/log4j2.properties, localize a seguinte linha.

   logger.edge.level=info

2. Mude a linha acima para:

   logger.edge.level=debug

3. Salve a mudança.
   Pode levar até 60 segundos para que a mudança seja aplicada, mas isso não requer uma reinicialização do proxy.
4. Reproduza seu problema.
5. Verifique se há declarações de log de depuração relacionadas à aplicação no arquivo $proxy_installation_location/logs/edgeencryption.log.

Resultado

Depois de fazer a mudança de propriedade, você pode ver detalhes adicionais no arquivo $proxy_installation_location/logs/edgeencryption.log. Quando terminar a depuração, reverta a mudança feita no arquivo $proxy_installation_location/conf/log4j2.properties.

Métricas de tempo de registro em log para solicitações por meio do proxy

Habilite uma métrica de tempo de registro em log para adicionar uma declaração de métrica para cada solicitação tratada pelo proxy Edge Encryption. Cada uma dessas declarações de métrica de tempo de registro em log contém informações úteis sobre a solicitação, como tempos de processamento e qual regra de criptografia foi usada.

Antes de Iniciar

Função necessária: administrador

Nota:

As demais configurações de registro em log são adicionadas ao arquivo $proxy_installation_location/conf/log4j2.properties. As mudanças feitas são aceitas dinamicamente pelo proxy em cerca de um minuto após as mudanças no arquivo serem feitas. Dessa forma, você não precisa reiniciar os proxies.

Procedimento

1. Modifique o arquivo $proxy_installation_location/conf/log4j2.properties adicionando as seguintes linhas no fim do arquivo

   appender.timinglog.type=RollingFile
   appender.timinglog.name=TimingLog
   appender.timinglog.fileName=../logs/edgenetwork.log
   appender.timinglog.filePattern=../logs/$${date:yyyy-MM}/edgenetwork-%d{yyyy-MM-dd-HH}-%i.log.gz
   appender.timinglog.layout.type=PatternLayout
   appender.timinglog.layout.pattern=%d [%t] %-5p %m%n
   appender.timinglog.policies.type=Policies
   appender.timinglog.policies.size.type=SizeBasedTriggeringPolicy
   appender.timinglog.policies.size.size=500MB
   appender.timinglog.strategy.type=DefaultRolloverStrategy
   appender.timinglog.strategy.max=4
   
   logger.timing.name=com.snc.edgeencryption.metrics.EdgeEncryptionTimingMetricCache
   logger.timing.level=debug
   logger.timing.additivity=false
   logger.timing.appenderRef.rolling.ref=TimingLog

2. Salve o arquivo.

Resultado

Depois que o arquivo log4j.properties é salvo, os seguintes tipos de mensagens aparecem no arquivo de log $proxy_installation_location/logs/edgenetwork.log para tempos de rede.

2022-07-21 12:56:15,783 [qtp1971991758-7700] DEBUG com.snc.edgeencryption.metrics.EdgeEncryptionTimingMetricCache -  request_uri=/api/now/ui/presencesysparm_auto_request=true&cd=1658433375754 request_method=POST client_request_received="2022-07-21 12:56:15,015" proxy_request_processing_time=6 all_rules_processing_time=0 rule_executed="REST JSON" rule_execution_time=1 proxy_instance_round_trip=14 proxy_response_processing_time=1 total_time_from_proxy=21 reponse_code=201 glide_user=SCv3_1:BAz1ZK7ee9XoroG2nvMlixHpgTvsT4fY2bwQvnH2WdU=:y5HGsTTqo3Pjq6G0xk4LoazCwCiWRJk4/6SpbXuBzqg=:6816f79cc0a8016401c5a33be04be441 jsessionid_suffix=037A66

Os valores nas mensagens de log são os seguintes:

request_uri: The URI being requested

request_method: The HTTP method being used, for example, GET, POST, PUT, PATCH, DELETE

client_request_received: The timestamp noting when the HTTP client request arrived at the Edge proxy

proxy_request_processing_time: How long the Edge proxy took to process the request in milliseconds

all_rules_processing_time: Total time it took to execute all of the Edge Encryption rules for the request in milliseconds

rule_executed: The name of the encryption rule that was executed

rule_execution_time: How long it took to execute listed rule_executed in milliseconds

proxy_instance_round_trip: The time from when the Edge proxy sent the request to the instance until the instance sent the response and was received by the edge proxy in milliseconds

proxy_response_processing_time: How long the Edge proxy took to process the response in milliseconds

total_time_from_proxy: The total time from when the Edge proxy received the request from the client and returned the response to the client in milliseconds

response_code: HTTP response code 

glide_user: The glide_user cookie value

jsessionid_suffix: The JSession cookie suffix associated with the request

Como depurar problemas com conectividade SSL entre o proxy Edge Encryption e a instância

Use este método para depurar problemas com conectividade SSL entre o proxy Edge Encryption e sua instância, como falha de acesso à instância por meio do proxy. Essas etapas aumentam o registro em log e ajudam a encontrar declarações de log detalhadas.

Antes de Iniciar

Função necessária: admin

Nota:

A depuração de conectividade SSL só é relevante ao solucionar problemas do tipo de conectividade TLS. Na prática, isso não é comum e raramente necessário.

Procedimento

1. Interrompa o servidor proxy.
2. Adicione a seguinte linha ao arquivo $proxy_installation_location/conf/wrapper.conf, que é uma propriedade de inicialização do Java:

   wrapper.java.additional.<next available number in sequence> = -Djavax.net.debug=all
   

   Por exemplo:

   For example: wrapper.java.additional.4 = -Djavax.net.debug=all

3. Salve a mudança e reinicie o servidor proxy.
4. Reproduza seu problema de conectividade.

Resultado

Depois de reproduzir a depuração do problema, as declarações do log relacionadas à troca de SSL podem ser encontradas no arquivo $proxy_installation_location/logs/wrapper_<current date>.log. Quando terminar a depuração, você pode remotamente fazer o registro em log adicional removendo ou comentando a linha criada nas etapas anteriores.