add simple log

Author: zhufuyi

internal/routers/routers.go

@@ -40,7 +40,7 @@ func NewRouter() *gin.Engine {
 	// request id middleware
 	r.Use(middleware.RequestID())
 
-	// logger middleware
+	// logger middleware, to print simple messages, replace middleware.Logging with middleware.SimpleLog
 	r.Use(middleware.Logging(
 		middleware.WithLog(logger.Get()),
 		middleware.WithRequestIDFromContext(),

internal/routers/routers_pbExample.go

@@ -40,7 +40,7 @@ func NewRouter_pbExample() *gin.Engine { //nolint
 	// request id middleware
 	r.Use(middleware.RequestID())
 
-	// logger middleware
+	// logger middleware, to print simple messages, replace middleware.Logging with middleware.SimpleLog
 	r.Use(middleware.Logging(
 		middleware.WithLog(logger.Get()),
 		middleware.WithRequestIDFromContext(),

internal/server/grpc.go

@@ -151,7 +151,7 @@ func (s *grpcServer) unaryServerOptions() grpc.ServerOption {
 		interceptor.UnaryServerRequestID(),
 	}
 
-	// logger interceptor
+	// logger interceptor, to print simple messages, replace interceptor.UnaryServerLog with interceptor.UnaryServerSimpleLog
 	unaryServerInterceptors = append(unaryServerInterceptors, interceptor.UnaryServerLog(
 		logger.Get(),
 		interceptor.WithReplaceGRPCLogger(),
@@ -210,7 +210,7 @@ func (s *grpcServer) streamServerOptions() grpc.ServerOption {
 		//interceptor.StreamServerRequestID(),
 	}
 
-	// logger interceptor
+	// logger interceptor, to print simple messages, replace interceptor.StreamServerLog with interceptor.StreamServerSimpleLog
 	streamServerInterceptors = append(streamServerInterceptors, interceptor.StreamServerLog(
 		logger.Get(),
 		interceptor.WithReplaceGRPCLogger(),
@@ -237,7 +237,6 @@ func (s *grpcServer) streamServerOptions() grpc.ServerOption {
 	// metrics interceptor
 	if config.Get().App.EnableMetrics {
 		streamServerInterceptors = append(streamServerInterceptors, interceptor.StreamServerMetrics())
-		s.registerMetricsMuxAndMethodFunc = s.registerMetricsMuxAndMethod()
 	}
 
 	// limit interceptor

pkg/gin/middleware/README.md

@@ -1,38 +1,40 @@
 ## middleware
 
-gin middleware plugin.
+Gin middleware plugin.
 
 <br>
 
 ## Example of use
 
 ### logging middleware
 
-You can set the maximum length for printing, add a request id field, ignore print path, customize [zap](go.uber.org/zap) log
+You can set the maximum length for printing, add a request id field, ignore print path, customize [zap](go.uber.org/zap) log.
 
 ```go
+    import "github.com/zhufuyi/sponge/pkg/gin/middleware"
+
     r := gin.Default()
-	
-    r.Use(middleware.Logging())
 
-    r.Use(middleware.Logging(
+	// default
+    r.Use(middleware.Logging()) // simplified logging using middleware.SimpleLog()
+
+	// custom
+    r.Use(middleware.Logging(    // simplified logging using middleware.SimpleLog(WithRequestIDFromHeader())
         middleware.WithMaxLen(400),
-        //WithRequestIDFromHeader(),
-        WithRequestIDFromContext(),
+        WithRequestIDFromHeader(),
+        //WithRequestIDFromContext(),
+		//middleware.WithLog(log), // custom zap log
         //middleware.WithIgnoreRoutes("/hello"),
     ))
-
-    log, _ := logger.Init(logger.WithFormat("json"))
-    r.Use(middlewareLogging(
-        middleware.WithLog(log),
-    ))
 ```
 
 <br>
 
 ### Allow cross-domain requests middleware
 
 ```go
+    import "github.com/zhufuyi/sponge/pkg/gin/middleware"
+
     r := gin.Default()
     r.Use(middleware.Cors())
 ```
@@ -44,17 +46,19 @@ You can set the maximum length for printing, add a request id field, ignore prin
 Adaptive flow limitation based on hardware resources.
 
 ```go
+    import "github.com/zhufuyi/sponge/pkg/gin/middleware"
+
     r := gin.Default()
 
     // e.g. (1) use default
-    // r.Use(RateLimit())
+    // r.Use(middleware.RateLimit())
 
     // e.g. (2) custom parameters
-    r.Use(RateLimit(
-    WithWindow(time.Second*10),
-    WithBucket(100),
-    WithCPUThreshold(100),
-    WithCPUQuota(0.5),
+    r.Use(middleware.RateLimit(
+        WithWindow(time.Second*10),
+        WithBucket(100),
+        WithCPUThreshold(100),
+        WithCPUQuota(0.5),
     ))
 ```
 
@@ -63,9 +67,12 @@ Adaptive flow limitation based on hardware resources.
 ### Circuit Breaker middleware
 
 ```go
+    import "github.com/zhufuyi/sponge/pkg/gin/middleware"
+
     r := gin.Default()
-    r.Use(CircuitBreaker())
+    r.Use(middleware.CircuitBreaker())
 ```
+
 <br>
 
 ### jwt authorization middleware
@@ -74,6 +81,7 @@ Adaptive flow limitation based on hardware resources.
 
 ```go
 import "github.com/zhufuyi/sponge/pkg/jwt"
+import "github.com/zhufuyi/sponge/pkg/gin/middleware"
 
 func main() {
     r := gin.Default()
@@ -102,12 +110,14 @@ func Login(c *gin.Context) {
     // save token
 }
 ```
+
 <br>
 
 #### custom authorization
 
 ```go
 import "github.com/zhufuyi/sponge/pkg/jwt"
+import "github.com/zhufuyi/sponge/pkg/gin/middleware"
 
 func main() {
     r := gin.Default()
@@ -153,6 +163,9 @@ func Login(c *gin.Context) {
 ### tracing middleware
 
 ```go
+import "github.com/zhufuyi/sponge/pkg/tracer"
+import "github.com/zhufuyi/sponge/pkg/gin/middleware"
+
 func InitTrace(serviceName string) {
 	exporter, err := tracer.NewJaegerAgentExporter("192.168.3.37", "6831")
 	if err != nil {
@@ -192,6 +205,8 @@ func SpanDemo(serviceName string, spanName string, ctx context.Context) {
 ### Metrics middleware
 
 ```go
+	import "github.com/zhufuyi/sponge/pkg/gin/middleware/metrics"
+
 	r := gin.Default()
 
 	r.Use(metrics.Metrics(r,
@@ -205,11 +220,13 @@ func SpanDemo(serviceName string, spanName string, ctx context.Context) {
 ### Request id
 
 ```go
+	import "github.com/zhufuyi/sponge/pkg/gin/middleware"
+
     r := gin.Default()
-    r.Use(RequestID())
+    r.Use(middleware.RequestID())
 
     // Customized request id key
-    //r.User(RequestID(
+    //r.User(middleware.RequestID(
     //    middleware.WithContextRequestIDKey("your ctx request id key"), // default is request_id
     //    middleware.WithHeaderRequestIDKey("your header request id key"), // default is X-Request-Id
     //))

pkg/gin/middleware/logging.go

@@ -182,3 +182,46 @@ func Logging(opts ...Option) gin.HandlerFunc {
 		o.log.Info(">>>>", fields...)
 	}
 }
+
+// SimpleLog print response info
+func SimpleLog(opts ...Option) gin.HandlerFunc {
+	o := defaultOptions()
+	o.apply(opts...)
+
+	return func(c *gin.Context) {
+		start := time.Now()
+
+		// ignore printing of the specified route
+		if _, ok := o.ignoreRoutes[c.Request.URL.Path]; ok {
+			c.Next()
+			return
+		}
+
+		reqID := ""
+		if o.requestIDFrom == 1 {
+			if v, isExist := c.Get(ContextRequestIDKey); isExist {
+				if requestID, ok := v.(string); ok {
+					reqID = requestID
+				}
+			}
+		} else if o.requestIDFrom == 2 {
+			reqID = c.Request.Header.Get(HeaderXRequestIDKey)
+		}
+
+		// processing requests
+		c.Next()
+
+		// print return message after processing
+		fields := []zap.Field{
+			zap.Int("code", c.Writer.Status()),
+			zap.String("method", c.Request.Method),
+			zap.String("url", c.Request.URL.String()),
+			zap.Int64("time_us", time.Since(start).Microseconds()),
+			zap.Int("size", c.Writer.Size()),
+		}
+		if reqID != "" {
+			fields = append(fields, zap.String(ContextRequestIDKey, reqID))
+		}
+		o.log.Info("[GIN]", fields...)
+	}
+}

pkg/gin/middleware/logging_test.go

@@ -157,7 +157,7 @@ func runLogHTTPServer2() string {
 	gin.SetMode(gin.ReleaseMode)
 	r := gin.Default()
 	r.Use(RequestID())
-	r.Use(Logging(
+	r.Use(SimpleLog(
 		WithLog(logger.Get()),
 		WithMaxLen(200),
 		WithRequestIDFromContext(),