echoext

Documentation

Index

• Variables
• func Logger() echo.MiddlewareFunc
• func LoggerWithConfig(config LoggerConfig) echo.MiddlewareFunc
• func RecoverLogErrorFunc(c echo.Context, err error, stack []byte) error
• type LoggerConfig

Variables

var (
	// DefaultLoggerConfig is the default Logger middleware config.
	DefaultLoggerConfig = LoggerConfig{
		Skipper: middleware.DefaultSkipper,
		Format: []string{
			"time",
			"time_rfc3339_nano",
			"id",
			"remote_ip",
			"host",
			"method",
			"uri",
			"user_agent",
			"status",
			"error",
			"latency",
			"latency_human",
			"bytes_in",
			"bytes_out",
		},
		CustomTimeFormat: "2006-01-02 15:04:05.00000",
		Logger:           &log.Logger,
	}
)

Functions

func Logger

func Logger() echo.MiddlewareFunc

Logger returns a middleware that logs HTTP requests.

func LoggerWithConfig

func LoggerWithConfig(config LoggerConfig) echo.MiddlewareFunc

LoggerWithConfig returns a Logger middleware with config. See: `Logger()`.

func RecoverLogErrorFunc

func RecoverLogErrorFunc(c echo.Context, err error, stack []byte) error

Types

type LoggerConfig

type LoggerConfig struct {
	// Skipper defines a function to skip middleware.
	Skipper middleware.Skipper

	// Tags to construct the logger format.
	//
	// - time_unix
	// - time_unix_milli
	// - time_unix_micro
	// - time_unix_nano
	// - time_rfc3339
	// - time_rfc3339_nano
	// - time_custom
	// - id (Request ID)
	// - remote_ip
	// - uri
	// - host
	// - method
	// - path
	// - route
	// - protocol
	// - referer
	// - user_agent
	// - status
	// - error
	// - latency (In nanoseconds)
	// - latency_human (Human readable)
	// - bytes_in (Bytes received)
	// - bytes_out (Bytes sent)
	// - header:<NAME>
	// - query:<NAME>
	// - form:<NAME>
	// - custom (see CustomTagFunc field)
	//
	// Example []string{"remote_ip", "status"}
	//
	// Optional. Default value DefaultLoggerConfig.Format.
	Format []string

	// Optional. Default value DefaultLoggerConfig.CustomTimeFormat.
	CustomTimeFormat string

	Logger *zerolog.Logger
}

LoggerConfig defines the config for Logger middleware.