https://github.com/ziflex/lecho
Zerolog wrapper for Echo framework 🍅
https://github.com/ziflex/lecho
echo-framework echo-middleware golang zerolog
Last synced: about 2 months ago
JSON representation
Zerolog wrapper for Echo framework 🍅
- Host: GitHub
- URL: https://github.com/ziflex/lecho
- Owner: ziflex
- License: mit
- Created: 2019-07-31T21:36:57.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-03T21:54:50.000Z (12 months ago)
- Last Synced: 2024-10-14T06:47:07.187Z (7 months ago)
- Topics: echo-framework, echo-middleware, golang, zerolog
- Language: Go
- Homepage:
- Size: 68.4 KB
- Stars: 97
- Watchers: 4
- Forks: 11
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lecho :tomato:
[Zerolog](https://github.com/rs/zerolog) wrapper for [Echo](https://echo.labstack.com/) web framework.
## Installation
For Echo v4:
```
go get github.com/ziflex/lecho/v3
```
For Echo v3:
```
go get github.com/ziflex/lecho
```
## Quick start
```go
package main
import (
"os"
"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
"github.com/ziflex/lecho/v3"
)
func main() {
e := echo.New()
e.Logger = lecho.New(os.Stdout)
}
```
### Using existing zerolog instance
```go
package main
import (
"os"
"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
"github.com/ziflex/lecho/v3"
"github.com/rs/zerolog"
)
func main() {
log := zerolog.New(os.Stdout)
e := echo.New()
e.Logger = lecho.From(log)
}
```
## Options
```go
import (
"os",
"github.com/labstack/echo"
"github.com/labstack/echo/middleware"
"github.com/ziflex/lecho/v3"
)
func main() {
e := echo.New()
e.Logger = lecho.New(
os.Stdout,
lecho.WithLevel(log.DEBUG),
lecho.WithFields(map[string]interface{}{ "name": "lecho factory"}),
lecho.WithTimestamp(),
lecho.WithCaller(),
lecho.WithPrefix("we ❤️ lecho"),
lecho.WithHook(...),
lecho.WithHookFunc(...),
)
}
```
## Middleware
### Logging requests and attaching request id to a context logger
```go
import (
"os",
"github.com/labstack/echo"
"github.com/labstack/echo/middleware"
"github.com/ziflex/lecho/v3"
"github.com/rs/zerolog"
)
func main() {
e := echo.New()
logger := lecho.New(
os.Stdout,
lecho.WithLevel(log.DEBUG),
lecho.WithTimestamp(),
lecho.WithCaller(),
)
e.Logger = logger
e.Use(middleware.RequestID())
e.Use(lecho.Middleware(lecho.Config{
Logger: logger
}))
e.GET("/", func(c echo.Context) error {
c.Logger().Print("Echo interface")
zerolog.Ctx(c.Request().Context()).Print("Zerolog interface")
return c.String(http.StatusOK, "Hello, World!")
})
}
```
### Escalate log level for slow requests:
```go
e.Use(lecho.Middleware(lecho.Config{
Logger: logger,
RequestLatencyLevel: zerolog.WarnLevel,
RequestLatencyLimit: 500 * time.Millisecond,
}))
```
### Nesting under a sub dictionary
```go
e.Use(lecho.Middleware(lecho.Config{
Logger: logger,
NestKey: "request"
}))
// Output: {"level":"info","request":{"remote_ip":"5.6.7.8","method":"GET", ...}, ...}
```
### Enricher
Enricher allows you to add additional fields to the log entry.
```go
e.Use(lecho.Middleware(lecho.Config{
Logger: logger,
Enricher: func(c echo.Context, logger zerolog.Context) zerolog.Context {
return e.Str("user_id", c.Get("user_id"))
},
}))
// Output: {"level":"info","user_id":"123", ...}
```
### Errors
Since lecho v3.4.0, the middleware does not automatically propagate errors up the chain.
If you want to do that, you can set `HandleError` to ``true``.
```go
e.Use(lecho.Middleware(lecho.Config{
Logger: logger,
HandleError: true,
}))
```
## Helpers
### Level converters
```go
import (
"fmt",
"github.com/labstack/echo"
"github.com/labstack/echo/middleware"
"github.com/labstack/gommon/log"
"github.com/ziflex/lecho/v3"
)
func main() {
var z zerolog.Level
var e log.Lvl
z, e = lecho.MatchEchoLevel(log.WARN)
fmt.Println(z, e)
e, z = lecho.MatchZeroLevel(zerolog.INFO)
fmt.Println(z, e)
}
```