log

package
v0.0.0-...-46352cc Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 2, 2022 License: GPL-3.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	HeaderXSpanId = "X-Span-Id"
	CtxTraceId    = "TRACE_ID"
	CtxSpanId     = "SPAN_ID"
)

Variables

View Source 
var (
	// DefaultLoggerConfig is the default Logger middleware config.
	DefaultLoggerConfig = LoggerConfig{
		Skipper: middleware.DefaultSkipper,

		Format: `{"time":"${time_rfc3339_nano}","traceId":"${traceId}", "spanId":"${spanId}", "remote_ip":"${remote_ip}",` +
			`"host":"${host}","method":"${method}","uri":"${uri}","user_agent":"${user_agent}",` +
			`"status":${status},"error":"${error}","latency":${latency},"latency_human":"${latency_human}"` +
			`,"bytes_in":${bytes_in},"bytes_out":${bytes_out}}` + "\n",
		CustomTimeFormat: "2006-01-02 15:04:05.00000",
		// contains filtered or unexported fields
	}
)
View Source 
var (
	// DefaultRequestIDConfig is the default RequestID middleware config.
	DefaultRequestIDConfig = RequestIDConfig{
		Skipper:       middleware.DefaultSkipper,
		Generator:     generator,
		TraceIdHeader: echo.HeaderXRequestID,
		SpanIdHeader:  HeaderXSpanId,
	}
)

Functions

func CDebug 

func CDebug(ctx echo.Context, i ...interface{})

func CDebugf 

func CDebugf(ctx echo.Context, format string, args ...interface{})

func CDebugj 

func CDebugj(ctx echo.Context, j JSON)

func CError 

func CError(ctx echo.Context, i ...interface{})

func CErrorf 

func CErrorf(ctx echo.Context, format string, args ...interface{})

func CErrorj 

func CErrorj(ctx echo.Context, j JSON)

func CFatal 

func CFatal(ctx echo.Context, i ...interface{})

func CFatalf 

func CFatalf(ctx echo.Context, format string, args ...interface{})

func CFatalj 

func CFatalj(ctx echo.Context, j JSON)

func CInfo 

func CInfo(ctx echo.Context, i ...interface{})

func CInfof 

func CInfof(ctx echo.Context, format string, args ...interface{})

func CInfoj 

func CInfoj(ctx echo.Context, j JSON)

func CPanic 

func CPanic(ctx echo.Context, i ...interface{})

func CPanicf 

func CPanicf(ctx echo.Context, format string, args ...interface{})

func CPanicj 

func CPanicj(ctx echo.Context, j JSON)

func CPrint 

func CPrint(ctx echo.Context, i ...interface{})

func CPrintf 

func CPrintf(ctx echo.Context, format string, args ...interface{})

func CPrintj 

func CPrintj(ctx echo.Context, j JSON)

func CWarn 

func CWarn(ctx echo.Context, i ...interface{})

func CWarnf 

func CWarnf(ctx echo.Context, format string, args ...interface{})

func CWarnj 

func CWarnj(ctx echo.Context, j JSON)

func Debug 

func Debug(i ...interface{})

func Debugf 

func Debugf(format string, args ...interface{})

func Debugj 

func Debugj(j JSON)

func DisableColor 

func DisableColor()

func EnableColor 

func EnableColor()

func Error 

func Error(i ...interface{})

func Errorf 

func Errorf(format string, args ...interface{})

func Errorj 

func Errorj(j JSON)

func Fatal 

func Fatal(i ...interface{})

func Fatalf 

func Fatalf(format string, args ...interface{})

func Fatalj 

func Fatalj(j JSON)

func GetSpanId 

func GetSpanId(c echo.Context) string

func GetTraceId 

func GetTraceId(c echo.Context) string

func Info 

func Info(i ...interface{})

func Infof 

func Infof(format string, args ...interface{})

func Infoj 

func Infoj(j JSON)

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 Output 

func Output() io.Writer

func Panic 

