logx

Documentation

Index

• Constants
• Variables
• func Alert(v string)
• func Close() error
• func CollectSysLog()
• func Disable()
• func DisableStat()
• func Error(v ...interface{})
• func ErrorCaller(callDepth int, v ...interface{})
• func ErrorCallerf(callDepth int, format string, v ...interface{})
• func ErrorStack(v ...interface{})
• func ErrorStackf(format string, v ...interface{})
• func Errorf(format string, v ...interface{})
• func Errorv(v interface{})
• func Info(v ...interface{})
• func Infof(format string, v ...interface{})
• func Infov(v interface{})
• func Must(err error)
• func MustSetup(c LogConf)
• func SetLevel(level uint32)
• func SetUp(c LogConf) error
• func Severe(v ...interface{})
• func Severef(format string, v ...interface{})
• func Slow(v ...interface{})
• func Slowf(format string, v ...interface{})
• func Slowv(v interface{})
• func Stat(v ...interface{})
• func Statf(format string, v ...interface{})
• type DailyRotateRule
  • func (r *DailyRotateRule) BackupFileName() string
  • func (r *DailyRotateRule) MarkRotated()
  • func (r *DailyRotateRule) OutdatedFiles() []string
  • func (r *DailyRotateRule) ShallRotate() bool
• type LessLogger
  • func NewLessLogger(milliseconds int) *LessLogger
  • func (logger *LessLogger) Error(v ...interface{})
  • func (logger *LessLogger) Errorf(format string, v ...interface{})
• type LogConf
• type LogOption
  • func WithCooldownMillis(millis int) LogOption
  • func WithGzip() LogOption
  • func WithKeepDays(days int) LogOption
• type Logger
  • func WithContext(ctx context.Context) Logger
  • func WithDuration(d time.Duration) Logger
• type RotateLogger
  • func NewLogger(filename string, rule RotateRule, compress bool) (*RotateLogger, error)
  • func (l *RotateLogger) Close() error
  • func (l *RotateLogger) Write(data []byte) (int, error)
• type RotateRule
  • func DefaultRotateRule(filename, delimiter string, days int, gzip bool) RotateRule

Constants

const (
	// InfoLevel logs everything
	InfoLevel = iota
	// ErrorLevel includes errors, slows, stacks
	ErrorLevel
	// SevereLevel only log severe messages
	SevereLevel
)

Variables

var (
	// ErrLogPathNotSet is an error that indicates the log path is not set.
	ErrLogPathNotSet = errors.New("log path must be set")
	// ErrLogNotInitialized is an error that log is not initialized.
	ErrLogNotInitialized = errors.New("log not initialized")
	// ErrLogServiceNameNotSet is an error that indicates that the service name is not set.
	ErrLogServiceNameNotSet = errors.New("log service name must be set")
)

var ErrLogFileClosed = errors.New("error: log file closed")

ErrLogFileClosed is an error that indicates the log file is already closed.

Functions

func Alert

func Alert(v string)

Alert alerts v in alert level, and the message is written to error log.

func Close

func Close() error

Close closes the logging.

func CollectSysLog

func CollectSysLog()

CollectSysLog redirects system log into logx info

func Disable

func Disable()

Disable disables the logging.

func DisableStat

func DisableStat()

DisableStat disables the stat logs.

func Error

func Error(v ...interface{})

Error writes v into error log.

func ErrorCaller

func ErrorCaller(callDepth int, v ...interface{})

ErrorCaller writes v with context into error log.

func ErrorCallerf

func ErrorCallerf(callDepth int, format string, v ...interface{})

ErrorCallerf writes v with context in format into error log.

func ErrorStack

func ErrorStack(v ...interface{})

ErrorStack writes v along with call stack into error log.

func ErrorStackf

func ErrorStackf(format string, v ...interface{})

ErrorStackf writes v along with call stack in format into error log.

func Errorf

func Errorf(format string, v ...interface{})

Errorf writes v with format into error log.

func Errorv

func Errorv(v interface{})

Errorv writes v into error log with json content. No call stack attached, because not elegant to pack the messages.

func Info

func Info(v ...interface{})

Info writes v into access log.

func Infof

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

Infof writes v with format into access log.

func Infov

func Infov(v interface{})

Infov writes v into access log with json content.

func Must

func Must(err error)

Must checks if err is nil, otherwise logs the err and exits.

func MustSetup

func MustSetup(c LogConf)

MustSetup sets up logging with given config c. It exits on error.

func SetLevel

func SetLevel(level uint32)

