Add zap logger middleware as requested at: kataras/iris#2125

Author: kataras

.github/dependabot.yml

@@ -44,3 +44,7 @@ updates:
     directory: "/tollboothic"
     schedule:
       interval: "daily"
+  - package-ecosystem: "gomod"
+    directory: "/zap"
+    schedule:
+      interval: "daily"

README.md

@@ -46,6 +46,7 @@ Middleware is just a chain handlers which can be executed before or after the ma
 | [csrf](csrf)| Cross-Site Request Forgery Protection | [csrf/_example](csrf/_example/main.go) |
 | [throttler](throttler)| Rate limiting access to HTTP endpoints | [throttler/_example](throttler/_example/main.go) |
 | [expmetric](expmetric)| Expvar for counting requests etc. | [expmetric/_example](expmetric/_example/main.go) |
+| [zap](zap)| Provides log handling using zap package | [zap/_examples](zap/_examples/example_1/main.go) |
 
 ### Register a middleware
 

zap/.gitignore

@@ -0,0 +1,24 @@
+# Compiled Object files, Static and Dynamic libs (Shared Objects)
+*.o
+*.a
+*.so
+
+# Folders
+_obj
+_test
+
+# Architecture specific extensions/prefixes
+*.[568vq]
+[568vq].out
+
+*.cgo1.go
+*.cgo2.c
+_cgo_defun.c
+_cgo_gotypes.go
+_cgo_export.*
+
+_testmain.go
+
+*.exe
+*.test
+*.prof

zap/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 Iris Contributors
+Copyright (c) 2017 gin-contrib
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

zap/README.md

