log

package

v0.4.9 Latest Latest Go to latest Published: Sep 30, 2025 License: MIT Imports: 13 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/litsea/gin-api

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func DebugRequest(ctx *gin.Context, msg string, attrs map[string]any)
func ErrorRequest(ctx *gin.Context, msg string, attrs map[string]any)
func GetRequestBody(ctx *gin.Context) (*bytes.Buffer, int)
func GetRequestID(ctx *gin.Context) string
func InfoRequest(ctx *gin.Context, msg string, attrs map[string]any)
func Middleware(l Logger) gin.HandlerFunc
func SetLoggerToContext(ctx *gin.Context, l Logger)
func WarnRequest(ctx *gin.Context, msg string, attrs map[string]any)
type Config
type DefaultLogger
- func New(sl *slog.Logger, opts ...Option) *DefaultLogger
- func NewDisabled() *DefaultLogger
type Logger
- func GetLoggerFromContext(ctx *gin.Context) Logger
type Option

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	RequestIDKey = "id"

	RequestBodyMaxSize = 64 * 1024 // 64KB

	HiddenRequestHeaders = map[string]struct{}{
		"authorization": {},
		"cookie":        {},
		"set-cookie":    {},
		"x-auth-token":  {},
		"x-csrf-token":  {},
		"x-xsrf-token":  {},
	}
)

Functions ¶

func DebugRequest ¶ added in v0.4.0

func DebugRequest(ctx *gin.Context, msg string, attrs map[string]any)

func ErrorRequest ¶ added in v0.4.0

func ErrorRequest(ctx *gin.Context, msg string, attrs map[string]any)

func GetRequestBody ¶ added in v0.4.1

func GetRequestBody(ctx *gin.Context) (*bytes.Buffer, int)

func GetRequestID ¶ added in v0.4.0

func GetRequestID(ctx *gin.Context) string

func InfoRequest ¶ added in v0.4.0

func InfoRequest(ctx *gin.Context, msg string, attrs map[string]any)

func Middleware ¶

func Middleware(l Logger) gin.HandlerFunc

func SetLoggerToContext ¶

func SetLoggerToContext(ctx *gin.Context, l Logger)

func WarnRequest ¶ added in v0.4.0

func WarnRequest(ctx *gin.Context, msg string, attrs map[string]any)

Types ¶

type Config ¶ added in v0.4.0

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

type DefaultLogger ¶

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

func New ¶

func New(sl *slog.Logger, opts ...Option) *DefaultLogger

func NewDisabled ¶ added in v0.4.3

func NewDisabled() *DefaultLogger

func (*DefaultLogger) Config ¶ added in v0.4.1

func (l *DefaultLogger) Config() *Config

func (*DefaultLogger) Debug ¶

func (l *DefaultLogger) Debug(msg string, args ...any)

func (*DefaultLogger) DebugRequest ¶ added in v0.4.0

func (l *DefaultLogger) DebugRequest(ctx *gin.Context, msg string, attrs map[string]any)

func (*DefaultLogger) Error ¶

func (l *DefaultLogger) Error(msg string, args ...any)

func (*DefaultLogger) ErrorRequest ¶ added in v0.4.0

func (l *DefaultLogger) ErrorRequest(ctx *gin.Context, msg string, attrs map[string]any)

func (*DefaultLogger) Info ¶

func (l *DefaultLogger) Info(msg string, args ...any)

func (*DefaultLogger) InfoRequest ¶ added in v0.4.0

func (l *DefaultLogger) InfoRequest(ctx *gin.Context, msg string, attrs map[string]any)

func (*DefaultLogger) Warn ¶

func (l *DefaultLogger) Warn(msg string, args ...any)

func (*DefaultLogger) WarnRequest ¶ added in v0.4.0

func (l *DefaultLogger) WarnRequest(ctx *gin.Context, msg string, attrs map[string]any)

type Logger ¶

type Logger interface {
	Debug(msg string, args ...any)
	Info(msg string, args ...any)
	Warn(msg string, args ...any)
	Error(msg string, args ...any)
	DebugRequest(ctx *gin.Context, msg string, attrs map[string]any)
	InfoRequest(ctx *gin.Context, msg string, attrs map[string]any)
	WarnRequest(ctx *gin.Context, msg string, attrs map[string]any)
	ErrorRequest(ctx *gin.Context, msg string, attrs map[string]any)
	Config() *Config
}

func GetLoggerFromContext ¶

func GetLoggerFromContext(ctx *gin.Context) Logger

GetLoggerFromContext get logger context set by SetLoggerToContext()

type Option ¶ added in v0.4.0

type Option func(cfg *Config)

func WithExtraAttrs ¶ added in v0.4.0

func WithExtraAttrs(attrs map[string]any) Option

func WithRequestBody ¶ added in v0.4.0

func WithRequestBody(v bool) Option

func WithRequestHeader ¶ added in v0.4.0

func WithRequestHeader(v bool) Option

func WithRequestIDHeaderKey ¶ added in v0.4.0

func WithRequestIDHeaderKey(v string) Option

func WithStackTrace ¶ added in v0.4.0

func WithStackTrace(v bool) Option

func WithUserAgent ¶ added in v0.4.0

func WithUserAgent(v bool) Option

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL