Add support for grpclog.LoggerV2 #881

ash2k · 2020-11-22T06:40:59Z

Fixes #534

Closes #538

CLAassistant · 2020-11-22T06:41:03Z

All committers have signed the CLA.

codecov · 2020-11-22T06:45:57Z

Codecov Report

Merging #881 (4b0ccf6) into master (9d2e5de) will increase coverage by 0.05%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #881      +/-   ##
==========================================
+ Coverage   98.21%   98.26%   +0.05%     
==========================================
  Files          43       44       +1     
  Lines        1904     1965      +61     
==========================================
+ Hits         1870     1931      +61     
  Misses         27       27              
  Partials        7        7

Impacted Files	Coverage Δ
zapgrpc/zapgrpc.go	`100.00% <100.00%> (ø)`
sugar.go	`100.00% <0.00%> (ø)`
options.go	`100.00% <0.00%> (ø)`
http_handler.go	`100.00% <0.00%> (ø)`
clock.go	`100.00% <0.00%> (ø)`
logger.go	`96.19% <0.00%> (+0.03%)`	⬆️
zapcore/error.go	`96.77% <0.00%> (+0.77%)`	⬆️

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 9d2e5de...4b0ccf6. Read the comment docs.

ash2k · 2020-11-22T06:51:41Z

I don't see how coverage can be improved further. The only two lines that are not executed are the ones that call the real Fatal.

prashantv

I don't think we want this significantly larger API surface added to the zap logger.

I think it's best for a wrapper to live outside of zap to support the gRPC v2 logger interface.

ash2k · 2020-11-26T03:03:31Z

Hm, fine. I assumed you wanted it because #534 was open for 3 years and nobody closed it, and the PR too.

prashantv · 2020-12-08T07:28:02Z

Hm, fine. I assumed you wanted it because #534 was open for 3 years and nobody closed it, and the PR too.

Apologies for leaving the task open, I didn't realize how much of an API change it would result in.

ash2k · 2020-12-08T09:18:01Z

@prashantv I'm sorry, what API change are you talking about? This PR add a few methods to this package only to satisfy the interface gRPC wants.

prashantv · 2020-12-08T16:03:59Z

By API change, I mean the additional methods that are added to the Sugar logger. The number of methods for each level increases from the 3 per-level (which all behave differently) to 4 per-level (where the Ln suffixed methods behave the same as one of the other methods).

Once an API is added, it must be maintained for backwards compatibility, and I don't think think this added API surface makes sense to add directly to the zap Sugar logger.

ash2k · 2020-12-08T20:16:24Z

By API change, I mean the additional methods that are added to the Sugar logger.

But this PR does not add any methods to the Sugar logger?

prashantv · 2021-01-25T04:46:31Z

For some reason, I thought we were modifying the Sugar logger, which was a misread on my part.

Given this doesn't add methods to the sugar logger, but to the gRPC-specific logger, I think this is reasonable, reopening for review.

Sorry for the confusion @ash2k

prashantv

The WithDebug option still makes sense for the V1 logger Print* methods, but not for the V2 logger. We can either:

clarify in the documentation for WithDebug
Add a separate constructor + type for the V2 logger (which takes a separate option type)

