README
¶
log
一个简单快速的日志库
使用方式
go get -u github.com/marcosxzhang/log
依赖
只依赖一个外部的快速json库: github.com/json-iterator/go
例子
设置参数
log.SetOptions(
log.WithLevel(TraceLevel), // 设置日志级别
log.WithStdLevel(TraceLevel), // 如果接管其他库log,设置输出级别
log.WithOutput(file), // 输出目标
log.WithFileLine(true), // 是否启用行列信息
log.WithErrorHandler(nil), // 定义一个错误处理器
log.WithNoLock(true), // 设置无锁模式,追加写模式下可以设置无锁
log.WithFormatter(&TextFormatter{IgnoreBasicFields: false}), // 设置日志输出的格式，默认提供了text和json两种,可以自己实现Formatter接口来自定义格式,IgnoreBasicFields字段可以忽略输出基础字段
)
基本使用
log.Info(args ...)
支持自定义键值对
log.InfoKvln("key1,key2,key3", value1, value2, value3)
输出(text format)：
... key1=value1 key2=value2 key3=value3 ...
输出(json format)：
{..., "key1":value1, "key2":value2, "key3":value3, ...}
接管标准库或者其他日志库(以标准库为例)
log：代表标准库
mylog：代表我们的库
log.SetOutput(mylog.Writer())
一些简单的测试(在Windows下进行的,需要验证的话可以自己测试一下)
如果有一些没有注意到的问题，欢迎指正
Documentation
¶
Index ¶
- Constants
- Variables
- func Debug(args ...interface{})
- func DebugKv(format string, args ...interface{})
- func DebugKvln(format string, args ...interface{})
- func Debugf(format string, args ...interface{})
- func Debugln(args ...interface{})
- func Error(args ...interface{})
- func ErrorKv(format string, args ...interface{})
- func ErrorKvln(format string, args ...interface{})
- func Errorf(format string, args ...interface{})
- func Errorln(args ...interface{})
- func Fatal(args ...interface{})
- func FatalKv(format string, args ...interface{})
- func FatalKvln(format string, args ...interface{})
- func Fatalf(format string, args ...interface{})
- func Fatalln(args ...interface{})
- func Info(args ...interface{})
- func InfoKv(format string, args ...interface{})
- func InfoKvln(format string, args ...interface{})
- func Infof(format string, args ...interface{})
- func Infoln(args ...interface{})
- func Panic(args ...interface{})
- func PanicKv(format string, args ...interface{})
- func PanicKvln(format string, args ...interface{})
- func Panicf(format string, args ...interface{})
- func Panicln(args ...interface{})
- func SetOptions(opts ...Option)
- func Trace(args ...interface{})
- func TraceKv(format string, args ...interface{})
- func TraceKvln(format string, args ...interface{})
- func Tracef(format string, args ...interface{})
- func Traceln(args ...interface{})
- func Warn(args ...interface{})
- func WarnKv(format string, args ...interface{})
- func WarnKvln(format string, args ...interface{})
- func Warnf(format string, args ...interface{})
- func Warnln(args ...interface{})
- func Writer() io.Writer
- type Entry
- type ErrorHandler
- type Formatter
- type JsonFormatter
- type KvMap
- type Level
- type Logger
- func (l *Logger) Debug(args ...interface{})
- func (l *Logger) DebugKv(format string, args ...interface{})
- func (l *Logger) DebugKvln(format string, args ...interface{})
- func (l *Logger) Debugf(format string, args ...interface{})
- func (l *Logger) Debugln(args ...interface{})
- func (l *Logger) Error(args ...interface{})
- func (l *Logger) ErrorKv(format string, args ...interface{})
- func (l *Logger) ErrorKvln(format string, args ...interface{})
- func (l *Logger) Errorf(format string, args ...interface{})
- func (l *Logger) Errorln(args ...interface{})
- func (l *Logger) Fatal(args ...interface{})
- func (l *Logger) FatalKv(format string, args ...interface{})
- func (l *Logger) FatalKvln(format string, args ...interface{})
- func (l *Logger) Fatalf(format string, args ...interface{})
- func (l *Logger) Fatalln(args ...interface{})
- func (l *Logger) Info(args ...interface{})
- func (l *Logger) InfoKv(format string, args ...interface{})
- func (l *Logger) InfoKvln(format string, args ...interface{})
- func (l *Logger) Infof(format string, args ...interface{})
- func (l *Logger) Infoln(args ...interface{})
- func (l *Logger) Panic(args ...interface{})
- func (l *Logger) PanicKv(format string, args ...interface{})
- func (l *Logger) PanicKvln(format string, args ...interface{})
- func (l *Logger) Panicf(format string, args ...interface{})
- func (l *Logger) Panicln(args ...interface{})
- func (l *Logger) SetOptions(opts ...Option)
- func (l *Logger) Trace(args ...interface{})
- func (l *Logger) TraceKv(format string, args ...interface{})
- func (l *Logger) TraceKvln(format string, args ...interface{})
- func (l *Logger) Tracef(format string, args ...interface{})
- func (l *Logger) Traceln(args ...interface{})
- func (l *Logger) Warn(args ...interface{})
- func (l *Logger) WarnKv(format string, args ...interface{})
- func (l *Logger) WarnKvln(format string, args ...interface{})
- func (l *Logger) Warnf(format string, args ...interface{})
- func (l *Logger) Warnln(args ...interface{})
- func (l *Logger) Write(data []byte) (int, error)
- func (l *Logger) Writer() io.Writer
- type MutexWrap
- type Option
- type TextFormatter
Constants ¶
View Source
const ( FmtEmptySeparate = "" FmtLineSeparate = "\n" )
Variables ¶
View Source
var LevelNameMapping = map[Level]string{ PanicLevel: "PANIC", FatalLevel: "FATAL", ErrorLevel: "ERROR", WarnLevel: "WARN", InfoLevel: "INFO", DebugLevel: "DEBUG", TraceLevel: "TRACE", }
log level string name mapping
Functions ¶
func SetOptions ¶
func SetOptions(opts ...Option)
Types ¶
type JsonFormatter ¶
type JsonFormatter struct {
// 忽略基础字段
IgnoreBasicFields bool
}
func (*JsonFormatter) Format ¶
func (f *JsonFormatter) Format(e *Entry) error
type KvMap ¶
type KvMap struct {
// contains filtered or unexported fields
}
A Warp Sort Map For Text Logger 这个map存在于每一个entry中，因此不存在并发问题 不要在Formatter接口中使用异步读写,否则会导致竞争问题
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
func (*Logger) SetOptions ¶
type Option ¶
type Option func(*option)
func WithErrorHandler ¶
func WithErrorHandler(handler ErrorHandler) Option
func WithFileLine ¶
func WithFormatter ¶
func WithNoLock ¶
func WithStdLevel ¶
type TextFormatter ¶
type TextFormatter struct {
IgnoreBasicFields bool
}
func (*TextFormatter) Format ¶
func (f *TextFormatter) Format(e *Entry) error
Source Files
Click to show internal directories.
Click to hide internal directories.