feat: enable grpc plugin logging (#413)

* Enable grpc plugin logging

Signed-off-by: Vladimir Lavor <[email protected]>

* updated example, readme and deps

Signed-off-by: Vladimir Lavor <[email protected]>

.gitignore

@@ -14,6 +14,7 @@ examples/etcd-lib/election/election
 examples/etcd-lib/view/view
 examples/etcd-lib/watcher/watcher
 examples/flags-lib/flags-lib
+examples/grpc-plugin/grpc-client/grpc-client
 examples/grpc-plugin/grpc-server/grpc-server
 examples/kafka-lib/asyncproducer/asyncproducer
 examples/kafka-lib/consumer/consumer

examples/grpc-plugin/README.md

@@ -1,12 +1,18 @@
 # grpc-plugin
 
-To run the `grpc-server` example, simply type in grpc-server folder:
+Start the `grpc-server` example typing following in the grpc-server folder:
 ```
-go run main.go deps.go [--grpc-config=<config-filepath>]
+go run main.go 
 ```
 
-To run the `grpc-client` example, simply type in grpc-client folder:
+In order to pass custom configuration file (for example the `grpc.conf` located in the same directory), start grpc-server with following parameter:
 ```
-go run main.go deps.go
+go run main --grpc-config=<config-filepath>
+```
+Note: `main.go` must be edited in this case because it makes use of the direct config injection via `grpc.UseConf` method, which overrides any provided config file. To enable it, remove method mentioned. 
+
+Start the `grpc-client` exampl typing following in the grpc-client folder:
+```
+go run main.go
 ```
 

examples/grpc-plugin/grpc-server/grpc.conf

@@ -1 +1,2 @@
-Endpoint: "0.0.0.0:9111"
+endpoint: "0.0.0.0:9111"
+extended-logging: true

examples/grpc-plugin/grpc-server/main.go

@@ -25,8 +25,10 @@ const PluginName = "myPlugin"
 func main() {
 	grpcPlug := grpc.NewPlugin(
 		grpc.UseHTTP(&rest.DefaultPlugin),
+		// Remove 'UseConf' in order to allow GRPC config file
 		grpc.UseConf(grpc.Config{
 			Endpoint: "localhost:9111",
+			ExtendedLogging: true,
 		}),
 		grpc.UseAuth(&grpc.Authenticator{
 			Username: "testuser",

rpc/grpc/config.go

@@ -58,6 +58,9 @@ type Config struct {
 	Keyfile           string   `json:"key-file"`
 	CAfiles           []string `json:"ca-files"`
 
+	// ExtendedLogging enables detailed GRPC logging
+	ExtendedLogging bool `json:"extended-logging"`
+
 	// Compression for inbound/outbound messages.
 	// Supported only gzip.
 	//TODO Compression string

rpc/grpc/grpc.conf

@@ -31,6 +31,9 @@ max-concurrent-streams: 0
 
 # Set custom CA to verify client's certificate.
 # If not set, client's certificate is not required.
-#ca-files: 
+#ca-files:
 #  - /path/to/ca1.pem
 #  - /path/to/ca2.pem
+
+# Enables logging additional GRPC transport messages
+extended-logging: false

rpc/grpc/plugin_impl_grpc.go

@@ -20,6 +20,8 @@ import (
 	"net/http"
 	"strconv"
 
+	"google.golang.org/grpc/grpclog"
+
 	grpc_auth "github.com/grpc-ecosystem/go-grpc-middleware/auth"
 	"github.com/ligato/cn-infra/infra"
 	"github.com/ligato/cn-infra/rpc/rest"
@@ -28,6 +30,10 @@ import (
 	"google.golang.org/grpc/credentials"
 )
 
+// set according to google.golang.org/grpc/internal/transport/log.go
+// transport package only logs to verbose level 2 by default
+const logLevel = 2
+
 // Plugin maintains the GRPC netListener (see Init, AfterInit, Close methods)
 type Plugin struct {
 	Deps
@@ -85,9 +91,14 @@ func (p *Plugin) Init() (err error) {
 			opts = append(opts, grpc.UnaryInterceptor(grpc_auth.UnaryServerInterceptor(p.auther.Authenticate)))
 		}
 		p.grpcServer = grpc.NewServer(opts...)
+	}
 
-		//grpclog.SetLogger(p.Log.NewLogger("grpc-server"))
+	grpcLogger := p.Log.NewLogger("grpc-server")
+	if p.Config != nil && p.Config.ExtendedLogging {
+		p.Log.Info("GRPC transport logging enabled")
+		grpcLogger.SetVerbosity(logLevel)
 	}
+	grpclog.SetLoggerV2(grpcLogger)
 
 	return nil
 }