log

package module

v0.4.1 Latest Latest Go to latest Published: Apr 13, 2021 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kuoruan/go-log

Links

Open Source Insights

README ¶

Uber Zap logger wrapper with log rotation

Installation

go get -u go.kuoruan.net/log

Quick Start

Use the global logger.

package main

import "go.kuoruan.net/log"

func main() {
    log.SetOptions(log.Development())

    log.Debug("this is debug log")
}

Or create new:

package main

import "go.kuoruan.net/log"

func main() {
    logger := log.New(
        log.RotationConfig{
            MaxSize: 500, // MB
            MaxAge: 3, // days
            MaxBackups: 7,
            LocalTime: true,
            Compress: true,
        },
        log.AddCaller(), 
        log.WithLogDirs("log"), 
        log.LogToStdout(),
    )
    
    logger.Info("This is info log")
}

Documentation ¶

Index ¶

func DPanic(args ...interface{})
func DPanicf(template string, args ...interface{})
func DPanicln(args ...interface{})
func DPanicw(msg string, keysAndValues ...interface{})
func Debug(args ...interface{})
func Debugf(format string, args ...interface{})
func Debugln(args ...interface{})
func Debugw(msg string, keysAndValues ...interface{})
func Error(args ...interface{})
func Errorf(template string, args ...interface{})
func Errorln(args ...interface{})
func Errorw(msg string, keysAndValues ...interface{})
func Fatal(args ...interface{})
func Fatalf(template string, args ...interface{})
func Fatalln(args ...interface{})
func Fatalw(msg string, keysAndValues ...interface{})
func Info(args ...interface{})
func Infof(format string, args ...interface{})
func Infoln(args ...interface{})
func Infow(msg string, keysAndValues ...interface{})
func Panic(args ...interface{})
func Panicf(template string, args ...interface{})
func Panicln(args ...interface{})
func Panicw(msg string, keysAndValues ...interface{})
func Rotate() error
func SetOptions(opts ...Option)
func Warn(args ...interface{})
func Warnf(template string, args ...interface{})
func Warnln(args ...interface{})
func Warnw(msg string, keysAndValues ...interface{})
type Format
- func ParseFormat(format string) (Format, error)
type Level
- func ParseLevel(lvl string) (Level, error)
- func (l Level) Enabled(lvl Level) bool
type Logger
- func New(opt ...Option) *Logger
- func (l *Logger) DPanic(args ...interface{})
- func (l *Logger) DPanicf(template string, args ...interface{})
- func (l *Logger) DPanicln(args ...interface{})
- func (l *Logger) DPanicw(msg string, keysAndValues ...interface{})
- func (l *Logger) Debug(args ...interface{})
- func (l *Logger) Debugf(format string, args ...interface{})
- func (l *Logger) Debugln(args ...interface{})
- func (l *Logger) Debugw(msg string, keysAndValues ...interface{})
- func (l *Logger) Error(args ...interface{})
- func (l *Logger) Errorf(template string, args ...interface{})
- func (l *Logger) Errorln(args ...interface{})
- func (l *Logger) Errorw(msg string, keysAndValues ...interface{})
- func (l *Logger) Fatal(args ...interface{})
- func (l *Logger) Fatalf(template string, args ...interface{})
- func (l *Logger) Fatalln(args ...interface{})
- func (l *Logger) Fatalw(msg string, keysAndValues ...interface{})
- func (l *Logger) Info(args ...interface{})
- func (l *Logger) Infof(format string, args ...interface{})
- func (l *Logger) Infoln(args ...interface{})
- func (l *Logger) Infow(msg string, keysAndValues ...interface{})
- func (l *Logger) Panic(args ...interface{})
- func (l *Logger) Panicf(template string, args ...interface{})
- func (l *Logger) Panicln(args ...interface{})
- func (l *Logger) Panicw(msg string, keysAndValues ...interface{})
- func (l *Logger) Print(args ...interface{})
- func (l *Logger) Printf(format string, args ...interface{})
- func (l *Logger) Println(args ...interface{})
- func (l *Logger) Printw(msg string, keysAndValues ...interface{})
- func (l *Logger) Rotate() error
- func (l *Logger) Warn(args ...interface{})
- func (l *Logger) Warnf(template string, args ...interface{})
- func (l *Logger) Warnln(args ...interface{})
- func (l *Logger) Warnw(msg string, keysAndValues ...interface{})
- func (l *Logger) WithOptions(opt ...Option) *Logger
type Option
- func AddCaller() Option
- func AddCallerSkip(skip int) Option
- func Development() Option
- func LogToStdout() Option
- func WithCaller(caller bool) Option
- func WithDevelopment(development bool) Option
- func WithEncoder(encoder zapcore.Encoder) Option
- func WithFormat(format Format) Option
- func WithLevel(lvl Level) Option
- func WithLogDirs(dirs ...string) Option
- func WithLogFiles(files ...string) Option
- func WithLogToStdout(logToStdout bool) Option
- func WithOutput(output io.Writer) Option
type RotationConfig

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func DPanic ¶

