v2:interceptors/logging: allow to separate request response payload logging #442

michaljemala · 2021-07-13T22:11:47Z

Logging payloads of requests on the server-side and similarly of responses on the client-side is a pretty common and desired use-case. However, logging by default payloads of both requests as well as responses in both scenarios is IMO not a very common requirement.

Consider the following PR to enable more granular control of what to log and when. This is achieved by using a special PayloadDecison type having the following values:

NoPayloadLogging - Payload logging is disabled.
LogRequest - Only logging of requests is enabled.
LogResponse - Only logging of responses is enabled.
LogRequestAndResponse - Logging of both requests and responses is enabled.
The PayloadDecison is to be used instead of the original bool by the logging.ServerPayloadLoggingDecider and logging.ClientPayloadLoggingDecider.

NOTE: I quickly put this together to see whether it could be considered a valid approach, thus please excuse the lack of additional unit tests. I will be glad to add those once the approach is approved.

google-cla · 2021-07-13T22:11:52Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

michaljemala · 2021-07-13T22:15:22Z

@googlebot I fixed it.

google-cla · 2021-07-13T22:15:25Z

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.
In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

michaljemala · 2021-07-13T22:18:03Z

@googlebot I fixed it.

codecov-commenter · 2021-07-14T00:37:38Z

Codecov Report

Merging #442 (e75d159) into v2 (6e2c2ac) will decrease coverage by 25.51%.
The diff coverage is 42.66%.

❗ Current head e75d159 differs from pull request most recent head 9f260f9. Consider uploading reports for the commit 9f260f9 to get more accurate results

@@             Coverage Diff             @@
##               v2     #442       +/-   ##
===========================================
- Coverage   84.01%   58.49%   -25.52%     
===========================================
  Files          30       38        +8     
  Lines         932     1706      +774     
===========================================
+ Hits          783      998      +215     
- Misses        110      636      +526     
- Partials       39       72       +33

Impacted Files	Coverage Δ
chain.go	`0.00% <ø> (-90.91%)`	⬇️
interceptors/auth/auth.go	`100.00% <ø> (ø)`
interceptors/auth/metadata.go	`100.00% <ø> (ø)`
interceptors/logging/options.go	`82.85% <0.00%> (-7.77%)`	⬇️
interceptors/ratelimit/ratelimit.go	`60.00% <0.00%> (-40.00%)`	⬇️
interceptors/recovery/options.go	`78.57% <ø> (ø)`
interceptors/retry/backoff.go	`52.94% <ø> (+2.94%)`	⬆️
interceptors/tags/context.go	`64.00% <ø> (ø)`
interceptors/tags/fieldextractor.go	`15.15% <0.00%> (-70.15%)`	⬇️
interceptors/tags/interceptors.go	`95.65% <ø> (ø)`
... and 44 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dc87da6...9f260f9. Read the comment docs.

johanbrandhorst

I quite like this, but it was @bwplotka who refactored these, so I would prefer to have his input.

yashrsharma44

Functionally - I think using a switch case would make this code easier to read and maintainable. Otherwise looks good to me!

interceptors/logging/payload.go

yashrsharma44 · 2021-08-02T17:06:46Z

Hi @michaljemala !

This PR looks good to me, can you run make lint for fixing the CI changes required?
Otherwise looks good to me.

yashrsharma44 · 2021-08-02T17:07:24Z

cc'ing @bwplotka for the inputs 😄

yashrsharma44 · 2021-08-03T06:46:11Z

Seems like the CI build needs approval for first time contributors - https://github.blog/changelog/2021-04-22-github-actions-maintainers-must-approve-first-time-contributor-workflow-runs/

michaljemala · 2021-08-05T09:30:11Z

Hi @yashrsharma44 is there anything else on my side to be done?

yashrsharma44 · 2021-08-05T12:01:08Z

We are blocked on @bwplotka's review. Let me get back to him when he is free.

bwplotka

LGTM, only minor nit and lint error 🤗

Thanks!

bwplotka · 2021-08-06T06:14:27Z

interceptors/logging/logging.go

+	// NoPayloadLogging - Payload logging is disabled.
+	NoPayloadLogging PayloadDecision = iota
+	// LogRequest - Only logging of requests is enabled.
+	LogRequest


Suggested change

LogRequest

LogPayloadRequest

bwplotka · 2021-08-06T06:14:34Z

interceptors/logging/logging.go

+	// LogRequest - Only logging of requests is enabled.
+	LogRequest
+	// LogResponse - Only logging of responses is enabled.
+	LogResponse


Suggested change

LogResponse

LogPayloadResponse

bwplotka · 2021-08-06T06:14:45Z

interceptors/logging/logging.go

