logger

Documentation

Index

• Variables
• func IsAppError(err error) bool
• type AppError
  • func (r AppError) Code() int
  • func (r AppError) Error() string
• type AppLogger
  • func (applg *AppLogger) Debug(msg string, fields ...Field)
  • func (applg *AppLogger) Debugf(temp string, args ...interface{})
  • func (applg *AppLogger) Error(err AppError, msg string, fields ...Field)
  • func (applg *AppLogger) Errorf(err AppError, temp string, args ...interface{})
  • func (applg *AppLogger) Fatal(err AppError, msg string, fields ...Field)
  • func (applg *AppLogger) Fatalf(err AppError, temp string, args ...interface{})
  • func (applg *AppLogger) GetLevel() string
  • func (applg *AppLogger) Info(msg string, fields ...Field)
  • func (applg *AppLogger) Infof(temp string, args ...interface{})
  • func (applg *AppLogger) IsDebugLevel() bool
  • func (applg *AppLogger) Log() *zap.Logger
  • func (applg *AppLogger) Println(args ...interface{})
  • func (applg *AppLogger) SetLevel(l Level)
  • func (applg *AppLogger) Warn(err AppError, msg string, fields ...Field)
  • func (applg *AppLogger) Warnf(err AppError, temp string, args ...interface{})
• type Field
  • func ErrorField(err error) (f Field)
  • func MakeField(k string, v interface{}) Field
• type Level
• type Logger
  • func DefaultLogger() Logger
  • func NewLogger(opts ...Option) (Logger, error)
  • func NopLogger() Logger
• type Option
  • func SetDebug(debug bool) Option
  • func SetLevel(lv Level) Option

Variables

var (
	ErrorParam            = AppError{/* contains filtered or unexported fields */}
	ErrorNonExistsFolder  = AppError{/* contains filtered or unexported fields */}
	ErrorNonExistsFile    = AppError{/* contains filtered or unexported fields */}
	ErrorEmptyData        = AppError{/* contains filtered or unexported fields */}
	ErrorMethodNotSupport = AppError{/* contains filtered or unexported fields */}
	ErrorMethod           = AppError{/* contains filtered or unexported fields */}
	ErrorInstantiation    = AppError{/* contains filtered or unexported fields */}
	ErrorWriteFile        = AppError{/* contains filtered or unexported fields */}
	ErrorReadFile         = AppError{/* contains filtered or unexported fields */}

	ErrorConcurrency = AppError{/* contains filtered or unexported fields */} // 并发

	ErrorRouter          = AppError{/* contains filtered or unexported fields */} // API Router
	ErrorRouterRegister  = AppError{/* contains filtered or unexported fields */}
	ErrorAgentStart      = AppError{/* contains filtered or unexported fields */}
	ErrorMakeMiddleware  = AppError{/* contains filtered or unexported fields */}
	ErrorHandleError     = AppError{/* contains filtered or unexported fields */}
	ErrorRequestExecutor = AppError{/* contains filtered or unexported fields */}
	ErrorServerPlugin    = AppError{/* contains filtered or unexported fields */}

	ErrorParamsIncomplete     = AppError{/* contains filtered or unexported fields */} // 参数
	ErrorAuthParamsIncomplete = AppError{/* contains filtered or unexported fields */}

	ErrorHost          = AppError{/* contains filtered or unexported fields */} // 网络请求错误
	ErrorHTTPHandle    = AppError{/* contains filtered or unexported fields */}
	ErrorNetForwarding = AppError{/* contains filtered or unexported fields */}
	ErrorMiddleware    = AppError{/* contains filtered or unexported fields */}

	ErrorKafka             = AppError{/* contains filtered or unexported fields */} // kafka
	ErrorKafkaConsumer     = AppError{/* contains filtered or unexported fields */}
	ErrorKafkaProducer     = AppError{/* contains filtered or unexported fields */}
	ErrorKafkaProducerSend = AppError{/* contains filtered or unexported fields */}

	ErrorES = AppError{/* contains filtered or unexported fields */} // ES

	ErrorMysql = AppError{/* contains filtered or unexported fields */} // mysql
	ErrorRedis = AppError{/* contains filtered or unexported fields */} // redis
	ErrorCache = AppError{/* contains filtered or unexported fields */} // cache

	ErrETCDException = AppError{/* contains filtered or unexported fields */} // etcd操作

)

Functions

func IsAppError

func IsAppError(err error) bool