func DPanic(args ...interface{})

func DPanicf ¶

func DPanicf(template string, args ...interface{})

func DPanicln ¶

func DPanicln(args ...interface{})

func DPanicw ¶

func DPanicw(msg string, keysAndValues ...interface{})

func Debug ¶

func Debug(args ...interface{})

func Debugf ¶

func Debugf(format string, args ...interface{})

func Debugln ¶

func Debugln(args ...interface{})

func Debugw ¶

func Debugw(msg string, keysAndValues ...interface{})

func Error ¶

func Error(args ...interface{})

func Errorf ¶

func Errorf(template string, args ...interface{})

func Errorln ¶

func Errorln(args ...interface{})

func Errorw ¶

func Errorw(msg string, keysAndValues ...interface{})

func Fatal ¶

func Fatal(args ...interface{})

func Fatalf ¶

func Fatalf(template string, args ...interface{})

func Fatalln ¶

func Fatalln(args ...interface{})

func Fatalw ¶

func Fatalw(msg string, keysAndValues ...interface{})

func Info ¶

func Info(args ...interface{})

func Infof ¶

func Infof(format string, args ...interface{})

func Infoln ¶

func Infoln(args ...interface{})

func Infow ¶

func Infow(msg string, keysAndValues ...interface{})

func Panic ¶

func Panic(args ...interface{})

func Panicf ¶

func Panicf(template string, args ...interface{})

func Panicln ¶

func Panicln(args ...interface{})

func Panicw ¶

func Panicw(msg string, keysAndValues ...interface{})

func Rotate ¶

func Rotate() error

func SetOptions ¶

func SetOptions(opts ...Option)

func Warn ¶

func Warn(args ...interface{})

func Warnf ¶

func Warnf(template string, args ...interface{})

func Warnln ¶

func Warnln(args ...interface{})

func Warnw ¶

func Warnw(msg string, keysAndValues ...interface{})

Types ¶

type Format ¶

type Format int

const (
	FormatConsole Format = iota
	FormatJSON
)

func ParseFormat ¶

func ParseFormat(format string) (Format, error)

type Level ¶

type Level int

const (
	DebugLevel Level = iota - 1
	InfoLevel
	WarnLevel
	ErrorLevel
	DPanicLevel
	PanicLevel
	FatalLevel
)

func ParseLevel ¶

func ParseLevel(lvl string) (Level, error)

func (Level) Enabled ¶

func (l Level) Enabled(lvl Level) bool

type Logger ¶

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

func New ¶

func New(opt ...Option) *Logger

func (*Logger) DPanic ¶

func (l *Logger) DPanic(args ...interface{})

func (*Logger) DPanicf ¶

func (l *Logger) DPanicf(template string, args ...interface{})

func (*Logger) DPanicln ¶

func (l *Logger) DPanicln(args ...interface{})

func (*Logger) DPanicw ¶

func (l *Logger) DPanicw(msg string, keysAndValues ...interface{})

func (*Logger) Debug ¶

func (l *Logger) Debug(args ...interface{})

func (*Logger) Debugf ¶