@@ -0,0 +1,135 @@
+# zap
+
+Alternative logging through [zap](https://github.com/uber-go/zap) after the [#2125 feature request](https://github.com/kataras/iris/issues/2125). A clone of https://github.com/gin-contrib/zap.
+
+## Usage
+
+### Start using it
+
+Download and install it:
+
+```sh
+go get github.com/iris-contrib/middleware/zap@master
+```
+
+Import it in your code:
+
+```go
+import "github.com/iris-contrib/middleware/zap"
+```
+
+## Example
+
+See the [example](_examples/example_1main.go).
+
+```go
+package main
+
+import (
+	"fmt"
+	"time"
+
+	iriszap "github.com/iris-contrib/middleware/zap"
+	"github.com/kataras/iris/v12"
+	"go.uber.org/zap"
+)
+
+func main() {
+	app := iris.New()
+
+	logger, _ := zap.NewProduction()
+
+	// Add a iriszap middleware, which:
+	//   - Logs all requests, like a combined access and error log.
+	//   - Logs to stdout.
+	//   - RFC3339 with UTC time format.
+	app.Use(iriszap.New(logger, time.RFC3339, true))
+
+	// Logs all panic to error log
+	//   - stack means whether output the stack info.
+	app.Use(iriszap.RecoveryWithZap(logger, true))
+
+	// Example ping request.
+	app.Get("/ping", func(ctx iris.Context) {
+		ctx.Text("pong " + fmt.Sprint(time.Now().Unix()))
+	})
+
+	// Example when panic happen.
+	app.Get("/panic", func(ctx iris.Context) {
+		panic("An unexpected error happen!")
+	})
+
+	// Listen and Server in 0.0.0.0:8080
+	app.Listen(":8080")
+}
+```
+
+## Skip logging
+
+When you want to skip logging for specific path,
+please use `NewWithConfig`
+
+```go
+
+app.Use(NewWithConfig(utcLogger, &Config{
+  TimeFormat: time.RFC3339,
+  UTC: true,
+  SkipPaths: []string{"/no_log"},
+}))
+```
+
+## Custom Zap fields
+
+Example for custom log request body, response request ID or log [Open Telemetry](https://opentelemetry.io/) TraceID.
+
+```go
+func main() {
+	app := iris.New()
+
+	logger, _ := zap.NewProduction()
+
+	app.Use(iriszap.NewWithConfig(logger, &iriszap.Config{
+		UTC:        true,
+		TimeFormat: time.RFC3339,
+		Context: iriszap.Fn(func(ctx iris.Context) []zapcore.Field {
+			req := ctx.Request()
+
+			fields := []zapcore.Field{}
+			// log request ID
+			if requestID := ctx.ResponseWriter().Header().Get("X-Request-Id"); requestID != "" {
+				fields = append(fields, zap.String("request_id", requestID))
+			}
+
+			// log trace and span ID
+			if trace.SpanFromContext(req.Context()).SpanContext().IsValid() {
+				fields = append(fields, zap.String("trace_id", trace.SpanFromContext(req.Context()).SpanContext().TraceID().String()))
+				fields = append(fields, zap.String("span_id", trace.SpanFromContext(req.Context()).SpanContext().SpanID().String()))
+			}
+
+			// log request body
+			var body []byte
+			var buf bytes.Buffer
+			tee := io.TeeReader(req.Body, &buf)
+			body, _ = io.ReadAll(tee)
+			req.Body = io.NopCloser(&buf)
+			fields = append(fields, zap.String("body", string(body)))
+
+			return fields
+		}),
+	}))
+
+	// Example ping request.
+	app.Get("/ping", func(ctx iris.Context) {
+		ctx.Header("X-Request-Id", "1234-5678-9012")
+		ctx.Text("pong " + fmt.Sprint(time.Now().Unix()))
+	})
+
+	app.Post("/ping", func(ctx iris.Context) {
+		ctx.Header("X-Request-Id", "9012-5678-1234")
+		ctx.Text("pong " + fmt.Sprint(time.Now().Unix()))
+	})
+
+	// Listen and Server in 0.0.0.0:8080
+	app.Listen(":8080")
+}
+```

zap/_examples/example_1/main.go

@@ -0,0 +1,39 @@
+package main
+
+import (
+	"fmt"
+	"time"
+
+	iriszap "github.com/iris-contrib/middleware/zap"
+	"github.com/kataras/iris/v12"
+	"go.uber.org/zap"
+)
+
+func main() {
+	app := iris.New()
+
+	logger, _ := zap.NewProduction()
+
+	// Add a iriszap middleware, which:
+	//   - Logs all requests, like a combined access and error log.
+	//   - Logs to stdout.
+	//   - RFC3339 with UTC time format.
+	app.Use(iriszap.New(logger, time.RFC3339, true))
+
+	// Logs all panic to error log
+	//   - stack means whether output the stack info.
+	app.Use(iriszap.RecoveryWithZap(logger, true))
+
+	// Example ping request.
+	app.Get("/ping", func(ctx iris.Context) {
+		ctx.Text("pong " + fmt.Sprint(time.Now().Unix()))
+	})
+
+	// Example when panic happen.
+	app.Get("/panic", func(ctx iris.Context) {
+		panic("An unexpected error happen!")
+	})
+
+	// Listen and Server in 0.0.0.0:8080
+	app.Listen(":8080")
+}

zap/_examples/example_2/go.mod

@@ -0,0 +1,59 @@
+module example_2
+
+go 1.20
+
+replace github.com/iris-contrib/middleware/zap => ../../
+
+require (
+	github.com/iris-contrib/middleware/zap v0.0.0-00010101000000-000000000000
+	github.com/kataras/iris/v12 v12.2.0
+	go.opentelemetry.io/otel/trace v1.14.0
+	go.uber.org/zap v1.24.0
+)
+
+require (
+	github.com/BurntSushi/toml v1.2.1 // indirect
+	github.com/CloudyKit/fastprinter v0.0.0-20200109182630-33d98a066a53 // indirect
+	github.com/CloudyKit/jet/v6 v6.2.0 // indirect
+	github.com/Joker/jade v1.1.3 // indirect
+	github.com/Shopify/goreferrer v0.0.0-20220729165902-8cddb4f5de06 // indirect
+	github.com/andybalholm/brotli v1.0.5 // indirect
+	github.com/aymerick/douceur v0.2.0 // indirect
+	github.com/eknkc/amber v0.0.0-20171010120322-cdade1c07385 // indirect
+	github.com/fatih/structs v1.1.0 // indirect
+	github.com/flosch/pongo2/v4 v4.0.2 // indirect
+	github.com/golang/snappy v0.0.4 // indirect
+	github.com/google/uuid v1.3.0 // indirect
+	github.com/gorilla/css v1.0.0 // indirect
+	github.com/iris-contrib/schema v0.0.6 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
+	github.com/kataras/blocks v0.0.7 // indirect
+	github.com/kataras/golog v0.1.8 // indirect
+	github.com/kataras/pio v0.0.11 // indirect
+	github.com/kataras/sitemap v0.0.6 // indirect
+	github.com/kataras/tunnel v0.0.4 // indirect
+	github.com/klauspost/compress v1.16.0 // indirect
+	github.com/mailgun/raymond/v2 v2.0.48 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/microcosm-cc/bluemonday v1.0.23 // indirect
+	github.com/russross/blackfriday/v2 v2.1.0 // indirect
+	github.com/schollz/closestmatch v2.1.0+incompatible // indirect
+	github.com/sirupsen/logrus v1.8.1 // indirect
+	github.com/tdewolff/minify/v2 v2.12.4 // indirect
+	github.com/tdewolff/parse/v2 v2.6.4 // indirect
+	github.com/valyala/bytebufferpool v1.0.0 // indirect
+	github.com/vmihailenco/msgpack/v5 v5.3.5 // indirect
+	github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
+	github.com/yosssi/ace v0.0.5 // indirect
+	go.opentelemetry.io/otel v1.14.0 // indirect
+	go.uber.org/atomic v1.7.0 // indirect
+	go.uber.org/multierr v1.6.0 // indirect
+	golang.org/x/crypto v0.7.0 // indirect
+	golang.org/x/net v0.8.0 // indirect
+	golang.org/x/sys v0.6.0 // indirect
+	golang.org/x/text v0.8.0 // indirect
+	golang.org/x/time v0.3.0 // indirect
+	google.golang.org/protobuf v1.29.0 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)