Augmenter la journalisation de débogage pour le Chiffrement Edge proxy

Augmentez le niveau de journalisation pour interpréter les journaux et déboguer les problèmes avec le proxy.

Il existe actuellement trois options pour augmenter la journalisation des débogages dans le Chiffrement Edge proxy. Augmentez le niveau de journalisation pour déboguer les problèmes, fournissez à l’assistance technique des informations permettant d’examiner le problème grâce à des instructions de journal plus détaillées.

En fonction du problème en cours de débogage, configurez la journalisation des débogages de l’une des trois façons suivantes :

• Problèmes de débogage autres que la connectivité SSL
• Journalisation des mesures de minutage pour les demandes via le proxy
• Débogage des problèmes de connectivité SSL entre le proxy Chiffrement Edge et l’instance

Pour tous les tickets de débogage, vous pouvez afficher et interpréter les journaux dans votre propre entreprise ou ouvrir un incident pour obtenir une interprétation de ServiceNow l’assistance technique fournissant la description du problème et la façon dont il est reproduit.

Problèmes de débogage avec l’application autres que la Chiffrement Edge connectivité SSL

Utilisez cette méthode pour déboguer les problèmes de l’application Chiffrement Edge , sans arrêter ni redémarrer le proxy. Ces étapes augmentent le niveau de journalisation et aident à résoudre la cause première avec des instructions de journal plus détaillées.

Avant de commencer

Rôle requis : admin

Remarque :

Les modifications apportées au fichier $proxy_installation_location/conf/log4j2.properties sont prises en charge par le proxy dans les 60 secondes environ suivant vos modifications. Vous n’avez pas besoin de redémarrer les proxys.

Procédure

1. Dans le fichier $proxy_installation_location/conf/log4j2.properties , recherchez la ligne suivante.

   logger.edge.level=info

2. Remplacez la ligne ci-dessus par ce qui suit :

   logger.edge.level=debug

3. Enregistrez le changement.
   Cela peut prendre jusqu’à 60 secondes pour que le changement prenne effet, mais cela ne nécessite pas de redémarrage du proxy.
4. Reproduisez votre problème.
5. Vérifiez les instructions de journal de débogage associées à l’application dans le fichier $proxy_installation_location/logs/edgeencryption.log .

Résultats

Après avoir effectué le changement de propriété, vous pouvez voir des détails supplémentaires dans votre fichier $proxy_installation_location/logs/edgeencryption.log . Une fois le débogage terminé, rétablissez la modification apportée au fichier $proxy_installation_location/conf/log4j2.properties .

Journalisation des mesures de minutage pour les demandes via le proxy

Activez la journalisation des mesures de minutage pour ajouter une instruction de mesure pour chaque demande traitée par le Chiffrement Edge proxy. Chacune de ces instructions du journal de mesure de minutage contient des informations utiles sur la demande, telles que les durées de traitement et la règle de chiffrement utilisée.

Avant de commencer

Rôle requis : admin

Remarque :

Les paramètres de journalisation supplémentaires sont ajoutés au fichier $proxy_installation_location/conf/log4j2.properties . Les modifications apportées sont traitées dynamiquement par le proxy dans un délai d’environ une minute après les modifications apportées au fichier, de sorte que vous n’avez pas besoin de redémarrer les proxys.

Procédure

1. Modifiez le fichier $proxy_installation_location/conf/log4j2.properties en ajoutant les lignes suivantes à la fin du fichier

   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. Enregistrez le fichier.

Résultats

Une fois le fichier log4j.properties enregistré, les types de messages suivants apparaissent dans le fichier journal $proxy_installation_location/logs/edgenetwork.log pour les heures réseau.

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

Les valeurs des messages du journal sont les suivantes :

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

Déboguer les problèmes de connectivité SSL entre le Chiffrement Edge proxy et l’instance

Utilisez cette méthode pour déboguer les problèmes de connectivité SSL entre le Chiffrement Edge proxy et votre instance, tels que l’échec de l’accès à l’instance via le proxy. Ces étapes augmentent la journalisation et aident à trouver les instructions de journal détaillées.

Avant de commencer

Rôle requis : admin

Remarque :

Le débogage de connectivité SSL n’est pertinent que lors du dépannage des problèmes de type de connectivité TLS. En pratique, ce n’est pas courant et rarement nécessaire.

Procédure

1. Arrêtez le serveur proxy.
2. Ajoutez la ligne suivante au fichier $proxy_installation_location/conf/wrapper.conf, qui est une propriété de démarrage Java :

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

   Par exemple :

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

3. Enregistrez le changement et redémarrez le serveur proxy.
4. Reproduisez votre problème de connectivité.

Résultats

Après avoir reproduit le problème, les instructions du journal de débogage relatives à l’échange SSL se trouvent dans le fichier $proxy_installation_location/logs/wrapper_<current date>.log . Lorsque vous avez terminé le débogage. Vous pouvez supprimer à distance la journalisation supplémentaire en supprimant ou en commentant la ligne créée lors des étapes précédentes.