logger

README

logger

Documentation

Index

• Constants
• func Debug(msg string, fields ...zap.Field)
• func DebugCtx(ctx context.Context, msg string, fields ...zap.Field)
• func Error(msg string, err error, fields ...zap.Field)
• func ErrorCtx(ctx context.Context, msg string, err error, fields ...zap.Field)
• func Fatal(msg string, fields ...zap.Field)
• func FatalCtx(ctx context.Context, msg string, fields ...zap.Field)
• func Info(msg string, fields ...zap.Field)
• func InfoCtx(ctx context.Context, msg string, fields ...zap.Field)
• func Init(opts ...Option) error
• func InitDevelopment() error
• func InitProduction() error
• func Sync() error
• func Trace(ctx context.Context, funcName string) func()
• func Warn(msg string, fields ...zap.Field)
• func WarnCtx(ctx context.Context, msg string, fields ...zap.Field)
• type Logger
  • func New(opts ...Option) (*Logger, error)
  • func NewDevelopment() (*Logger, error)
  • func NewProduction() (*Logger, error)
  • func With(fields ...zap.Field) *Logger
  • func WithContext(ctx context.Context) *Logger
  • func (l *Logger) Debug(msg string, fields ...zap.Field)
  • func (l *Logger) DebugCtx(ctx context.Context, msg string, fields ...zap.Field)
  • func (l *Logger) Error(msg string, err error, fields ...zap.Field)
  • func (l *Logger) ErrorCtx(ctx context.Context, msg string, err error, fields ...zap.Field)
  • func (l *Logger) Fatal(msg string, fields ...zap.Field)
  • func (l *Logger) FatalCtx(ctx context.Context, msg string, fields ...zap.Field)
  • func (l *Logger) Info(msg string, fields ...zap.Field)
  • func (l *Logger) InfoCtx(ctx context.Context, msg string, fields ...zap.Field)
  • func (l *Logger) Sync() error
  • func (l *Logger) Trace(ctx context.Context, funcName string) func()
  • func (l *Logger) Warn(msg string, fields ...zap.Field)
  • func (l *Logger) WarnCtx(ctx context.Context, msg string, fields ...zap.Field)
  • func (l *Logger) With(fields ...zap.Field) *Logger
  • func (l *Logger) WithContext(ctx context.Context) *Logger
• type Option
  • func WithEnv(env string) Option
  • func WithLevel(level zapcore.Level) Option
  • func WithLogToFile(logToFile bool) Option
  • func WithRequestKey(requestKey string) Option
  • func WithRotate(rotate bool) Option
  • func WithRotateAge(rotateAge int) Option
  • func WithRotateBackups(rotateBackups int) Option
  • func WithRotateCompress(rotateCompress bool) Option
  • func WithRotatePath(rotatePath string) Option
  • func WithRotateSize(rotateSize int) Option
  • func WithServiceName(serviceName string) Option
  • func WithUserKey(userKey string) Option
  • func WithVersionName(versionName string) Option

Constants

const (
	Development = "development"
	Production  = "production"
	RequestKey  = "request_id"
	UserKey     = "user_id"
	ServerName  = "rhino_logger"
	Version     = "v1.0.0"
)

Functions

func Debug

func Debug(msg string, fields ...zap.Field)

func DebugCtx

func DebugCtx(ctx context.Context, msg string, fields ...zap.Field)

func Error

func Error(msg string, err error, fields ...zap.Field)

func ErrorCtx

func ErrorCtx(ctx context.Context, msg string, err error, fields ...zap.Field)

func Fatal

func Fatal(msg string, fields ...zap.Field)

func FatalCtx

func FatalCtx(ctx context.Context, msg string, fields ...zap.Field)

func Info

func Info(msg string, fields ...zap.Field)

func InfoCtx

func InfoCtx(ctx context.Context, msg string, fields ...zap.Field)

func Init

func Init(opts ...Option) error

func InitDevelopment

func InitDevelopment() error

func InitProduction

func InitProduction() error

func Sync

func Sync() error

func Trace

func Trace(ctx context.Context, funcName string) func()

func Warn

func Warn(msg string, fields ...zap.Field)

func WarnCtx

func WarnCtx(ctx context.Context, msg string, fields ...zap.Field)

Types

type Logger

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

func New

func New(opts ...Option) (*Logger, error)

func NewDevelopment

func NewDevelopment() (*Logger, error)

func NewProduction

func NewProduction() (*Logger, error)

func With

func With(fields ...zap.Field) *Logger

func WithContext

func WithContext(ctx context.Context) *Logger

func (*Logger) Debug

func (l *Logger) Debug(msg string, fields ...zap.Field)

func (*Logger) DebugCtx

func (l *Logger) DebugCtx(ctx context.Context, msg string, fields ...zap.Field)

func (*Logger) Error

func (l *Logger) Error(msg string, err error, fields ...zap.Field)

func (*Logger) ErrorCtx

func (l *Logger) ErrorCtx(ctx context.Context, msg string, err error, fields ...zap.Field)

func (*Logger) Fatal

func (l *Logger) Fatal(msg string, fields ...zap.Field)

func (*Logger) FatalCtx

func (l *Logger) FatalCtx(ctx context.Context, msg string, fields ...zap.Field)

func (*Logger) Info

func (l *Logger) Info(msg string, fields ...zap.Field)

func (*Logger) InfoCtx

func (l *Logger) InfoCtx(ctx context.Context, msg string, fields ...zap.Field)

func (*Logger) Sync

func (l *Logger) Sync() error

func (*Logger) Trace

func (l *Logger) Trace(ctx context.Context, funcName string) func()

func (*Logger) Warn

func (l *Logger) Warn(msg string, fields ...zap.Field)

func (*Logger) WarnCtx

func (l *Logger) WarnCtx(ctx context.Context, msg string, fields ...zap.Field)

func (*Logger) With

func (l *Logger) With(fields ...zap.Field) *Logger

func (*Logger) WithContext

func (l *Logger) WithContext(ctx context.Context) *Logger

type Option

type Option func(*Logger)

func WithEnv

func WithEnv(env string) Option

func WithLevel

func WithLevel(level zapcore.Level) Option

func WithLogToFile

func WithLogToFile(logToFile bool) Option

func WithRequestKey

func WithRequestKey(requestKey string) Option

func WithRotate

func WithRotate(rotate bool) Option

func WithRotateAge

func WithRotateAge(rotateAge int) Option

func WithRotateBackups

func WithRotateBackups(rotateBackups int) Option

func WithRotateCompress

func WithRotateCompress(rotateCompress bool) Option

func WithRotatePath

func WithRotatePath(rotatePath string) Option

func WithRotateSize

func WithRotateSize(rotateSize int) Option

func WithServiceName

func WithServiceName(serviceName string) Option

func WithUserKey

func WithUserKey(userKey string) Option

func WithVersionName

func WithVersionName(versionName string) Option