Documentation
¶
Overview ¶
Package ginzap provides log handling using zap package. Code structure based on ginrus package.
Index ¶
- func CustomRecoveryWithZap(logger ZapLogger, stack bool, recovery gin.RecoveryFunc) gin.HandlerFunc
- func Ginzap(logger ZapLogger, timeFormat string, utc bool) gin.HandlerFunc
- func GinzapWithConfig(logger ZapLogger, conf *Config) gin.HandlerFunc
- func RecoveryWithZap(logger ZapLogger, stack bool) gin.HandlerFunc
- type Config
- type Fn
- type ZapLogger
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CustomRecoveryWithZap ¶
func CustomRecoveryWithZap(logger ZapLogger, stack bool, recovery gin.RecoveryFunc) gin.HandlerFunc
CustomRecoveryWithZap returns a gin.HandlerFunc (middleware) with a custom recovery handler that recovers from any panics and logs requests using uber-go/zap. All errors are logged using zap.Error(). stack means whether output the stack info. The stack info is easy to find where the error occurs but the stack info is too large.
func Ginzap ¶
func Ginzap(logger ZapLogger, timeFormat string, utc bool) gin.HandlerFunc
Ginzap returns a gin.HandlerFunc (middleware) that logs requests using uber-go/zap.
Requests with errors are logged using zap.Error(). Requests without errors are logged using zap.Info().
It receives:
- A time package format string (e.g. time.RFC3339).
- A boolean stating whether to use UTC time zone or local.
func GinzapWithConfig ¶
func GinzapWithConfig(logger ZapLogger, conf *Config) gin.HandlerFunc
GinzapWithConfig returns a gin.HandlerFunc using configs
func RecoveryWithZap ¶
func RecoveryWithZap(logger ZapLogger, stack bool) gin.HandlerFunc
RecoveryWithZap returns a gin.HandlerFunc (middleware) that recovers from any panics and logs requests using uber-go/zap. All errors are logged using zap.Error(). stack means whether output the stack info. The stack info is easy to find where the error occurs but the stack info is too large.
Source Files