From 1651e1d80d4e390a21bc2d1eeec42123d0be3a4c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dawid=20Wysoki=C5=84ski?= Date: Fri, 16 Sep 2022 14:43:57 +0000 Subject: [PATCH] add example and update README.md (#3) Reviewed-on: https://gitea.dwysokinski.me/Kichiyaki/chizap/pulls/3 --- README.md | 14 +++++++-- _example/basic/go.mod | 16 ++++++++++ _example/basic/go.sum | 25 ++++++++++++++++ _example/basic/main.go | 68 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 121 insertions(+), 2 deletions(-) create mode 100644 _example/basic/go.mod create mode 100644 _example/basic/go.sum create mode 100644 _example/basic/main.go diff --git a/README.md b/README.md index eea629b..d62f766 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ -# chizap +# chizap [![Build Status](https://drone.dwysokinski.me/api/badges/Kichiyaki/chizap/status.svg?ref=refs/heads/master)](https://drone.dwysokinski.me/Kichiyaki/chizap) -HTTP request logger middleware for [go-chi](https://github.com/go-chi/chi). +Request logging middleware for [go-chi](https://github.com/go-chi/chi) using [zap](https://github.com/uber-go/zap). + +## Installation + +```bash +go get gitea.dwysokinski.me/Kichiyaki/chizap +``` + +## Usage + +See the [example](./_example/basic/main.go). diff --git a/_example/basic/go.mod b/_example/basic/go.mod new file mode 100644 index 0000000..cbec401 --- /dev/null +++ b/_example/basic/go.mod @@ -0,0 +1,16 @@ +module gitea.dwysokinski.me/Kichiyaki/chizap/_example/basic + +go 1.18 + +replace gitea.dwysokinski.me/Kichiyaki/chizap => ../.. + +require ( + gitea.dwysokinski.me/Kichiyaki/chizap v0.0.0-00010101000000-000000000000 + github.com/go-chi/chi/v5 v5.0.7 + go.uber.org/zap v1.23.0 +) + +require ( + go.uber.org/atomic v1.9.0 // indirect + go.uber.org/multierr v1.7.0 // indirect +) diff --git a/_example/basic/go.sum b/_example/basic/go.sum new file mode 100644 index 0000000..4a5a489 --- /dev/null +++ b/_example/basic/go.sum @@ -0,0 +1,25 @@ +github.com/benbjohnson/clock v1.1.0 h1:Q92kusRqC1XV2MjkWETPvjJVqKetz1OzxZB7mHJLju8= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/go-chi/chi/v5 v5.0.7 h1:rDTPXLDHGATaeHvVlLcR4Qe0zftYethFucbjVQ1PxU8= +github.com/go-chi/chi/v5 v5.0.7/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8= +github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk= +go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc= +go.uber.org/atomic v1.9.0 h1:ECmE8Bn/WFTYwEW/bpKD3M8VtR/zQVbavAoalC1PYyE= +go.uber.org/atomic v1.9.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc= +go.uber.org/goleak v1.1.11 h1:wy28qYRKZgnJTxGxvye5/wgWr1EKjmUDGYox5mGlRlI= +go.uber.org/multierr v1.7.0 h1:zaiO/rmgFjbmCXdSYJWQcdvOCsthmdaHfr3Gm2Kx4Ec= +go.uber.org/multierr v1.7.0/go.mod h1:7EAYxJLBy9rStEaz58O2t4Uvip6FSURkq8/ppBp95ak= +go.uber.org/zap v1.23.0 h1:OjGQ5KQDEUawVHxNwQgPpiypGHOxo2mNZsOqTak4fFY= +go.uber.org/zap v1.23.0/go.mod h1:D+nX8jyLsMHMYrln8A0rJjFt/T/9/bGgIhAqxv5URuY= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= diff --git a/_example/basic/main.go b/_example/basic/main.go new file mode 100644 index 0000000..6cdf2be --- /dev/null +++ b/_example/basic/main.go @@ -0,0 +1,68 @@ +package main + +import ( + "log" + "net/http" + "strings" + "time" + + "gitea.dwysokinski.me/Kichiyaki/chizap" + "github.com/go-chi/chi/v5" + "go.uber.org/zap" +) + +func main() { + logger, err := zap.NewDevelopment() + if err != nil { + log.Fatalln("zap.NewDevelopment", err) + } + + http.ListenAndServe(":8080", newRouter(logger)) +} + +func newRouter(logger *zap.Logger) *chi.Mux { + router := chi.NewRouter() + + router.Route("/", func(r chi.Router) { + r.Use(chizap.Logger( + logger, + chizap.WithFilter(func(r *http.Request) bool { + return r.URL.Path != "/excluded" + }), + chizap.WithFilter(func(r *http.Request) bool { + return r.URL.Path != "/excluded2" + }), + chizap.WithAdditionalFieldExtractor(func(r *http.Request) []zap.Field { + if !strings.HasPrefix(r.URL.Path, "/delete") { + return nil + } + + return []zap.Field{ + zap.String("id", chi.URLParam(r, "id")), + } + }), + )) + r.Get("/info", func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusOK) + }) + r.Get("/warn", func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusBadRequest) + }) + r.Get("/error", func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusInternalServerError) + }) + r.Get("/excluded", func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusOK) + }) + r.Delete("/delete/{id}", func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusOK) + }) + }) + + router.With(chizap.Logger(logger, chizap.WithTimeFormat(time.RFC1123Z))). + Get("/custom-time-format", func(w http.ResponseWriter, r *http.Request) { + w.WriteHeader(http.StatusOK) + }) + + return router +}