The latter increases the API surface, but may be clearer (especially if there's other options in future that will only be applicable to V2).

I don't have strong opinions on either approach though, thoughts @ash2k?

ash2k · 2021-01-27T09:24:44Z

@prashantv

clarify in the documentation for WithDebug

I'd go for this option as it's less work and does not add API surface - this can always be done later if needed but cannot be undone, so I think it's better to keep API as is.

Could you suggest what should be documented there? That the option is only applicable to v1 API?

prashantv · 2021-01-28T07:59:25Z

@prashantv

clarify in the documentation for WithDebug

I'd go for this option as it's less work and does not add API surface - this can always be done later if needed but cannot be undone, so I think it's better to keep API as is.

Could you suggest what should be documented there? That the option is only applicable to v1 API?

Yep, specifically that WithDebug will only affect the Print* methods, which are only used in the gRPC v1 Logger APIs. Thanks

ash2k · 2021-01-29T09:29:52Z

@prashantv done

prashantv

Sorry for the delay in reviewing, I wanted to make sure I gave this a thorough look, and noticed a couple of small issues.

zapgrpc/zapgrpc.go

prashantv

Couple of minor comments, but overall looks good

zapgrpc/zapgrpc.go

Co-authored-by: Prashant Varanasi <github@prashantv.com>

zapgrpc/zapgrpc.go

zapgrpc/zapgrpc_test.go

prashantv

Looks good with a couple of minor test suggestions.

zapgrpc/zapgrpc.go

zapgrpc/zapgrpc_test.go

Co-authored-by: Prashant Varanasi <github@prashantv.com>

abhinav

LGTM.

I think it would be valuable to add a test that tests directly against grpc-go
so that we know we're interface compliant.

But we would also like to not add a dependency on grpc-go in Zap. This
probably requires a submodule. I can add that.

abhinav · 2021-02-12T18:46:41Z

RE: coverage: The failing cases are the ones for Fatal. I think there's a way to organize this that addresses that issue. I'll add a commit, just a moment.

Instead of an if/else on each Print and Fatal log statement, handle the indirection once with function references.

Add a zapgrpc/internal/test submodule that tests the zapgrpc logger against grpc-go directly. Because this is a submodule, it will not add grpc as a dependency of zap.

gRPC has an updated [logger interface][1] that the v1 API has been deprecated in favor of. [1]: https://pkg.go.dev/google.golang.org/grpc/grpclog#LoggerV2 This adds support for it to the existing gRPC adapter in Zap. Fixes #534 Closes #538 Co-authored-by: Prashant Varanasi <github@prashantv.com> Co-authored-by: Abhinav Gupta <abg@uber.com>

gRPC has an updated [logger interface][1] that the v1 API has been deprecated in favor of. [1]: https://pkg.go.dev/google.golang.org/grpc/grpclog#LoggerV2 This adds support for it to the existing gRPC adapter in Zap. Fixes uber-go#534 Closes uber-go#538 Co-authored-by: Prashant Varanasi <github@prashantv.com> Co-authored-by: Abhinav Gupta <abg@uber.com>

Add support for grpclog.LoggerV2

3180cc1

prashantv reviewed Nov 26, 2020

View reviewed changes

prashantv closed this Dec 8, 2020

ash2k mentioned this pull request Jan 15, 2021

zapgrpc upgrade for grpclog.LoggerV2 #534

Closed

prashantv reopened this Jan 25, 2021

prashantv reviewed Jan 25, 2021

View reviewed changes

Add comment

a10bb53

prashantv reviewed Feb 2, 2021

View reviewed changes

zapgrpc/zapgrpc.go Outdated Show resolved Hide resolved

zapgrpc/zapgrpc.go Show resolved Hide resolved

Correctly map log levels and add spaces for *ln() methods

cb9e579

ash2k force-pushed the ash2k/grpc-logger branch from 6ab10a5 to cb9e579 Compare February 3, 2021 10:15

prashantv approved these changes Feb 3, 2021

View reviewed changes

zapgrpc/zapgrpc.go Outdated Show resolved Hide resolved

zapgrpc/zapgrpc.go Outdated Show resolved Hide resolved

zapgrpc/zapgrpc.go Outdated Show resolved Hide resolved

ash2k and others added 2 commits February 4, 2021 14:18

Update zapgrpc/zapgrpc.go

c83c545

Co-authored-by: Prashant Varanasi <github@prashantv.com>

Rename global

aba3594

prashantv reviewed Feb 5, 2021

View reviewed changes

zapgrpc/zapgrpc.go Outdated Show resolved Hide resolved

zapgrpc/zapgrpc_test.go Show resolved Hide resolved

ash2k added 2 commits February 9, 2021 11:08

Use fmt.Sprintln()

2a0779f

Extract LevelEnabler into a field to avoid memory allocation

bb6d5a3

ash2k force-pushed the ash2k/grpc-logger branch from 9ab1258 to bb6d5a3 Compare February 9, 2021 00:12

More tests

3e969db

prashantv approved these changes Feb 9, 2021

View reviewed changes

zapgrpc/zapgrpc.go Show resolved Hide resolved

zapgrpc/zapgrpc_test.go Outdated Show resolved Hide resolved

prashantv assigned abhinav Feb 9, 2021

prashantv added the ready for second review label Feb 9, 2021

ash2k and others added 3 commits February 10, 2021 10:02

Update zapgrpc/zapgrpc.go

5648c2f

Co-authored-by: Prashant Varanasi <github@prashantv.com>

Refactor tests

7c1ae71

grpclog: Fix lint issue

9d034a2

abhinav approved these changes Feb 12, 2021

View reviewed changes

abhinav added 2 commits February 12, 2021 11:04

zapgrpc: Simplify fatal/print redirection

6bbb45d

Instead of an if/else on each Print and Fatal log statement, handle the indirection once with function references.

zapgrpc: Add submodule to test against grpc-go

4b0ccf6

Add a zapgrpc/internal/test submodule that tests the zapgrpc logger against grpc-go directly. Because this is a submodule, it will not add grpc as a dependency of zap.

abhinav requested a review from prashantv February 12, 2021 19:08

prashantv approved these changes Feb 12, 2021

View reviewed changes

abhinav merged commit 89e3820 into uber-go:master Feb 12, 2021

github-actions bot mentioned this pull request Apr 10, 2022

Link Checker Report scylladb/scylla-manager#3102

Closed

github-actions bot mentioned this pull request Apr 17, 2022

Link Checker Report scylladb/scylla-manager#3121

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for grpclog.LoggerV2 #881

Add support for grpclog.LoggerV2 #881

ash2k commented Nov 22, 2020

CLAassistant commented Nov 22, 2020 •

edited

Loading

codecov bot commented Nov 22, 2020 •

edited

Loading

ash2k commented Nov 22, 2020

prashantv left a comment

ash2k commented Nov 26, 2020

prashantv commented Dec 8, 2020

ash2k commented Dec 8, 2020

prashantv commented Dec 8, 2020 •

edited

Loading

ash2k commented Dec 8, 2020

prashantv commented Jan 25, 2021

prashantv left a comment

ash2k commented Jan 27, 2021

prashantv commented Jan 28, 2021

ash2k commented Jan 29, 2021

prashantv left a comment

prashantv left a comment

prashantv left a comment

abhinav left a comment •

edited

Loading

abhinav commented Feb 12, 2021

Add support for grpclog.LoggerV2 #881

Add support for grpclog.LoggerV2 #881

Conversation

ash2k commented Nov 22, 2020

CLAassistant commented Nov 22, 2020 • edited Loading

codecov bot commented Nov 22, 2020 • edited Loading

Codecov Report

ash2k commented Nov 22, 2020

prashantv left a comment

Choose a reason for hiding this comment

ash2k commented Nov 26, 2020

prashantv commented Dec 8, 2020

ash2k commented Dec 8, 2020

prashantv commented Dec 8, 2020 • edited Loading

ash2k commented Dec 8, 2020

prashantv commented Jan 25, 2021

prashantv left a comment

Choose a reason for hiding this comment

ash2k commented Jan 27, 2021

prashantv commented Jan 28, 2021

ash2k commented Jan 29, 2021

prashantv left a comment

Choose a reason for hiding this comment

prashantv left a comment

Choose a reason for hiding this comment

prashantv left a comment

Choose a reason for hiding this comment

abhinav left a comment • edited Loading

Choose a reason for hiding this comment

abhinav commented Feb 12, 2021

CLAassistant commented Nov 22, 2020 •

edited

Loading

codecov bot commented Nov 22, 2020 •

edited

Loading

prashantv commented Dec 8, 2020 •

edited

Loading

abhinav left a comment •

edited

Loading