logx

echolog

Zerolog wrapper for Echo web framework.

Installation

go get github.com/theopenlane/core/pkg/logx

Quick start

package main

import (
	"os"
	echo "github.com/theopenlane/echox"
	"github.com/theopenlane/echox/middleware"
	"github.com/theopenlane/core/pkg/logx"
)

func main() {
	e := echo.New()
	loggers := logx.Configure(logx.LoggerConfig{
		WithEcho: true,
	})
	e.Logger = loggers.Echo
}

Using existing zerolog instance

package main

func main() {
	e := echo.New()
	loggers := logx.Configure(logx.LoggerConfig{
		Writer:        os.Stdout,
		Level:         zerolog.DebugLevel,
		Pretty:        true,
		IncludeCaller: true,
		Hooks: []zerolog.HookFunc{
			func(e *zerolog.Event, level zerolog.Level, msg string) {
				e.Str("component", "api")
			},
		},
		WithEcho: true,
	})
	e.Logger = loggers.Echo
}

Middleware

Logging requests and attaching request id to a context logger

import (
	"os",
	echo "github.com/theopenlane/echox"
	"github.com/theopenlane/echox/middleware"
	"github.com/theopenlane/core/pkg/logx"
	"github.com/rs/zerolog"
)

func main() {
	e := echo.New()
loggers := logx.Configure(logx.LoggerConfig{
		Writer:        os.Stdout,
		Level:         zerolog.DebugLevel,
		IncludeCaller: true,
		WithEcho:      true,
	})
	logger := loggers.Echo
	e.Logger = logger

	e.Use(middleware.RequestID())
	e.Use(logx.LoggingMiddleware(logx.Config{
		Logger: logger,
	}))
	e.GET("/", func(c echo.Context) error {
		c.Logger().Print("echos interface")
		logx.FromContext(c.Request().Context()).Print("zerlogs interface")

		return c.String(http.StatusOK, "MITB babbyyyyy")
	})
}

Escalate log level for slow requests:

e.Use(logx.Middleware(logx.Config{
    Logger: logger,
    RequestLatencyLevel: zerolog.WarnLevel,
    RequestLatencyLimit: 500 * time.Millisecond,
}))

Nesting under a sub dictionary

e.Use(logx.Middleware(logx.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.

e.Use(logx.Middleware(logx.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", ...}

Enricher: func(c echo.Context, logger zerolog.Context) zerolog.Context {
  userId := c.Get("UserID")
  if userId != nil {
    return logger.Str("user_id", userId.(string))
  }
  return logger.Str("user_id", "")
}

Errors

The middleware does not automatically propagate errors up the chain. If you want to do that, you can set HandleError to true.

e.Use(logx.Middleware(logx.Config{
    Logger: logger,
    HandleError: true,
}))

Helpers

Level converters

import (
    "fmt"
    echo "github.com/theopenlane/echox"
    "github.com/theopenlane/echox/middleware"
    "github.com/labstack/gommon/log"
    "github.com/theopenlane/core/pkg/logx"
)

func main() {
	var z zerolog.Level
	var e log.Lvl

    z, e = logx.MatchEchoLevel(log.WARN)

    fmt.Println(z, e)

    e, z = logx.MatchZeroLevel(zerolog.INFO)

    fmt.Println(z, e)
}

Multiple Log output

writer := zerolog.MultiLevelWriter(consoleWriter, os.Stdout)
loggers := logx.Configure(logx.LoggerConfig{
	Writer:   writer,
	WithEcho: true,
})
middleware := logx.LoggingMiddleware(logx.Config{
	Logger: loggers.Echo,
})

Writing to a file with Lumberjack

fileLogger := &lumberjack.Logger{
	Filename:   "/var/log/myapp/foo.log",
	MaxSize:    500, // megabytes
	MaxBackups: 3,
	MaxAge:     28, // days
	Compress:   true,
}

loggers := logx.Configure(logx.LoggerConfig{
	Writer:   fileLogger,
	WithEcho: true,
})