README
¶
zapx
this is a wrapper of zap. The biggest difference of them is that the wrapper add WithContext method for logger.
How to Use
there are 3 ways to use zapx:
- packaged-embedded way
nothing to init! just using the method zapx.Info(), zapx.Warnf() and so on.
func main() {
zapx.Info("Hello")
zapx.Error("this is an error", zap.Error(errors.New("error!")))
zapx.Warnf("%v", "warn")
}
- global logger instance
func main() {
logger, err := zapx.NewLogger(&zapx.Option{})
if err != nil {
panic(err)
}
logger.Info("hello")
logger.Error("this is an error", zap.Error(errors.New("error!")))
logger.Warnf("%v", "warn")
}
- overwrite packaged-embedded variable
func main() {
err = zapx.Use(&zapx.Option{})
if err != nil {
panic(err)
}
zapx.Info("Hello")
zapx.Error("this is an error", zap.Error(errors.New("error!")))
zapx.Warnf("%v", "warn")
}
Feature
context decoder
the CtxDecoder is just an interface:
type CtxDecoder interface {
DecodeCtx(context.Context) []zap.Field
}
it 'decode' the context and get values from it. Then it converts them into []zap.Field to log.
It is designed to integrated with Tracing: get tracing related info from context, like traceID.
Now, zapx implements some context decoder:
Documentation
¶
Index ¶
- func DPanic(msg string, fields ...zap.Field)
- func DPanicf(template string, args ...interface{})
- func Debug(msg string, fields ...zap.Field)
- func Debugf(template string, args ...interface{})
- func Error(msg string, fields ...zap.Field)
- func Errorf(template string, args ...interface{})
- func Fatal(msg string, fields ...zap.Field)
- func Fatalf(template string, args ...interface{})
- func Info(msg string, fields ...zap.Field)
- func Infof(template string, args ...interface{})
- func Panic(msg string, fields ...zap.Field)
- func Panicf(template string, args ...interface{})
- func Use(opt *Option) error
- func UseCtxDecoder(decoder decoder.CtxDecoder)
- func Warn(msg string, fields ...zap.Field)
- func Warnf(template string, args ...interface{})
- type Logger
- func (log *Logger) DPanic(msg string, fields ...zap.Field)
- func (log *Logger) DPanicf(template string, args ...interface{})
- func (log *Logger) Debug(msg string, fields ...zap.Field)
- func (log *Logger) Debugf(template string, args ...interface{})
- func (log *Logger) Error(msg string, fields ...zap.Field)
- func (log *Logger) Errorf(template string, args ...interface{})
- func (log *Logger) Fatal(msg string, fields ...zap.Field)
- func (log *Logger) Fatalf(template string, args ...interface{})
- func (log *Logger) Info(msg string, fields ...zap.Field)
- func (log *Logger) Infof(template string, args ...interface{})
- func (log *Logger) Panic(msg string, fields ...zap.Field)
- func (log *Logger) Panicf(template string, args ...interface{})
- func (log *Logger) Warn(msg string, fields ...zap.Field)
- func (log *Logger) Warnf(template string, args ...interface{})
- func (log *Logger) With(fields ...zap.Field) *Logger
- func (log *Logger) WithContext(ctx context.Context) *Logger
- type Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func UseCtxDecoder ¶ added in v0.2.1
func UseCtxDecoder(decoder decoder.CtxDecoder)
Types ¶
type Logger ¶ added in v0.2.0
type Logger struct {
decoder.CtxDecoder
// contains filtered or unexported fields
}
func WithContext ¶
type Option ¶ added in v0.2.0
type Option struct {
LogSyncer []zapcore.WriteSyncer
// lumberjack log rolling config.
// to see more information about it, see its github(https://github.com/natefinch/lumberjack)
RollingOption *lumberjack.Logger
LogLevel string
}
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.