xlog

README

GoKit - xlog

Log kits for Golang development.

Installation

go get -u github.com/likexian/gokit

Importing

import (
    "github.com/likexian/gokit/xlog"
)

Documentation

Visit the docs on GoDoc

Example

Do logging to stderr

log := xlog.New(os.Stderr, xlog.INFO)
log.Info("This is Info")
log.SetLevel(xlog.DEBUG)
log.Debug("This is Debug")
log.Close()

Do logging to a file

log, err := xlog.File("test.log", xlog.DEBUG)
if err != nil {
    panic(err)
}
log.SetFlag(xlog.LstdFlags|xlog.Llongfile)
log.Debug("This is Debug")
log.Info("This is Info")
log.Close()

License

Copyright 2012-2024 Li Kexian

Licensed under the Apache License 2.0

Donation

If this project is helpful, please share it with friends.

If you want to thank me, you can give me a cup of coffee.

Documentation

Index

• Constants
• func Author() string
• func License() string
• func Version() string
• type LogFlag
• type LogLevel
• type Logger
  • func File(fname string, level LogLevel) (*Logger, error)
  • func New(w io.Writer, level LogLevel) *Logger
  • func (l *Logger) Close()
  • func (l *Logger) Debug(msg string, args ...interface{})
  • func (l *Logger) DebugOnce(msg string, args ...interface{})
  • func (l *Logger) Error(msg string, args ...interface{})
  • func (l *Logger) ErrorOnce(msg string, args ...interface{})
  • func (l *Logger) Fatal(msg string, args ...interface{})
  • func (l *Logger) Info(msg string, args ...interface{})
  • func (l *Logger) InfoOnce(msg string, args ...interface{})
  • func (l *Logger) Log(level LogLevel, msg string, args ...interface{})
  • func (l *Logger) LogOnce(level LogLevel, msg string, args ...interface{})
  • func (l *Logger) SetDailyRotate(rotateNum int64) error
  • func (l *Logger) SetFlag(flag LogFlag)
  • func (l *Logger) SetLevel(level LogLevel)
  • func (l *Logger) SetRotate(rotateType string, rotateNum int64, rotateSize int64) error
  • func (l *Logger) SetSizeRotate(rotateNum int64, rotateSize int64) error
  • func (l *Logger) Warn(msg string, args ...interface{})
  • func (l *Logger) WarnOnce(msg string, args ...interface{})

Constants

const (
	Ldate = 1 << iota
	Ltime
	Lmicroseconds
	Llongfile
	Lshortfile
	LUTC
	LstdFlags = Ldate | Ltime
)

Log prefix flag, similar to golang log package

Functions

func Author

func Author() string

Author returns package author

func License

func License() string

License returns package license

func Version

func Version() string

Version returns package version

Types

type LogFlag

type LogFlag int

LogFlag storing log flag

type LogLevel

type LogLevel int

LogLevel storing log level

const (
	DEBUG LogLevel = iota
	INFO
	WARN
	ERROR
	FATAL
)

Log level const

type Logger

type Logger struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Logger storing logger

func File

func File(fname string, level LogLevel) (*Logger, error)

File returns a new file logger

func New

func New(w io.Writer, level LogLevel) *Logger

New returns a new logger

func (*Logger) Close

func (l *Logger) Close()

Close close the logger

func (*Logger) Debug

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

Debug level msg logging

func (*Logger) DebugOnce

func (l *Logger) DebugOnce(msg string, args ...interface{})

DebugOnce level msg logging

func (*Logger) Error

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

Error level msg logging

func (*Logger) ErrorOnce

func (l *Logger) ErrorOnce(msg string, args ...interface{})

ErrorOnce level msg logging

func (*Logger) Fatal

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

Fatal level msg logging, followed by a call to os.Exit(1)

func (*Logger) Info

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

Info level msg logging

func (*Logger) InfoOnce

func (l *Logger) InfoOnce(msg string, args ...interface{})

InfoOnce level msg logging

func (*Logger) Log

func (l *Logger) Log(level LogLevel, msg string, args ...interface{})

Log do log a msg

func (*Logger) LogOnce

func (l *Logger) LogOnce(level LogLevel, msg string, args ...interface{})

LogOnce do log a msg only one times within one hour

func (*Logger) SetDailyRotate

func (l *Logger) SetDailyRotate(rotateNum int64) error

SetDailyRotate set daily log rotate

func (*Logger) SetFlag

func (l *Logger) SetFlag(flag LogFlag)

SetFlag set the log flag

func (*Logger) SetLevel

func (l *Logger) SetLevel(level LogLevel)

SetLevel set the log level by int level

func (*Logger) SetRotate

func (l *Logger) SetRotate(rotateType string, rotateNum int64, rotateSize int64) error

SetRotate set log rotate rotateType: date: daily rotate, size: filesize rotate

func (*Logger) SetSizeRotate

func (l *Logger) SetSizeRotate(rotateNum int64, rotateSize int64) error

SetSizeRotate set filesize log rotate

func (*Logger) Warn

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

Warn level msg logging

func (*Logger) WarnOnce

func (l *Logger) WarnOnce(msg string, args ...interface{})

WarnOnce level msg logging