btcd 中使用的log 模块引用自己项目仓库的btclog包。
在整个包里面，定义了需要实现的接口，以及简单的封装:
type Logger interface {
Tracef(format string, params ...interface{})
Debugf(format string, params ...interface{})
Infof(format string, params ...interface{})
Warnf(format string, params ...interface{})
Errorf(format string, params ...interface{})
Criticalf(format string, params ...interface{})
Trace(v ...interface{})
Debug(v ...interface{})
Info(v ...interface{})
Warn(v ...interface{})
Error(v ...interface{})
Critical(v ...interface{})
Level() Level
SetLevel(level Level
}
// 后端主要实现往磁盘写数据的需求
type Backend struct {
w io.Writer
mu sync.Mutex // ensures atomic writes
flag uint32
}
// 所有模块使用的log结构体，tag就是表示所谓的subsystem
// slog实现了上面定义的接口
type struct {
lvl Level // atomic
tag string // tag可以为后期分析log时使用
b *Backend
}
至于log级别的判断在含在没有实现接口里面的方法中，与相应级别比较大小，来判断是否输出该条日子，例如：
func (l *slog) Warn(args ...interface{}) {
lvl := l.Level()
if lvl <= LevelWarn {
l.b.print("WRN", l.tag, args...)
}
func (l *slog) Warnf(format string, args ...interface{}) {
lvl := l.Level()
if lvl <= LevelWarn {
l.b.printf("WRN", l.tag, format, args...)
}
}
在每个实现接口的方法中，写入操作都是通过print和printf来实现的:
func (b *Backend) print(lvl, tag string, args ...interface{}) {
t := time.Now() // get as early as possible
bytebuf := buffer()
var file string
var line int
if b.flag&(Lshortfile|Llongfile) != 0 {
file, line = callsite(b.flag)
}
formatHeader(bytebuf, t, lvl, tag, file, line)
buf := bytes.NewBuffer(*bytebuf)
fmt.Fprintln(buf, args...)
*bytebuf = buf.Bytes()
b.mu.Lock()
b.w.Write(*bytebuf)
b.mu.Unlock()
recycleBuffer(bytebuf)
}
// 格式化输出
func (b *Backend) printf(lvl, tag string, format string, args ...interface{}) {
t := time.Now() // get as early as possible
bytebuf := buffer()
var file string
var line int
if b.flag&(Lshortfile|Llongfile) != 0 {
file, line = callsite(b.flag)
}
formatHeader(bytebuf, t, lvl, tag, file, line)
buf := bytes.NewBuffer(*bytebuf)
fmt.Fprintf(buf, format, args...)
*bytebuf = append(buf.Bytes(), '\n')
b.mu.Lock()
b.w.Write(*bytebuf)
b.mu.Unlock()
recycleBuffer(bytebuf)
}
在btclog包中，有一个全局变量Disabled，并在init函数中初始化，但是这个log实例并不写入log，而是丢弃所有log
// Disabled is a Logger that will never output anything.
var Disabled Logger
func init() {
Disabled = &slog{lvl: LevelOff, b: NewBackend(ioutil.Discard)}
}
使用
btcd项目main包中，初始化全局log变量backendLog。然后针对各个子模块定义了多个全局变量，负责各个模块log记录。这些变量都共享backedLog，因为slog结构体中Backend字段为指针类型。
backendLog = btclog.NewBackend(logWriter{})
logRotator *rotator.Rotator
adxrLog = backendLog.Logger("ADXR")
amgrLog = backendLog.Logger("AMGR")
cmgrLog = backendLog.Logger("CMGR")
bcdbLog = backendLog.Logger("BCDB")
btcdLog = backendLog.Logger("BTCD")
chanLog = backendLog.Logger("CHAN")
discLog = backendLog.Logger("DISC")
indxLog = backendLog.Logger("INDX")
minrLog = backendLog.Logger("MINR")
peerLog = backendLog.Logger("PEER")
rpcsLog = backendLog.Logger("RPCS")
scrpLog = backendLog.Logger("SCRP")
srvrLog = backendLog.Logger("SRVR")
syncLog = backendLog.Logger("SYNC")
txmpLog = backendLog.Logger("TXMP")
Logger()方法，只是变换了tag字段，共享Backed
func (b *Backend) Logger(subsystemTag string) Logger {
return &slog{LevelInfo, subsystemTag, b}
}
在main包初始化函数中，对各个包中的全局变量进行赋值。相当于将main包中的全局变量拷贝到各个模块中。各个模块使用这个针对这个包的log拷贝进行log的记录。
func init() {
addrmgr.UseLogger(amgrLog) // 前面是包名
connmgr.UseLogger(cmgrLog)
database.UseLogger(bcdbLog)
blockchain.UseLogger(chanLog)
indexers.UseLogger(indxLog)
mining.UseLogger(minrLog)
cpuminer.UseLogger(minrLog)
peer.UseLogger(peerLog)
txscript.UseLogger(scrpLog)
netsync.UseLogger(syncLog)
mempool.UseLogger(txmpLog)
}
在各个模块中，默认不输出日志，这里涉及到golang init函数的初始化顺序的问题。简单介绍如下，在程序启动时，从main包开始，main包import各个模块，因此被导入包先进行初始化，这时各个模块中init函数开始执行，DisableLog()方法初始化本模块中的全局变量log，并赋值为btclog.Disabled，也就是前面说到的抛弃所有日志记录。当前模块中的log不记录任何日志信息。模块的init执行完成之后，再执行main包中的init函数，该函数将指定模块中的全局变量重新赋值为具有指定tag的log，也就是main中的代表各个模块log的拷贝。这样就完成了各个模块的log定义。
到这里可能会有一个疑问，为什么模块中的log要初始化两边呢。这是为了做到一定的灵活性。举例说明，假如程序设计者停止对mining模块记录日志，只需要在main包中去除全局变量minrLog = backendLog.Logger("MINR") 和函数调用mining.UseLogger(minrLog)这样mining默认为Disabled，也就不再进行日志记录。
以mempool模块为例：
var log btclog.Logger
func init() {
DisableLog() // 初始化
}
// DisableLog disables all library log output. Logging output is disabled
// by default until either UseLogger or SetLogWriter are called.
func DisableLog() {
log = btclog.Disabled // 不输出任何内容
}
// UseLogger uses a specified Logger to output package logging info.
// This should be used in preference to SetLogWriter if the caller is also
// using btclog.
func UseLogger(logger btclog.Logger) {
log = logger // 修改log
}
其他
在btclog包中还涉及了缓冲池，在有些模块中还针对log做了定制化的处理，可以去看btcd的log相关源码。