func (l *Logger) Debugf(format string, args ...interface{})

func (*Logger) Debugln ¶

func (l *Logger) Debugln(args ...interface{})

func (*Logger) Debugw ¶

func (l *Logger) Debugw(msg string, keysAndValues ...interface{})

func (*Logger) Error ¶

func (l *Logger) Error(args ...interface{})

func (*Logger) Errorf ¶

func (l *Logger) Errorf(template string, args ...interface{})

func (*Logger) Errorln ¶

func (l *Logger) Errorln(args ...interface{})

func (*Logger) Errorw ¶

func (l *Logger) Errorw(msg string, keysAndValues ...interface{})

func (*Logger) Fatal ¶

func (l *Logger) Fatal(args ...interface{})

func (*Logger) Fatalf ¶

func (l *Logger) Fatalf(template string, args ...interface{})

func (*Logger) Fatalln ¶

func (l *Logger) Fatalln(args ...interface{})

func (*Logger) Fatalw ¶

func (l *Logger) Fatalw(msg string, keysAndValues ...interface{})

func (*Logger) Info ¶

func (l *Logger) Info(args ...interface{})

func (*Logger) Infof ¶

func (l *Logger) Infof(format string, args ...interface{})

func (*Logger) Infoln ¶

func (l *Logger) Infoln(args ...interface{})

func (*Logger) Infow ¶

func (l *Logger) Infow(msg string, keysAndValues ...interface{})

func (*Logger) Panic ¶

func (l *Logger) Panic(args ...interface{})

func (*Logger) Panicf ¶

func (l *Logger) Panicf(template string, args ...interface{})

func (*Logger) Panicln ¶

func (l *Logger) Panicln(args ...interface{})

func (*Logger) Panicw ¶

func (l *Logger) Panicw(msg string, keysAndValues ...interface{})

func (*Logger) Print ¶

func (l *Logger) Print(args ...interface{})

func (*Logger) Printf ¶

func (l *Logger) Printf(format string, args ...interface{})

func (*Logger) Println ¶

func (l *Logger) Println(args ...interface{})

func (*Logger) Printw ¶

func (l *Logger) Printw(msg string, keysAndValues ...interface{})

func (*Logger) Rotate ¶

func (l *Logger) Rotate() error

func (*Logger) Warn ¶

func (l *Logger) Warn(args ...interface{})

func (*Logger) Warnf ¶

func (l *Logger) Warnf(template string, args ...interface{})

func (*Logger) Warnln ¶

func (l *Logger) Warnln(args ...interface{})

func (*Logger) Warnw ¶

func (l *Logger) Warnw(msg string, keysAndValues ...interface{})

func (*Logger) WithOptions ¶

func (l *Logger) WithOptions(opt ...Option) *Logger

type Option ¶

type Option interface {
	// contains filtered or unexported methods
}

func AddCaller ¶

func AddCaller() Option

func AddCallerSkip ¶

func AddCallerSkip(skip int) Option

func Development ¶

func Development() Option

func LogToStdout ¶ added in v0.4.1

func LogToStdout() Option

func WithCaller ¶

func WithCaller(caller bool) Option

func WithDevelopment ¶

func WithDevelopment(development bool) Option

func WithEncoder ¶

func WithEncoder(encoder zapcore.Encoder) Option

func WithFormat ¶

func WithFormat(format Format) Option

func WithLevel ¶

func WithLevel(lvl Level) Option

func WithLogDirs ¶

func WithLogDirs(dirs ...string) Option

func WithLogFiles ¶

func WithLogFiles(files ...string) Option

func WithLogToStdout ¶

func WithLogToStdout(logToStdout bool) Option

func WithOutput ¶

func WithOutput(output io.Writer) Option

type RotationConfig ¶

type RotationConfig struct {
	MaxSize    int  `json:"maxSize"`    // megabytes
	MaxAge     int  `json:"maxAge"`     // days
	MaxBackups int  `json:"maxBackups"` // count
	LocalTime  bool `json:"localTime"`
	Compress   bool `json:"compress"`
}

Source Files ¶

View all Source files

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