IsAppError 比较

Types

type AppError

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

AppError 业务逻辑错误对象

func (AppError) Code

func (r AppError) Code() int

Code 返回错误代码

func (AppError) Error

func (r AppError) Error() string

Error 返回错误信息

type AppLogger

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

AppLogger 实现一个logger

func (*AppLogger) Debug

func (applg *AppLogger) Debug(msg string, fields ...Field)

Debug logs a message at DebugLevel with SugaredLogger

func (*AppLogger) Debugf

func (applg *AppLogger) Debugf(temp string, args ...interface{})

Debug logs a message at DebugLevel with SugaredLogger

func (*AppLogger) Error

func (applg *AppLogger) Error(err AppError, msg string, fields ...Field)

Error logs a message at ErrorLevel with Logger

func (*AppLogger) Errorf

func (applg *AppLogger) Errorf(err AppError, temp string, args ...interface{})

Errorf logs a message at ErrorLevel with SugaredLogger

func (*AppLogger) Fatal

func (applg *AppLogger) Fatal(err AppError, msg string, fields ...Field)

Fatal logs a message and exit at FatalLevel with Logger The logger then calls os.Exit(1), even if logging at FatalLevel is disabled

func (*AppLogger) Fatalf

func (applg *AppLogger) Fatalf(err AppError, temp string, args ...interface{})

Fatalf logs a message at FatalLevel with SugaredLogger The logger then calls os.Exit(1), even if logging at FatalLevel is disabled

func (*AppLogger) GetLevel

func (applg *AppLogger) GetLevel() string

GetLevel 获取logger的等级

func (*AppLogger) Info

func (applg *AppLogger) Info(msg string, fields ...Field)

Info logs a message at InfoLevel with Logger

func (*AppLogger) Infof

func (applg *AppLogger) Infof(temp string, args ...interface{})

Infof logs a message at InfoLevel with SugaredLogger

func (*AppLogger) IsDebugLevel

func (applg *AppLogger) IsDebugLevel() bool

func (*AppLogger) Log

func (applg *AppLogger) Log() *zap.Logger

func (*AppLogger) Println

func (applg *AppLogger) Println(args ...interface{})

Infof logs a message at InfoLevel with SugaredLogger

func (*AppLogger) SetLevel

func (applg *AppLogger) SetLevel(l Level)

SetLevel: 维护日志级别的方法 使用一个配置接口维护这个方法

func (*AppLogger) Warn

func (applg *AppLogger) Warn(err AppError, msg string, fields ...Field)

Warn logs a message at WarnLevel as AppError with Logger

func (*AppLogger) Warnf

func (applg *AppLogger) Warnf(err AppError, temp string, args ...interface{})

Warnf logs a message at WarnLevel with SugaredLogger

type Field

type Field struct {
	Value interface{}
	Key   string
}

Field 可以指定关键信息

func ErrorField

func ErrorField(err error) (f Field)

func MakeField

func MakeField(k string, v interface{}) Field

type Level

type Level zapcore.Level

Level 声明日志级别

const (
	DebugLevel Level = iota - 1
	InfoLevel
	WarnLevel
	ErrorLevel

	FatalLevel
)

type Logger

type Logger interface {
	// SetLevel(Level)
	// GetLevel() string
	Log() *zap.Logger
	Debug(msg string, fields ...Field)
	Debugf(string, ...interface{})
	Info(string, ...Field)
	Infof(string, ...interface{})
	Warn(AppError, string, ...Field)
	Warnf(AppError, string, ...interface{})
	Error(AppError, string, ...Field)
	Errorf(AppError, string, ...interface{})
	Fatal(AppError, string, ...Field)
	Fatalf(AppError, string, ...interface{})
	Println(...interface{})
}

Logger 定义logger接口

func DefaultLogger

func DefaultLogger() Logger

DefaultLogger 返回一个基础的默认logger实例

func NewLogger

func NewLogger(opts ...Option) (Logger, error)

NewLogger 创建logger实例对象: opts: logger包提供的对logger配置参数的配置方法

func NopLogger

func NopLogger() Logger

NopLogger 一个空的log实例

type Option

type Option func(conf *zap.Config)

func SetDebug

func SetDebug(debug bool) Option

SetDebug 用于创建logger时,设置是否处于开发环境 ps: 会将Level设置成debug

func SetLevel

func SetLevel(lv Level) Option

SetLevel 创建Logger实例时, 设置日志等级