エッジ暗号化 プロキシのデバッグログ記録を増やす

ログ記録のレベルを上げて、ログを解釈し、プロキシの問題をデバッグします。

現在、エッジ暗号化 プロキシのデバッグログを増やすための、3 つのオプションがあります。問題をデバッグするためにログ記録のレベルを上げることで、問題を調査するためのより詳細なログステートメントでの情報をテクニカルサポートに提供できます。

デバッグしている問題に応じて、次の 3 つの方法のいずれかでデバッグログを設定します。

• SSL 接続以外の問題のデバッグ
• プロキシを介した要求のタイミングメトリクスのログ記録
• エッジ暗号化プロキシとインスタンス間の SSL 接続に関する問題のデバッグ

すべてのデバッグケースについて、自分でログを表示して解釈するか、インシデントを開いて ServiceNow テクニカルサポートから問題の説明とその再現方法について解釈を得ることができます。

SSL 接続以外の エッジ暗号化 アプリケーションに関する問題のデバッグ

この方法を使用して、プロキシを停止して再起動することなく、エッジ暗号化 アプリケーションの問題をデバッグします。これらの手順により、ログ記録レベルが向上し、詳細なログステートメントを使用して根本原因のトラブルシューティングを行うことができます。

始める前に

必要なロール：admin

注:

$proxy_installation_location/conf/log4j2.properties ファイルに加えられた変更は、変更を行ってから約 60 秒以内にプロキシによって取り込まれます。プロキシを再起動する必要はありません。

手順

1. $proxy_installation_location/conf/log4j2.properties ファイルで、次の行を見つけます。

   logger.edge.level=info

2. 上記の行を次のように変更します。

   logger.edge.level=debug

3. 変更を保存します。
   変更が有効になるまでに最大 60 秒かかる場合がありますが、プロキシを再起動する必要はありません。
4. 問題を再現します。
5. $proxy_installation_location/logs/edgeencryption.log ファイルでアプリケーションに関連するデバッグログステートメントを確認します。

タスクの結果

プロパティを変更した後に、$proxy_installation_location/logs/edgeencryption.log ファイルで追加の詳細を確認できます。デバッグが終了したら、$proxy_installation_location/conf/log4j2.properties ファイルに加えた変更を元に戻します。

プロキシを介した要求のタイミングメトリクスのログ記録

タイミングメトリクスのログ記録を有効にして、エッジ暗号化 プロキシによって処理される各要求のメトリクスステートメントを追加します。これらの各タイミングメトリクスログステートメントには、処理時間や使用された暗号化ルールなど、要求に関する有用な情報が含まれています。

始める前に

必要なロール：admin

注:

追加のログ記録設定が $proxy_installation_location/conf/log4j2.properties ファイルに追加されます。加えられた変更は、ファイルの変更が行われてから約 1 分以内に動的に取り込まれるため、プロキシを再起動する必要はありません。

手順

1. ファイルの末尾に次の行を追加して、$proxy_installation_location/conf/log4j2.properties ファイルを変更します。

   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. ファイルを保存します。

タスクの結果

log4j.properties ファイルが保存されると、$proxy_installation_location/logs/edgenetwork.log ログファイルにネットワーク時間に関する次のタイプのメッセージが表示されます。

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

ログメッセージの値は次のとおりです。

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

エッジ暗号化 プロキシとインスタンス間の SSL 接続に関する問題のデバッグ

この方法を使用して、エッジ暗号化 プロキシとインスタンスの間の SSL 接続に関する問題 (プロキシ経由のインスタンスへのアクセスが失敗するなど) をデバッグします。これらの手順により、ログ記録が増加し、詳細なログステートメントを見つけることができます。

始める前に

必要なロール：admin

注:

SSL 接続のデバッグは、TLS 接続タイプの問題をトラブルシューティングする場合にのみ関連します。実際には、これは一般的ではなく、めったに必要ありません。

手順

1. プロキシサーバーを停止します。
2. $proxy_installation_location/conf/wrapper.confファイル (Java スタートアッププロパティ) に次の行を追加します。

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

   例：

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

3. 変更を保存し、プロキシサーバーを再起動します。
4. 接続の問題を再現します。

タスクの結果

問題を再現した後、SSL 交換に関連するデバッグログステートメントを $proxy_installation_location/logs/wrapper_<current date>.log ファイルで見つけることができます。デバッグが終了したとき、前の手順で作成された行を削除するかコメントアウトすることで、追加のログ記録をリモートで実行できます。