README
¶
Echo to Zerolog
A simple adapter for using Zerolog with the Echo web framework.
Project status
Complete. Latest commit timestamp might be old - that's okay.
Usage
Steal a complete example from this file or try go run ./demo for a quick start.
import (
"github.com/kofalt/echotozero"
"github.com/labstack/echo/v4"
"github.com/rs/zerolog"
)
func main() {
// Web framework
e := echo.New()
e.HideBanner = true
// Create or use any zerolog logger
zl := zerolog.New()
adapter := echotozero.New(zl)
// Log echo messages + http queries
e.Logger = adapter
e.Use(echotozero.Middleware(adapter))
}
You can also steal middleware.go and mess with which request details are logged.
Notes
This repo is an updated fork of Lecho with a few improvements:
- Simplifed surface area
- Easier to read middleware
- Removed context fiddling
- Added a log level to echo's messages when it lacks one
- Punt more features directly to zerolog
- Updated for more recent golang, actions, etc
There's also a large golang logging discussion going on that might influence both libraries in the future.
This will hold the two together for now.
Known issue
The very first message echo prints is without a level:
7:51AM ??? ⇨ http server started on [::]:8080
Zerolog supports this just fine, but it would be nice to have everything leveled. This message happens because the echo interface demands Output() io.Writer and, for some reason, uses that to print its startup message. Could probably be fixed by messing with echo.
Documentation
¶
Index ¶
- Variables
- func Middleware(logger *Logger) echo.MiddlewareFunc
- func MiddlewareWithOptions(logger *Logger, successLvl, failLvl zerolog.Level, skipper middleware.Skipper) echo.MiddlewareFunc
- type JSON
- type Logger
- func (l *Logger) Debug(i ...interface{})
- func (l *Logger) Debugf(format string, i ...interface{})
- func (l *Logger) Debugj(j JSON)
- func (l *Logger) Error(i ...interface{})
- func (l *Logger) Errorf(format string, i ...interface{})
- func (l *Logger) Errorj(j JSON)
- func (l *Logger) Fatal(i ...interface{})
- func (l *Logger) Fatalf(format string, i ...interface{})
- func (l *Logger) Fatalj(j JSON)
- func (l *Logger) Info(i ...interface{})
- func (l *Logger) Infof(format string, i ...interface{})
- func (l *Logger) Infoj(j JSON)
- func (l *Logger) Level() echoLevel
- func (l *Logger) Output() io.Writer
- func (l *Logger) Panic(i ...interface{})
- func (l *Logger) Panicf(format string, i ...interface{})
- func (l *Logger) Panicj(j JSON)
- func (l *Logger) Prefix() string
- func (l *Logger) Print(i ...interface{})
- func (l *Logger) Printf(format string, i ...interface{})
- func (l *Logger) Printj(j JSON)
- func (l *Logger) SetHeader(h string)
- func (l *Logger) SetLevel(level echoLevel)
- func (l *Logger) SetOutput(newOut io.Writer)
- func (l *Logger) SetPrefix(newPrefix string)
- func (l *Logger) Warn(i ...interface{})
- func (l *Logger) Warnf(format string, i ...interface{})
- func (l *Logger) Warnj(j JSON)
- func (l *Logger) WithContext(ctx context.Context) context.Context
Constants ¶
This section is empty.
Variables ¶
var ( MapEchoToZero = map[echoLevel]zerolog.Level{ echoLib.DEBUG: zerolog.DebugLevel, echoLib.INFO: zerolog.InfoLevel, echoLib.WARN: zerolog.WarnLevel, echoLib.ERROR: zerolog.ErrorLevel, echoLib.OFF: zerolog.NoLevel, } MapZeroToEcho = map[zerolog.Level]echoLevel{ zerolog.DebugLevel: echoLib.DEBUG, zerolog.InfoLevel: echoLib.INFO, zerolog.WarnLevel: echoLib.WARN, zerolog.ErrorLevel: echoLib.ERROR, zerolog.NoLevel: echoLib.OFF, } )
Functions ¶
func Middleware ¶
func Middleware(logger *Logger) echo.MiddlewareFunc
MiddleWare logs successful requests to debug, failed req to error, and never skips.
func MiddlewareWithOptions ¶
func MiddlewareWithOptions(logger *Logger, successLvl, failLvl zerolog.Level, skipper middleware.Skipper) echo.MiddlewareFunc
Source Files
Directories