logger

package module
v0.0.0-...-ff6ce18 Latest Latest
Warning

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

Go to latest
Published: Jul 18, 2020 License: Apache-2.0 Imports: 6 Imported by: 0

README

go-logger

基于zap log的包装,方便引入使用

Documentation

Overview

Package logger ...

Author: go_developer@163.com<张德满>

Description: 日志相关配置及相关默认值配置

File: config.go

Version: 1.0.0

Date: 2020/07/19 01:42:53

Package logger ...

File : logger.go

Decs : 基于 zap 包装的 logger 库

Author : go_developer@163.com<张德满>

Date : 2020/06/27 14:06:03

Index

Constants

View Source
const (
	// DefaultTimeKey 默认时间key
	DefaultTimeKey = "time"
	// DefaultLevelKey 默认level key
	DefaultLevelKey = "level"
	// DefaultLogKey 默认 log key
	DefaultNameKey = "log"
	// 默认 caller key
	DefaultCallerKey = "caller"
	// 默认 message key
	DefaultMessageKey = "message"
	// 默认 stacktrace key
	DefaultStacktraceKey = "trace"
)

定义相关key的默认值

Variables

This section is empty.

Functions

func DefaultFormatEncodeTime

func DefaultFormatEncodeTime(t time.Time, enc zapcore.PrimitiveArrayEncoder)

DefaultFormatEncodeTime 默认的时间格式化函数

Author : go_developer@163.com<张德满>

Date : 2020/06/27 15:07:18

func NewZapLogger

func NewZapLogger(cfg *LogConfig) (*zap.Logger, error)

NewZapLogger 可以直接使用的一套基础配置实例

Author : go_developer@163.com<张德满>

Date : 2020/06/27 14:28:21

func SetTraceLogIDField

func SetTraceLogIDField(field string)

SetTraceLogIDField 更换trace_id字段名

Author : go_developer@163.com<张德满>

Date : 2020/07/19 00:42:33

Types

type KeyInfo

type KeyInfo struct {
	Time       string `json:"time"`       //时间戳的字段名
	Level      string `json:"level"`      //输出日志级别的key
	Caller     string `json:"caller"`     //调用信息key
	Message    string `json:"message"`    //信息字段的key
	Stacktrace string `json:"stacktrace"` //堆栈key
	Name       string `json:"name"`       // name key
}

KeyInfo 定义相关的 key 信息

Author : go_developer@163.com<张德满>

type LogConfig

type LogConfig struct {
	AppName        string                  `json:"app_name"`        //应用名称
	Develop        bool                    `json:"develop"`         //是否开发模式
	LogLevel       zapcore.Level           `json:"log_level"`       //日志级别
	Encoding       string                  `json:"encoding"`        //编码
	LogFile        string                  `json:"log_file"`        //日志文件
	LogKeyInfo     *KeyInfo                `json:"log_key_info"`    //日志key相关信息
	EncodeTime     zapcore.TimeEncoder     `json:"encode_time"`     //时间戳的各式还函数
	LineEnding     string                  `json:"line_ending"`     //换行符
	EncodeLevel    zapcore.LevelEncoder    `json:"encode_level"`    //level 编码器
	EncodeDuration zapcore.DurationEncoder `json:"encode_duration"` //duration 编码
	EncodeCaller   zapcore.CallerEncoder   `json:"caller_encoder"`  //调用的编码
}

LogConfig 日志的配置

Author : go_developer@163.com<张德满>

func BuildLogConfig

func BuildLogConfig(appName string, develop bool, logLevel zapcore.Level, encoding string, logFile string, keyInfo *KeyInfo) *LogConfig

BuildLogConfig 构建日志配置

Author : go_developer@163.com<张德满>

Date : 2020/07/19 01:52:36

type WrapperLogger

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

WrapperLogger 包装 zap logger 和 gin 框架绑定

Author : go_developer@163.com<张德满>

func NewWrapperLogger

func NewWrapperLogger(cfg *LogConfig) *WrapperLogger

NewWrapperLogger 获取日志实例

Author : go_developer@163.com<张德满>

Date : 2020/07/19 01:10:49

func (*WrapperLogger) Debug

func (wl *WrapperLogger) Debug(ctx *gin.Context, msg string, fieldList ...zap.Field)

Debug 记录debug级别日志

Author : go_developer@163.com<张德满>

Date : 2020/07/19 00:39:02

func (*WrapperLogger) Error

func (wl *WrapperLogger) Error(ctx *gin.Context, msg string, fieldList ...zap.Field)

Error 记录 Error 级别日志

Author : go_developer@163.com<张德满>

Date : 2020/07/19 01:07:41

func (*WrapperLogger) Info

func (wl *WrapperLogger) Info(ctx *gin.Context, msg string, fieldList ...zap.Field)

Info 记录 info 级别日志

Author : go_developer@163.com<张德满>

Date : 2020/07/19 01:07:41

func (*WrapperLogger) Panic

func (wl *WrapperLogger) Panic(ctx *gin.Context, msg string, fieldList ...zap.Field)

Panic 记录 Panic 级别日志

Author : go_developer@163.com<张德满>

Date : 2020/07/19 01:07:41

func (*WrapperLogger) Sync

func (wl *WrapperLogger) Sync()

Sync 刷入日志

Author : go_developer@163.com<张德满>

Date : 2020/07/19 02:40:37

func (*WrapperLogger) Warn

func (wl *WrapperLogger) Warn(ctx *gin.Context, msg string, fieldList ...zap.Field)

Warn 记录 Warn 级别日志

Author : go_developer@163.com<张德满>

Date : 2020/07/19 01:07:41

Jump to

Keyboard shortcuts

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