SetLevel sets the logging level. It can be used to suppress some logs.

func SetUp

func SetUp(c LogConf) error

SetUp sets up the logx. If already set up, just return nil. we allow SetUp to be called multiple times, because for example we need to allow different service frameworks to initialize logx respectively. the same logic for SetUp

func Severe

func Severe(v ...interface{})

Severe writes v into severe log.

func Severef

func Severef(format string, v ...interface{})

Severef writes v with format into severe log.

func Slow

func Slow(v ...interface{})

Slow writes v into slow log.

func Slowf

func Slowf(format string, v ...interface{})

Slowf writes v with format into slow log.

func Slowv

func Slowv(v interface{})

Slowv writes v into slow log with json content.

func Stat

func Stat(v ...interface{})

Stat writes v into stat log.

func Statf

func Statf(format string, v ...interface{})

Statf writes v with format into stat log.

Types

type DailyRotateRule

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

A DailyRotateRule is a rule to daily rotate the log files.

func (*DailyRotateRule) BackupFileName

func (r *DailyRotateRule) BackupFileName() string

BackupFileName returns the backup filename on rotating.

func (*DailyRotateRule) MarkRotated

func (r *DailyRotateRule) MarkRotated()

MarkRotated marks the rotated time of r to be the current time.

func (*DailyRotateRule) OutdatedFiles

func (r *DailyRotateRule) OutdatedFiles() []string

OutdatedFiles returns the files that exceeded the keeping days.

func (*DailyRotateRule) ShallRotate

func (r *DailyRotateRule) ShallRotate() bool

ShallRotate checks if the file should be rotated.

type LessLogger

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

A LessLogger is a logger that control to log once during the given duration.

func NewLessLogger

func NewLessLogger(milliseconds int) *LessLogger

NewLessLogger returns a LessLogger.

func (*LessLogger) Error

func (logger *LessLogger) Error(v ...interface{})

Error logs v into error log or discard it if more than once in the given duration.

func (*LessLogger) Errorf

func (logger *LessLogger) Errorf(format string, v ...interface{})

Errorf logs v with format into error log or discard it if more than once in the given duration.

type LogConf

type LogConf struct {
	ServiceName         string `json:",optional"`
	Mode                string `json:",default=console,options=console|file|volume"`
	TimeFormat          string `json:",optional"`
	Path                string `json:",default=logs"`
	Level               string `json:",default=info,options=info|error|severe"`
	Compress            bool   `json:",optional"`
	KeepDays            int    `json:",optional"`
	StackCooldownMillis int    `json:",default=100"`
}

A LogConf is a logging config.

type LogOption

type LogOption func(options *logOptions)

LogOption defines the method to customize the logging.

func WithCooldownMillis

func WithCooldownMillis(millis int) LogOption

WithCooldownMillis customizes logging on writing call stack interval.

func WithGzip

func WithGzip() LogOption

WithGzip customizes logging to automatically gzip the log files.

func WithKeepDays

func WithKeepDays(days int) LogOption

WithKeepDays customizes logging to keep logs with days.

type Logger

type Logger interface {
	Error(...interface{})
	Errorf(string, ...interface{})
	Errorv(interface{})
	Info(...interface{})
	Infof(string, ...interface{})
	Infov(interface{})
	Slow(...interface{})
	Slowf(string, ...interface{})
	Slowv(interface{})
	WithDuration(time.Duration) Logger
}

A Logger represents a logger.

func WithContext

func WithContext(ctx context.Context) Logger

WithContext sets ctx to log, for keeping tracing information.

func WithDuration

func WithDuration(d time.Duration) Logger

WithDuration returns a Logger which logs the given duration.

type RotateLogger

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

A RotateLogger is a Logger that can rotate log files with given rules.

func NewLogger

func NewLogger(filename string, rule RotateRule, compress bool) (*RotateLogger, error)

NewLogger returns a RotateLogger with given filename and rule, etc.

func (*RotateLogger) Close

func (l *RotateLogger) Close() error

Close closes l.

func (*RotateLogger) Write

func (l *RotateLogger) Write(data []byte) (int, error)

type RotateRule

type RotateRule interface {
	BackupFileName() string
	MarkRotated()
	OutdatedFiles() []string
	ShallRotate() bool
}

A RotateRule interface is used to define the log rotating rules.

func DefaultRotateRule

func DefaultRotateRule(filename, delimiter string, days int, gzip bool) RotateRule

DefaultRotateRule is a default log rotating rule, currently DailyRotateRule.