Documentation
¶
Overview ¶
Description: 日志模块
Index ¶
- Constants
- func Any(key string, value interface{}) zapcore.Field
- func DPanic(loggerName string, msg string, fields ...Field)
- func Debug(loggerName string, msg string, fields ...Field)
- func Error(loggerName string, msg string, fields ...Field)
- func Fatal(loggerName string, msg string, fields ...Field)
- func Info(loggerName string, msg string, fields ...Field)
- func Panic(loggerName string, msg string, fields ...Field)
- func Print(msg ...any)
- func Printf(format string, args ...any)
- func Warn(loggerName string, msg string, fields ...Field)
- type Encoder
- type Field
- func Duration(key string, val time.Duration) Field
- func Int(key string, val int) Field
- func Int64(key string, val int64) Field
- func Reflect(key string, val interface{}) Field
- func String(key string, val string) Field
- func Strings(key string, ss []string) Field
- func Time(key string, val time.Time) Field
- type Level
- type Logger
- func (l *Logger) DPanic(msg string, fields ...Field)
- func (l *Logger) Debug(msg string, fields ...Field)
- func (l *Logger) Error(msg string, fields ...Field)
- func (l *Logger) Fatal(msg string, fields ...Field)
- func (l *Logger) Info(msg string, fields ...Field)
- func (l *Logger) Panic(msg string, fields ...Field)
- func (l *Logger) SetCaller(hasCaller bool) *Logger
- func (l *Logger) SetEncoder(consoleEncoder Encoder, fileEncoder Encoder) *Logger
- func (l *Logger) SetLevel(level Level) *Logger
- func (l *Logger) SetOutputPath(path string, maxSize int, maxBackups int, maxAge int) *Logger
- func (l *Logger) Warn(msg string, fields ...Field)
- type WriteSyncer
Constants ¶
View Source
const ( // DebugLevel debug级别 DebugLevel = zapcore.DebugLevel // InfoLevel info级别 InfoLevel = zapcore.InfoLevel // WarnLevel warn级别 WarnLevel = zapcore.WarnLevel // ErrorLevel error级别 ErrorLevel = zapcore.ErrorLevel // DPanicLevel dpanic级别 DPanicLevel = zapcore.DPanicLevel // PanicLevel panic级别 PanicLevel = zapcore.PanicLevel // FatalLevel fatal级别 FatalLevel = zapcore.FatalLevel )
Variables ¶
This section is empty.
Functions ¶
func DPanic ¶ added in v0.5.0
DPanic 记录一个DPanic级别的日志。
Params:
- loggerName: 日志对象名称。
- msg: 日志内容。
- fields: Field类型的可变参数。
Example:
tlog.DPanic("dpanic", tlog.String("rquestTime", t.Format("2006-01-02 15:04:05")))
func Debug ¶ added in v0.5.0
Debug 记录一个Debug级别的日志。
Params:
- loggerName: 日志对象名称。
- msg: 日志内容。
- fields: Field类型的可变参数。
Example:
tlog.Debug("debug", tlog.String("rquestTime", t.Format("2006-01-02 15:04:05")))
func Error ¶ added in v0.5.0
Error 记录一个Error级别的日志。
Params:
- loggerName: 日志对象名称。
- msg: 日志内容。
- fields: Field类型的可变参数。
Example:
tlog.Error("error", tlog.String("rquestTime", t.Format("2006-01-02 15:04:05")))
func Fatal ¶ added in v0.5.0
Fatal 记录一个Fatal级别的日志。
Params:
- loggerName: 日志对象名称。
- msg: 日志内容。
- fields: Field类型的可变参数。
Example:
tlog.Fatal("fatal", tlog.String("rquestTime", t.Format("2006-01-02 15:04:05")))
func Info ¶ added in v0.5.0
Info 记录一个Info级别的日志。
Params:
- loggerName: 日志对象名称。
- msg: 日志内容。
- fields: Field类型的可变参数。
Example:
tlog.Info("info", tlog.String("rquestTime", t.Format("2006-01-02 15:04:05")))
func Panic ¶ added in v0.5.0
Panic 记录一个Panic级别的日志。
Params:
- loggerName: 日志对象名称。
- msg: 日志内容。
- fields: Field类型的可变参数。
Example:
tlog.Panic("panic", tlog.String("rquestTime", t.Format("2006-01-02 15:04:05")))
func Print ¶
func Print(msg ...any)
Print 打印输出日志。使用的loggerName为print,print的日志级别为Debug,默认只输出到控制台。
如果想要不显示Caller信息，可以使用tlog.GetLogger("print").SetCaller(false)。
如果需要记录到文件，可以使用tlog.GetLogger("print").SetOutputPath("log/print.log")。
Params:
- msg: 日志内容
- fields: Field类型的可变参数
Example:
tlog.Print("api",
tlog.Int("code", 321321),
)
Types ¶
type Field ¶
Field 日志字段
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger 日志对象
func Get ¶ added in v0.5.0
Get 获取日志对象，如果获取的对象不存在则新建一个日志对象并返回。
创建的日志对象默认只输出到控制条，日志级别为Debug。并且默认关闭Caller信息，如果有需要可以通过SetCaller(true)开启。
Params:
- loggerName: 日志对象名称，用于匹配日志
Returns:
0: 日志对象。
Example:
logger := tlog.Get("api")
func (*Logger) DPanic ¶ added in v0.5.0
DPanic 记录一个DPanic级别的日志。
Params:
- msg: 日志内容。
- fields: Field类型的可变参数。
func (*Logger) Debug ¶ added in v0.5.0
Debug 记录一个Debug级别的日志。
Params:
- msg: 日志内容。
- fields: Field类型的可变参数。
func (*Logger) Error ¶ added in v0.5.0
Error 记录一个Error级别的日志。
Params:
- msg: 日志内容。
- fields: Field类型的可变参数。
func (*Logger) Fatal ¶ added in v0.5.0
Fatal 记录一个Fatal级别的日志。
Params:
- msg: 日志内容。
- fields: Field类型的可变参数。
func (*Logger) Panic ¶ added in v0.5.0
Panic 记录一个Panic级别的日志。
Params:
- msg: 日志内容。
- fields: Field类型的可变参数。
func (*Logger) SetCaller ¶ added in v0.5.0
SetCaller 设置是否输出Caller信息，保留除输出Caller信息外的其他设置。
Params:
- hasCaller: 是否输出Caller信息
Returns:
0: 日志对象。
Example:
logger := tlog.GetLogger("api").SetCaller(false)
func (*Logger) SetEncoder ¶ added in v0.5.0
SetEncoder 设置输出格式，保留除输出格式外的其他设置。
Params:
- consoleEncoder: 控制台输出格式
- fileEncoder: 文件输出格式
Returns:
0: 日志对象。
Example:
consoleEncoder := zap.NewProductionEncoderConfig()
consoleEncoder.EncodeTime = func(t time.Time, enc zapcore.PrimitiveArrayEncoder) {
enc.AppendString("[\033[36m" + t.Format("2006-01-02 15:04:05.000") + "\033[0m]")
}
fileEncoder := zap.NewProductionEncoderConfig()
fileEncoder.EncodeTime = zapcore.TimeEncoderOfLayout("2006-01-02 15:04:05.000")
logger := tlog.GetLogger("api").SetEncoder(consoleEncoder, fileEncoder)
func (*Logger) SetLevel ¶ added in v0.5.0
SetLevel 设置日志级别，保留除日志级别外的其他设置。
Params:
- level: 日志级别
Returns:
0: 日志对象。
Example:
logger := tlog.GetLogger("api").SetLevel(tlog.InfoLevel)
func (*Logger) SetOutputPath ¶ added in v0.5.0
SetOutputPath 设置日志输出路径，保留除输出路径外的其他设置。
Params:
- path: 日志输出路径
- maxSize: 日志文件大小，单位MB。如果文件超过这个大小会被切割。默认100MB。
- maxBackups: 需要保留的旧日志文件数，默认保留所有旧日志文件，但是maxAge参数还是会导致文件被删除。
- maxAge: 日志文件最大保存天数。
Returns:
0: 日志对象。
Example:
logger := tlog.GetLogger("api").SetOutputPath("log/api/api.log")
Source Files
Click to show internal directories.
Click to hide internal directories.