+	// LogResponse - Only logging of responses is enabled.
+	LogResponse
+	// LogRequestAndResponse - Logging of both requests and responses is enabled.
+	LogRequestAndResponse


Suggested change

LogRequestAndResponse

LogPayloadRequestAndResponse

…ponse payload logging

bwplotka

Thanks!

michaljemala force-pushed the v2_separate_request_response_payload_logs branch from 1c3e861 to 5bcaa5b Compare July 13, 2021 22:17

michaljemala force-pushed the v2_separate_request_response_payload_logs branch from 5bcaa5b to ebc4206 Compare July 13, 2021 22:22

johanbrandhorst reviewed Jul 14, 2021

View reviewed changes

yashrsharma44 requested changes Jul 14, 2021

View reviewed changes

interceptors/logging/payload.go Outdated Show resolved Hide resolved

yashrsharma44 added the v2 label Jul 14, 2021

yashrsharma44 mentioned this pull request Jul 14, 2021

For Payload Logging Interceptors, consider allowing deciding on both request and response #400

Closed

yashrsharma44 linked an issue Jul 14, 2021 that may be closed by this pull request

For Payload Logging Interceptors, consider allowing deciding on both request and response #400

Closed

michaljemala force-pushed the v2_separate_request_response_payload_logs branch from ebc4206 to e0ec88c Compare July 14, 2021 19:45

michaljemala force-pushed the v2_separate_request_response_payload_logs branch 3 times, most recently from 685607e to e75d159 Compare August 3, 2021 06:29

yashrsharma44 approved these changes Aug 5, 2021

View reviewed changes

bwplotka approved these changes Aug 6, 2021

View reviewed changes

bwplotka added this to In progress in Milestone v2 Aug 6, 2021

v2:interceptors/logging: add payload decision to separate request res…

9f260f9

…ponse payload logging

michaljemala force-pushed the v2_separate_request_response_payload_logs branch from e75d159 to 9f260f9 Compare August 7, 2021 07:29

bwplotka approved these changes Aug 7, 2021

View reviewed changes

bwplotka merged commit 274df59 into grpc-ecosystem:v2 Aug 7, 2021

Milestone v2 automation moved this from In progress to Done Aug 7, 2021

aimuz mentioned this pull request Mar 8, 2023

docs: add logging.InjectFields usage description #540

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

v2:interceptors/logging: allow to separate request response payload logging #442

v2:interceptors/logging: allow to separate request response payload logging #442

michaljemala commented Jul 13, 2021 •

edited

google-cla bot commented Jul 13, 2021

michaljemala commented Jul 13, 2021

google-cla bot commented Jul 13, 2021

michaljemala commented Jul 13, 2021

codecov-commenter commented Jul 14, 2021 •

edited

johanbrandhorst left a comment

yashrsharma44 left a comment

yashrsharma44 commented Aug 2, 2021

yashrsharma44 commented Aug 2, 2021

yashrsharma44 commented Aug 3, 2021

michaljemala commented Aug 5, 2021

yashrsharma44 commented Aug 5, 2021

bwplotka left a comment

bwplotka Aug 6, 2021

michaljemala Aug 7, 2021

bwplotka Aug 6, 2021

michaljemala Aug 7, 2021

bwplotka Aug 6, 2021

michaljemala Aug 7, 2021

bwplotka left a comment

v2:interceptors/logging: allow to separate request response payload logging #442

v2:interceptors/logging: allow to separate request response payload logging #442

Conversation

michaljemala commented Jul 13, 2021 • edited

google-cla bot commented Jul 13, 2021

michaljemala commented Jul 13, 2021

google-cla bot commented Jul 13, 2021

michaljemala commented Jul 13, 2021

codecov-commenter commented Jul 14, 2021 • edited

Codecov Report

johanbrandhorst left a comment

Choose a reason for hiding this comment

yashrsharma44 left a comment

Choose a reason for hiding this comment

yashrsharma44 commented Aug 2, 2021

yashrsharma44 commented Aug 2, 2021

yashrsharma44 commented Aug 3, 2021

michaljemala commented Aug 5, 2021

yashrsharma44 commented Aug 5, 2021

bwplotka left a comment

Choose a reason for hiding this comment

bwplotka Aug 6, 2021

Choose a reason for hiding this comment

michaljemala Aug 7, 2021

Choose a reason for hiding this comment

bwplotka Aug 6, 2021

Choose a reason for hiding this comment

michaljemala Aug 7, 2021

Choose a reason for hiding this comment

bwplotka Aug 6, 2021

Choose a reason for hiding this comment

michaljemala Aug 7, 2021

Choose a reason for hiding this comment

bwplotka left a comment

Choose a reason for hiding this comment

michaljemala commented Jul 13, 2021 •

edited

codecov-commenter commented Jul 14, 2021 •

edited