Skip to content

Commit f3ab992

Browse files
mcdoker18mcdoker18
authored
Added logr as logging Library provider (#510)
* Added logr as logging Library provider Closes #473 Closes #430 * fixed formatting
1 parent 5d0f5fe commit f3ab992

File tree

8 files changed

+365
-1
lines changed

8 files changed

+365
-1
lines changed

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ myServer := grpc.NewServer(
6464
* [`kit`](providers/kit) - integration of [go-kit/log](https://github.com/go-kit/log) logging library into gRPC handlers.
6565
* [`zerolog`](providers/zerolog) - integration of [zerolog](https://github.com/rs/zerolog) logging Library into gRPC handlers.
6666
* [`phuslog`](providers/phuslog) - integration of [phuslog](https://github.com/phuslu/log) logging Library into gRPC handlers.
67+
* [`logr`](providers/logr) - integration of [logr](https://github.com/go-logr/logr) logging Library into gRPC handlers.
6768

6869
#### Monitoring
6970
* [`grpc_prometheus`⚡](https://github.com/grpc-ecosystem/go-grpc-prometheus) - Prometheus client-side and server-side monitoring middleware

‎interceptors/logging/doc.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ Implementations:
3030
* providers/kit
3131
* providers/zerolog
3232
* providers/phuslog
33-
33+
* providers/logr
3434
*/
3535
package logging

‎providers/logr/doc.go

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Copyright (c) The go-grpc-middleware Authors.
2+
// Licensed under the Apache License 2.0.
3+
4+
/*
5+
`logr` provides a small adapter required to use logr in logging gRPC middlewares.
6+
7+
Please see examples for examples of use.
8+
*/
9+
package logr

‎providers/logr/examples_test.go

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
// Copyright (c) The go-grpc-middleware Authors.
2+
// Licensed under the Apache License 2.0.
3+
4+
package logr_test
5+
6+
import (
7+
"context"
8+
"testing"
9+
10+
grpclogr "github.com/grpc-ecosystem/go-grpc-middleware/providers/logr/v2"
11+
"google.golang.org/grpc"
12+
"k8s.io/klog/v2"
13+
14+
middleware "github.com/grpc-ecosystem/go-grpc-middleware/v2"
15+
"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/logging"
16+
)
17+
18+
var (
19+
customFunc logging.CodeToLevel
20+
customDurationToFields logging.DurationToFields
21+
)
22+
23+
func Example_initializationWithCustomLevels() {
24+
// Logger is used, allowing pre-definition of certain fields by the user.
25+
logger := klog.NewKlogr()
26+
// Shared options for the logger, with a custom gRPC code to log level function.
27+
opts := []logging.Option{
28+
logging.WithLevels(customFunc),
29+
}
30+
// Create a server, make sure we put the tags context before everything else.
31+
_ = grpc.NewServer(
32+
middleware.WithUnaryServerChain(
33+
logging.UnaryServerInterceptor(grpclogr.InterceptorLogger(logger), opts...),
34+
),
35+
middleware.WithStreamServerChain(
36+
logging.StreamServerInterceptor(grpclogr.InterceptorLogger(logger), opts...),
37+
),
38+
)
39+
}
40+
41+
func Example_initializationWithDurationFieldOverride() {
42+
// Logger is used, allowing pre-definition of certain fields by the user.
43+
logger := klog.NewKlogr()
44+
// Shared options for the logger, with a custom duration to log field function.
45+
opts := []logging.Option{
46+
logging.WithDurationField(customDurationToFields),
47+
}
48+
// Create a server, make sure we put the tags context before everything else.
49+
_ = grpc.NewServer(
50+
middleware.WithUnaryServerChain(
51+
logging.UnaryServerInterceptor(grpclogr.InterceptorLogger(logger), opts...),
52+
),
53+
middleware.WithStreamServerChain(
54+
logging.StreamServerInterceptor(grpclogr.InterceptorLogger(logger), opts...),
55+
),
56+
)
57+
}
58+
59+
func ExampleWithDecider() {
60+
// Logger is used, allowing pre-definition of certain fields by the user.
61+
logger := klog.NewKlogr()
62+
// Shared options for the logger, with a custom decider that log everything except successful calls from "/blah.foo.healthcheck/Check" method.
63+
opts := []logging.Option{
64+
logging.WithDecider(func(methodFullName string) logging.Decision {
65+
// will not log gRPC calls if it was a call to healthcheck and no error was raised
66+
if methodFullName == "/blah.foo.healthcheck/Check" {
67+
return logging.NoLogCall
68+
}
69+
70+
// by default you will log all calls
71+
return logging.LogStartAndFinishCall
72+
}),
73+
}
74+
// Create a server, make sure we put the tags context before everything else.
75+
_ = []grpc.ServerOption{
76+
middleware.WithUnaryServerChain(
77+
logging.UnaryServerInterceptor(grpclogr.InterceptorLogger(logger), opts...),
78+
),
79+
middleware.WithStreamServerChain(
80+
logging.StreamServerInterceptor(grpclogr.InterceptorLogger(logger), opts...),
81+
),
82+
}
83+
}
84+
85+
func ExampleServerPayloadLoggingDecider() {
86+
// Logger is used, allowing pre-definition of certain fields by the user.
87+
logger := klog.NewKlogr()
88+
// Expect payload from "/blah.foo.healthcheck/Check" call to be logged.
89+
payloadDecider := func(ctx context.Context, fullMethodName string, servingObject interface{}) bool {
90+
return fullMethodName == "/blah.foo.healthcheck/Check"
91+
}
92+
93+
// Create a server, make sure we put the tags context before everything else.
94+
_ = []grpc.ServerOption{
95+
middleware.WithUnaryServerChain(
96+
logging.UnaryServerInterceptor(grpclogr.InterceptorLogger(logger)),
97+
logging.PayloadUnaryServerInterceptor(grpclogr.InterceptorLogger(logger), payloadDecider),
98+
),
99+
middleware.WithStreamServerChain(
100+
logging.StreamServerInterceptor(grpclogr.InterceptorLogger(logger)),
101+
logging.PayloadStreamServerInterceptor(grpclogr.InterceptorLogger(logger), payloadDecider),
102+
),
103+
}
104+
}
105+
106+
func TestExamplesBuildable(t *testing.T) {
107+
Example_initializationWithCustomLevels()
108+
Example_initializationWithDurationFieldOverride()
109+
ExampleWithDecider()
110+
ExampleServerPayloadLoggingDecider()
111+
}

‎providers/logr/go.mod

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
module github.com/grpc-ecosystem/go-grpc-middleware/providers/logr/v2
2+
3+
go 1.14
4+
5+
require (
6+
github.com/go-logr/logr v1.2.3
7+
github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.0.0-rc.2.0.20201002093600-73cf2ae9d891
8+
github.com/stretchr/testify v1.5.1
9+
google.golang.org/grpc v1.37.0
10+
k8s.io/klog/v2 v2.70.1
11+
)

‎providers/logr/go.sum

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
2+
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
3+
github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
4+
github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
5+
github.com/cncf/udpa/go v0.0.0-20201120205902-5459f2c99403/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk=
6+
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
7+
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
8+
github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
9+
github.com/envoyproxy/go-control-plane v0.9.1-0.20191026205805-5f8ba28d4473/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
10+
github.com/envoyproxy/go-control-plane v0.9.9-0.20210217033140-668b12f5399d/go.mod h1:cXg6YxExXjJnVBQHBLXeUAgxn2UodCpnH306RInaBQk=
11+
github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
12+
github.com/go-logr/logr v1.2.0/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
13+
github.com/go-logr/logr v1.2.3 h1:2DntVwHkVopvECVRSlL5PSo9eG+cAkDCuckLubN+rq0=
14+
github.com/go-logr/logr v1.2.3/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
15+
github.com/gogo/protobuf v1.2.1 h1:/s5zKNz0uPFCZ5hddgPdo2TK2TVrUNMn0OOX8/aZMTE=
16+
github.com/gogo/protobuf v1.2.1/go.mod h1:hp+jE20tsWTFYpLwKvXlhS1hjn+gTNwPg2I6zVXpSg4=
17+
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
18+
github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A=
19+
github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
20+
github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
21+
github.com/golang/protobuf v1.4.0-rc.1/go.mod h1:ceaxUfeHdC40wWswd/P6IGgMaK3YpKi5j83Wpe3EHw8=
22+
github.com/golang/protobuf v1.4.0-rc.1.0.20200221234624-67d41d38c208/go.mod h1:xKAWHe0F5eneWXFV3EuXVDTCmh+JuBKY0li0aMyXATA=
23+
github.com/golang/protobuf v1.4.0-rc.2/go.mod h1:LlEzMj4AhA7rCAGe4KMBDvJI+AwstrUpVNzEA03Pprs=
24+
github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:WU3c8KckQ9AFe+yFwt9sWVRKCVIyN9cPHBJSNnbL67w=
25+
github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0=
26+
github.com/golang/protobuf v1.4.1/go.mod h1:U8fpvMrcmy5pZrNK1lt4xCsGvpyWQ/VVv6QDs8UjoX8=
27+
github.com/golang/protobuf v1.4.2 h1:+Z5KGCizgyZCbGh1KZqA0fcLLkwbsjIzS4aV2v7wJX0=
28+
github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI=
29+
github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
30+
github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
31+
github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
32+
github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
33+
github.com/google/go-cmp v0.5.0 h1:/QaMHBdZ26BB3SSst0Iwl10Epc+xhTquomWX0oZEB6w=
34+
github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
35+
github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
36+
github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.0.0-rc.2.0.20201002093600-73cf2ae9d891 h1:2F7/en805byWQR92etfFjOqtRtWsUu09R7wm6LtlHEw=
37+
github.com/grpc-ecosystem/go-grpc-middleware/v2 v2.0.0-rc.2.0.20201002093600-73cf2ae9d891/go.mod h1:GhphxcdlaRyAuBSvo6rV71BvQcvB/vuX8ugCyybuS2k=
38+
github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q=
39+
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
40+
github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
41+
github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
42+
github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
43+
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
44+
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
45+
github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
46+
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
47+
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
48+
github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
49+
github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
50+
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
51+
golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
52+
golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
53+
golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU=
54+
golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
55+
golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
56+
golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
57+
golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
58+
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
59+
golang.org/x/net v0.0.0-20190620200207-3b0461eec859 h1:R/3boaszxrf1GEUWTVDzSKVwLmSJpwZ1yqXm8j0v2QI=
60+
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
61+
golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
62+
golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
63+
golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
64+
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
65+
golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
66+
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a h1:1BGLXjeY4akVXGgbC9HugT3Jv3hCI0z56oJR5vAMgBU=
67+
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
68+
golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
69+
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
70+
golang.org/x/tools v0.0.0-20180221164845-07fd8470d635/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
71+
golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
72+
golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY=
73+
golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
74+
golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=
75+
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
76+
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
77+
google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
78+
google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4=
79+
google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc=
80+
google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc=
81+
google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013 h1:+kGHl1aib/qcwaRi1CbqBZ1rk19r85MNUf8HaBghugY=
82+
google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013/go.mod h1:NbSheEEYHJ7i3ixzK3sjbqSGDJWnxyFXZblF3eUsNvo=
83+
google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c=
84+
google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg=
85+
google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY=
86+
google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk=
87+
google.golang.org/grpc v1.37.0 h1:uSZWeQJX5j11bIQ4AJoj+McDBo29cY1MCoC1wO3ts+c=
88+
google.golang.org/grpc v1.37.0/go.mod h1:NREThFqKR1f3iQ6oBuvc5LadQuXVGo9rkm5ZGrQdJfM=
89+
google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
90+
google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=
91+
google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM=
92+
google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE=
93+
google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo=
94+
google.golang.org/protobuf v1.22.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
95+
google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
96+
google.golang.org/protobuf v1.23.1-0.20200526195155-81db48ad09cc/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
97+
google.golang.org/protobuf v1.25.0 h1:Ejskq+SyPohKW+1uil0JJMtmHCgJPJ/qWTxr8qp+R4c=
98+
google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c=
99+
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
100+
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
101+
gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
102+
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
103+
honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
104+
honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
105+
k8s.io/klog/v2 v2.70.1 h1:7aaoSdahviPmR+XkS7FyxlkkXs6tHISSG03RxleQAVQ=
106+
k8s.io/klog/v2 v2.70.1/go.mod h1:y1WjHnz7Dj687irZUWR/WLkLc5N1YHtjLdmgWjndZn0=

‎providers/logr/logger.go

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
// Copyright (c) The go-grpc-middleware Authors.
2+
// Licensed under the Apache License 2.0.
3+
4+
package logr
5+
6+
import (
7+
"fmt"
8+
9+
"github.com/go-logr/logr"
10+
11+
"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/logging"
12+
)
13+
14+
// verbosity https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/logging.md#what-method-to-use
15+
const (
16+
debugVerbosity = 4
17+
infoVerbosity = 2
18+
warnVerbosity = 1
19+
errorVerbosity = 0
20+
)
21+
22+
// Compatibility check.
23+
var _ logging.Logger = &Logger{}
24+
25+
// Logger is a logr logging adapter compatible with logging middlewares.
26+
type Logger struct {
27+
logr.Logger
28+
}
29+
30+
// InterceptorLogger converts zap logger to Logger adapter.
31+
func InterceptorLogger(logger logr.Logger) *Logger {
32+
return &Logger{Logger: logger}
33+
}
34+
35+
// Log implements logging.Logger interface.
36+
func (l *Logger) Log(lvl logging.Level, msg string) {
37+
switch lvl {
38+
case logging.DEBUG:
39+
l.Logger.V(debugVerbosity).Info(msg)
40+
case logging.INFO:
41+
l.Logger.V(infoVerbosity).Info(msg)
42+
case logging.WARNING:
43+
l.Logger.V(warnVerbosity).Info(msg)
44+
case logging.ERROR:
45+
l.Logger.V(errorVerbosity).Info(msg)
46+
default:
47+
panic(fmt.Sprintf("logr: unknown level %s", lvl))
48+
}
49+
}
50+
51+
// With implements logging.Logger interface.
52+
func (l *Logger) With(fields ...string) logging.Logger {
53+
vals := make([]interface{}, len(fields))
54+
for i := 0; i < len(fields); i++ {
55+
vals[i] = fields[i]
56+
}
57+
58+
return InterceptorLogger(l.Logger.WithValues(vals...))
59+
}

‎providers/logr/logger_test.go

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
// Copyright (c) The go-grpc-middleware Authors.
2+
// Licensed under the Apache License 2.0.
3+
4+
package logr_test
5+
6+
import (
7+
"testing"
8+
9+
grpclogr "github.com/grpc-ecosystem/go-grpc-middleware/providers/logr/v2"
10+
"github.com/stretchr/testify/assert"
11+
"k8s.io/klog/v2/ktesting"
12+
13+
"github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/logging"
14+
)
15+
16+
type (
17+
Entry struct {
18+
Message string
19+
Verbosity int
20+
WithKVList []interface{}
21+
}
22+
)
23+
24+
func mapKtesingEntries(underlierLogger ktesting.Underlier) (entries []Entry) {
25+
for _, entry := range underlierLogger.GetBuffer().Data() {
26+
entries = append(entries, Entry{
27+
Message: entry.Message,
28+
Verbosity: entry.Verbosity,
29+
WithKVList: entry.WithKVList,
30+
})
31+
}
32+
33+
return entries
34+
}
35+
36+
func TestLogger_Log(t *testing.T) {
37+
testLogger := ktesting.NewLogger(t, ktesting.NewConfig())
38+
underlierLogger := testLogger.GetSink().(ktesting.Underlier)
39+
logger := grpclogr.InterceptorLogger(testLogger)
40+
41+
loggerWithFields := logger.With("key-1", "value-1")
42+
loggerWithFields.Log(logging.DEBUG, "debug message")
43+
logger.Log(logging.INFO, "some info message")
44+
loggerWithFields.With("key-2", "value-2", "key-3", "value-3").Log(logging.WARNING, "warn")
45+
logger.Log(logging.ERROR, "error")
46+
47+
assert.Equal(t, []Entry{
48+
{
49+
Message: "debug message",
50+
Verbosity: 4,
51+
WithKVList: []interface{}{"key-1", "value-1"},
52+
},
53+
{
54+
Message: "some info message",
55+
Verbosity: 2,
56+
},
57+
{
58+
Message: "warn",
59+
Verbosity: 1,
60+
WithKVList: []interface{}{"key-1", "value-1", "key-2", "value-2", "key-3", "value-3"},
61+
},
62+
{
63+
Message: "error",
64+
Verbosity: 0,
65+
},
66+
}, mapKtesingEntries(underlierLogger))
67+
}

0 commit comments

Comments
 (0)