ロギング
クライアントが送るものと受け取るものを見るには、その logger-level を none より上に設定します。すると各呼び出しが、ロガー feign.<Interface> のもとで debug レベルでログに出されるため、そのレベルも有効にする必要があります。
使う理由
呼び出しが失敗したとき、最初の問いは何が送られ何が返ってきたかです。ログは、デバッガーやプロキシなしにそれに答えます。ヘッダーの中のクレデンシャルはログファイルに残ってはならないため、その値はマスクされます。
例
spring.feign.client.config.catalog.logger-level=headers
spring.feign.client.config.default.sensitive-headers=X-Api-Key,X-Partner-Token
logging.level.feign=debug
---> GET https://api.neon.books/books/978-0
Accept: application/json
X-Api-Key: ***
<--- 200 OK (84 ms)
content-type: application/json
レベル
logger-level |
ログに出されるもの |
|---|---|
none |
何も。デフォルト。Feign と同じく、失敗した接続とリトライもログに出されない。 |
basic |
各リクエストのメソッドと URL、各レスポンスのステータスと時間、失敗した接続 (<--- ERROR ...)、リトライ (---> RETRYING ...)、イベントストリームの再接続 (---> RECONNECTING ...)。 |
headers |
basic に加えて、リクエストとレスポンスのヘッダー。クレデンシャルはマスクされる。 |
full |
headers に加えて、ボディ。 |
クライアントごと (spring.feign.client.config.catalog.logger-level) に、またはすべてに (...config.default.logger-level) 設定します。ロガーは feign.<Interface> (feign.CatalogClient) なので、logging.level.feign=debug はそのすべてを、logging.level.feign.CatalogClient=debug は一つを有効にします。
マスクされるヘッダー
headers と full のログでは、次のヘッダーの値は *** と示されます (名前は大文字小文字を問いません)。
- 常に:
Authorization、Proxy-Authorization、Cookie、Set-Cookie、DPoP。 - そして
sensitive-headersのもの:defaultのもの、次にクライアントのもの。
URL はそのクエリとともにログに出されるため、クエリパラメーターとして送ったキーは表示されます。秘密はヘッダーとして送り、スターターがまだマスクしないものを指定してください。full はボディをそのままログに出します。ボディが個人データを含む場所では使わないでください。
Spring (Java) との対応
spring.cloud.openfeign.client.config.catalog.logger-level: headers
logging.level.com.example.CatalogClient: debug
レベルは Feign のものです。ロガーは、インターフェースの完全修飾名ではなく feign.<Interface> です。Feign のロガーは何もマスクしませんが、ここではクレデンシャルと sensitive-headers (追加されたもの) がマスクされます。