func Panic(i ...interface{})

func Panicf 

func Panicf(format string, args ...interface{})

func Panicj 

func Panicj(j JSON)

func Prefix 

func Prefix() string

func Print 

func Print(i ...interface{})

func Printf 

func Printf(format string, args ...interface{})

func Printj 

func Printj(j JSON)

func RequestID 

func RequestID() echo.MiddlewareFunc

RequestID returns a X-Request-ID middleware.

func RequestIDWithConfig 

func RequestIDWithConfig(config RequestIDConfig) echo.MiddlewareFunc

RequestIDWithConfig returns a X-Request-ID middleware with config.

func RequestIDWithHeaders 

func RequestIDWithHeaders(traceIdHeader string, spanIdHeader string) echo.MiddlewareFunc

RequestID returns a X-Request-ID middleware with partial config.

func SetHeader 

func SetHeader(h string)

func SetLevel 

func SetLevel(level Lvl)

func SetOutput 

func SetOutput(w io.Writer)

func SetPrefix 

func SetPrefix(p string)

func Warn 

func Warn(i ...interface{})

func Warnf 

func Warnf(format string, args ...interface{})

func Warnj 

func Warnj(j JSON)

Types

type CLogger 

type CLogger struct {
	// contains filtered or unexported fields
}

func New 

func New(prefix string) (l *CLogger)

func (*CLogger) CDebug 

func (l *CLogger) CDebug(ctx echo.Context, i ...interface{})

func (*CLogger) CDebugf 

func (l *CLogger) CDebugf(ctx echo.Context, format string, args ...interface{})

func (*CLogger) CDebugj 

func (l *CLogger) CDebugj(ctx echo.Context, j JSON)

func (*CLogger) CError 

func (l *CLogger) CError(ctx echo.Context, i ...interface{})

func (*CLogger) CErrorf 

func (l *CLogger) CErrorf(ctx echo.Context, format string, args ...interface{})

func (*CLogger) CErrorj 

func (l *CLogger) CErrorj(ctx echo.Context, j JSON)

func (*CLogger) CFatal 

func (l *CLogger) CFatal(ctx echo.Context, i ...interface{})

func (*CLogger) CFatalf 

func (l *CLogger) CFatalf(ctx echo.Context, format string, args ...interface{})

func (*CLogger) CFatalj 

func (l *CLogger) CFatalj(ctx echo.Context, j JSON)

func (*CLogger) CInfo 

func (l *CLogger) CInfo(ctx echo.Context, i ...interface{})

func (*CLogger) CInfof 

func (l *CLogger) CInfof(ctx echo.Context, format string, args ...interface{})

func (*CLogger) CInfoj 

func (l *CLogger) CInfoj(ctx echo.Context, j JSON)

func (*CLogger) CPanic 

func (l *CLogger) CPanic(ctx echo.Context, i ...interface{})

func (*CLogger) CPanicf 

func (l *CLogger) CPanicf(ctx echo.Context, format string, args ...interface{})

func (*CLogger) CPanicj 

func (l *CLogger) CPanicj(ctx echo.Context, j JSON)

func (*CLogger) CPrint 

func (l *CLogger) CPrint(ctx echo.Context, i ...interface{})

func (*CLogger) CPrintf 

func (l *CLogger) CPrintf(ctx echo.Context, format string, args ...interface{})

func (*CLogger) CPrintj 

func (l *CLogger) CPrintj(ctx echo.Context, j JSON)

func (*CLogger) CWarn 

func (l *CLogger) CWarn(ctx echo.Context, i ...interface{})

func (*CLogger) CWarnf 

func (l *CLogger) CWarnf(ctx echo.Context, format string, args ...interface{})

func (*CLogger) CWarnj 

func (l *CLogger) CWarnj(ctx echo.Context, j JSON)

func (*CLogger) Color 

func (l *CLogger) Color() *color.Color

func (*CLogger) Debug 

func (l *CLogger) Debug(i ...interface{})

