|
| 1 | +package zerolog_test |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "os" |
| 6 | + "testing" |
| 7 | + |
| 8 | + "github.com/rs/zerolog" |
| 9 | + "google.golang.org/grpc" |
| 10 | + |
| 11 | + middleware "github.com/grpc-ecosystem/go-grpc-middleware/v2" |
| 12 | + "github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/logging" |
| 13 | + "github.com/grpc-ecosystem/go-grpc-middleware/v2/interceptors/tags" |
| 14 | + grpczerolog "github.com/grpc-ecosystem/go-grpc-middleware/v2/providers/zerolog" |
| 15 | +) |
| 16 | + |
| 17 | +var ( |
| 18 | + customFunc logging.CodeToLevel |
| 19 | + customDurationToFields logging.DurationToFields |
| 20 | +) |
| 21 | + |
| 22 | +func Example_initializationWithCustomLevels() { |
| 23 | + // Logger is used, allowing pre-definition of certain fields by the user. |
| 24 | + logger := zerolog.New(os.Stderr) |
| 25 | + // Shared options for the logger, with a custom gRPC code to log level function. |
| 26 | + opts := []logging.Option{ |
| 27 | + logging.WithLevels(customFunc), |
| 28 | + } |
| 29 | + // Create a server, make sure we put the tags context before everything else. |
| 30 | + _ = grpc.NewServer( |
| 31 | + middleware.WithUnaryServerChain( |
| 32 | + tags.UnaryServerInterceptor(), |
| 33 | + logging.UnaryServerInterceptor(grpczerolog.InterceptorLogger(logger), opts...), |
| 34 | + ), |
| 35 | + middleware.WithStreamServerChain( |
| 36 | + tags.StreamServerInterceptor(), |
| 37 | + logging.StreamServerInterceptor(grpczerolog.InterceptorLogger(logger), opts...), |
| 38 | + ), |
| 39 | + ) |
| 40 | +} |
| 41 | + |
| 42 | +func Example_initializationWithDurationFieldOverride() { |
| 43 | + // Logger is used, allowing pre-definition of certain fields by the user. |
| 44 | + logger := zerolog.New(os.Stderr) |
| 45 | + // Shared options for the logger, with a custom duration to log field function. |
| 46 | + opts := []logging.Option{ |
| 47 | + logging.WithDurationField(customDurationToFields), |
| 48 | + } |
| 49 | + // Create a server, make sure we put the tags context before everything else. |
| 50 | + _ = grpc.NewServer( |
| 51 | + middleware.WithUnaryServerChain( |
| 52 | + tags.UnaryServerInterceptor(), |
| 53 | + logging.UnaryServerInterceptor(grpczerolog.InterceptorLogger(logger), opts...), |
| 54 | + ), |
| 55 | + middleware.WithStreamServerChain( |
| 56 | + tags.StreamServerInterceptor(), |
| 57 | + logging.StreamServerInterceptor(grpczerolog.InterceptorLogger(logger), opts...), |
| 58 | + ), |
| 59 | + ) |
| 60 | +} |
| 61 | + |
| 62 | +func Example_initializationWithCodeGenRequestFieldExtractor() { |
| 63 | + // Logger is used, allowing pre-definition of certain fields by the user. |
| 64 | + logger := zerolog.New(os.Stderr) |
| 65 | + // Create a server, make sure we put the tags context before everything else. |
| 66 | + _ = grpc.NewServer( |
| 67 | + middleware.WithUnaryServerChain( |
| 68 | + tags.UnaryServerInterceptor(tags.WithFieldExtractor(tags.CodeGenRequestFieldExtractor)), |
| 69 | + logging.UnaryServerInterceptor(grpczerolog.InterceptorLogger(logger)), |
| 70 | + ), |
| 71 | + middleware.WithStreamServerChain( |
| 72 | + tags.StreamServerInterceptor(tags.WithFieldExtractor(tags.CodeGenRequestFieldExtractor)), |
| 73 | + logging.StreamServerInterceptor(grpczerolog.InterceptorLogger(logger)), |
| 74 | + ), |
| 75 | + ) |
| 76 | +} |
| 77 | + |
| 78 | +func ExampleWithDecider() { |
| 79 | + // Logger is used, allowing pre-definition of certain fields by the user. |
| 80 | + logger := zerolog.New(os.Stderr) |
| 81 | + // Shared options for the logger, with a custom decider that log everything except successful |
| 82 | + // calls from "/blah.foo.healthcheck/Check" method. |
| 83 | + opts := []logging.Option{ |
| 84 | + logging.WithDecider(func(methodFullName string, err error) bool { |
| 85 | + // will not log gRPC calls if it was a call to healthcheck and no error was raised |
| 86 | + if err == nil && methodFullName == "/blah.foo.healthcheck/Check" { |
| 87 | + return false |
| 88 | + } |
| 89 | + |
| 90 | + // by default you will log all calls |
| 91 | + return true |
| 92 | + }), |
| 93 | + } |
| 94 | + // Create a server, make sure we put the tags context before everything else. |
| 95 | + _ = []grpc.ServerOption{ |
| 96 | + middleware.WithUnaryServerChain( |
| 97 | + tags.UnaryServerInterceptor(), |
| 98 | + logging.UnaryServerInterceptor(grpczerolog.InterceptorLogger(logger), opts...), |
| 99 | + ), |
| 100 | + middleware.WithStreamServerChain( |
| 101 | + tags.StreamServerInterceptor(), |
| 102 | + logging.StreamServerInterceptor(grpczerolog.InterceptorLogger(logger), opts...), |
| 103 | + ), |
| 104 | + } |
| 105 | +} |
| 106 | + |
| 107 | +func ExampleWithPayloadLogging() { |
| 108 | + // Logger is used, allowing pre-definition of certain fields by the user. |
| 109 | + logger := zerolog.New(os.Stderr) |
| 110 | + // Expect payload from "/blah.foo.healthcheck/Check" call to be logged. |
| 111 | + payloadDecider := func(ctx context.Context, fullMethodName string, servingObject interface{}) bool { |
| 112 | + return fullMethodName == "/blah.foo.healthcheck/Check" |
| 113 | + } |
| 114 | + |
| 115 | + // Create a server, make sure we put the tags context before everything else. |
| 116 | + _ = []grpc.ServerOption{ |
| 117 | + middleware.WithUnaryServerChain( |
| 118 | + tags.UnaryServerInterceptor(), |
| 119 | + logging.UnaryServerInterceptor(grpczerolog.InterceptorLogger(logger)), |
| 120 | + logging.PayloadUnaryServerInterceptor(grpczerolog.InterceptorLogger(logger), payloadDecider), |
| 121 | + ), |
| 122 | + middleware.WithStreamServerChain( |
| 123 | + tags.StreamServerInterceptor(), |
| 124 | + logging.StreamServerInterceptor(grpczerolog.InterceptorLogger(logger)), |
| 125 | + logging.PayloadStreamServerInterceptor(grpczerolog.InterceptorLogger(logger), payloadDecider), |
| 126 | + ), |
| 127 | + } |
| 128 | +} |
| 129 | + |
| 130 | +func TestExamplesBuildable(t *testing.T) { |
| 131 | + Example_initializationWithCustomLevels() |
| 132 | + Example_initializationWithDurationFieldOverride() |
| 133 | + Example_initializationWithCodeGenRequestFieldExtractor() |
| 134 | + ExampleWithDecider() |
| 135 | + ExampleWithPayloadLogging() |
| 136 | +} |
0 commit comments