func (*CLogger) Debugf 

func (l *CLogger) Debugf(format string, args ...interface{})

func (*CLogger) Debugj 

func (l *CLogger) Debugj(j JSON)

func (*CLogger) DisableColor 

func (l *CLogger) DisableColor()

func (*CLogger) EnableColor 

func (l *CLogger) EnableColor()

func (*CLogger) Error 

func (l *CLogger) Error(i ...interface{})

func (*CLogger) Errorf 

func (l *CLogger) Errorf(format string, args ...interface{})

func (*CLogger) Errorj 

func (l *CLogger) Errorj(j JSON)

func (*CLogger) Fatal 

func (l *CLogger) Fatal(i ...interface{})

func (*CLogger) Fatalf 

func (l *CLogger) Fatalf(format string, args ...interface{})

func (*CLogger) Fatalj 

func (l *CLogger) Fatalj(j JSON)

func (*CLogger) Info 

func (l *CLogger) Info(i ...interface{})

func (*CLogger) Infof 

func (l *CLogger) Infof(format string, args ...interface{})

func (*CLogger) Infoj 

func (l *CLogger) Infoj(j JSON)

func (*CLogger) Level 

func (l *CLogger) Level() Lvl

func (*CLogger) Output 

func (l *CLogger) Output() io.Writer

func (*CLogger) Panic 

func (l *CLogger) Panic(i ...interface{})

func (*CLogger) Panicf 

func (l *CLogger) Panicf(format string, args ...interface{})

func (*CLogger) Panicj 

func (l *CLogger) Panicj(j JSON)

func (*CLogger) Prefix 

func (l *CLogger) Prefix() string

func (*CLogger) Print 

func (l *CLogger) Print(i ...interface{})

func (*CLogger) Printf 

func (l *CLogger) Printf(format string, args ...interface{})

func (*CLogger) Printj 

func (l *CLogger) Printj(j JSON)

func (*CLogger) SetHeader 

func (l *CLogger) SetHeader(h string)

func (*CLogger) SetLevel 

func (l *CLogger) SetLevel(level Lvl)

func (*CLogger) SetOutput 

func (l *CLogger) SetOutput(w io.Writer)

func (*CLogger) SetPrefix 

func (l *CLogger) SetPrefix(p string)

func (*CLogger) Warn 

func (l *CLogger) Warn(i ...interface{})

func (*CLogger) Warnf 

func (l *CLogger) Warnf(format string, args ...interface{})

func (*CLogger) Warnj 

func (l *CLogger) Warnj(j JSON)

type JSON 

type JSON map[string]interface{}

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_nano
	// - time_rfc3339
	// - time_rfc3339_nano
	// - time_custom
	// - id (Request ID)
	// - remote_ip
	// - uri
	// - host
	// - method
	// - path
	// - 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>
	//
	// Example "${remote_ip} ${status}"
	//
	// Optional. Default value DefaultLoggerConfig.Format.
	Format string `yaml:"format"`

	// Optional. Default value DefaultLoggerConfig.CustomTimeFormat.
	CustomTimeFormat string `yaml:"custom_time_format"`

	// Output is a writer where logs in JSON format are written.
	// Optional. Default value os.Stdout.
	Output io.Writer
	// contains filtered or unexported fields
}

LoggerConfig defines the config for Logger middleware.

type Lvl 

type Lvl uint8
const (
	DEBUG Lvl = iota + 1
	INFO
	WARN
	ERROR
	OFF
)

func Level 

func Level() Lvl

func ParseLvl 

func ParseLvl(lvl string) Lvl

type RequestIDConfig 

type RequestIDConfig struct {
	// Skipper defines a function to skip middleware.
	Skipper middleware.Skipper
	// Generator defines a function to generate an ID.
	// Optional. Default value random.String(32).
	Generator     func() string
	TraceIdHeader string
	SpanIdHeader  string
}

RequestIDConfig defines the config for RequestID middleware.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.