golang seelog使用

golang中自带的有log包，但是功能并不能满足我们。很多人推荐seelog，我们今天一起学习下。

安装

go get github.com/cihub/seelog

快速开始

引用seelog wiki上的代码

package main
import log "github.com/cihub/seelog"
func () {
    defer log.Flush()
    log.Info("Hello from Seelog!")
}

这样就能在控制面板打印了，但是它是那么的丑陋！这里Info方法代表的是日志的级别，常用的有Trace, Debug, Info, Warn, Error, Critical 方法。
我们一般都会自定义格式等，seelog为我们提供了xml和代码两种方式来配置。
先看最简单的xml配置使用方法

<seelog>
	<outputs>
		<console />
	</outputs>
</seelog>

在代码中读取配置文档

logger, err := seelog.LoggerFromConfigAsFile("./config/seelog.xml")
if err != nil {
	log.Fatal(err)
}
seelog.ReplaceLogger(logger)
defer seelog.Flush()
seelog.Error("seelog from config xml")

这样我们就使用的默认的配置，将信息打印到控制面板，同样它是如此的丑陋！
我们可以在任何时候调用LoggerFromConfigAsFile，官网上有句英文很形象”Changing config on the fly”除了AsFile方法之外，还有LoggerFromConfigAsBytes’, ‘LoggerFromConfigAsString，但是本人还是配置文档可读性更好。
Flush方法很重要。一般的我们不会在main协程中写日志文档。logger应该异步并保持顺序的吞掉日志message放到队列中，而flush就是用来把队列中的数据写到文档中。在crash的时候也应该保证日志数据不会丢失，我们应该用defer语句来达到这个效果，并且在没有写日志操作之前就调用，这样我们后面就不用操心了。
在这里有个ReplaceLogger方法,我们来指定logger，类似的还有个UseLogger方法，前者会flush日志并关闭原来的logger,而后者只flush日志。

配置文档

先看下官网的示范配置文档

<seelog type="asynctimer" asyncinterval="5000000" minlevel="debug" maxlevel="error">
	<exceptions>
		<exception funcpattern="*main.test*Something*" minlevel="info"/>
		<exception filepattern="*main.go" minlevel="error"/>
	</exceptions>
	<outputs formatid="main">
		<console/>

		<splitter formatid="format1">
            <file path="log.log"/>
            <file path="log2.log"/>
        </splitter>
        <splitter formatid="format2">
            <file path="log3.log"/>
            <file path="log4.log"/>
        </splitter>

		<rollingfile formatid="someformat" type="size" filename="./log/roll.log" maxsize="100" maxrolls="5" />

		<buffered formatid="testlevels" size="10000" flushperiod="1000">
			<file path="./log/bufFileFlush.log"/>
		</buffered>

		<filter levels="error">
			<file path="./log/error.log"/>
			<smtp senderaddress="noreply-notification-service@none.org" 
				  sendername="Automatic notification service" 
				  hostname="mail.none.org" 
				  hostport="587" 
				  username="nns" 
				  password="123">
				<recipient address="john-smith@none.com"/>
				<recipient address="hans-meier@none.com"/>
			</smtp>
			<conn net="tcp4" addr="server.address:5514" tls="true" insecureskipverify="true" />
		</filter>

	</outputs>
	<formats>
		<format id="main" format="%Date(2006 Jan 02/3:04:05.000000000 PM MST) [%Level] %Msg%n"/>
		<format id="someformat" format="%Ns [%Level] %Msg%n"/>
		<format id="testlevels" format="%Level %Lev %LEVEL %LEV %l %Msg%n"/>
		<format id="usetags" format="&lt;msg&gt;%Msg&lt;/time&gt;"/>
		<format id="format1" format="%Date/%Time [%LEV] %Msg%n"/>
		<format id="format2" format="%File %FullPath %RelFile %Msg%n"/>
	</formats>
</seelog>

我们并不必把所有的配置项都了解清楚，只需要根据我们的需求配置即可。

formart配置

日志格式是配置文档中最重要的之一

<formats>
    <format id="common" format="[%LEV] %Msg"/>
    <format id="critical" format="%Time %Date %RelFile %Func %Msg"/>
    <format id="criticalemail" format="Critical error on our server!n    %Time %Date %RelFile %Func %Msg nSent by Seelog"/>
</formats>

我们可以指定一个format，每个format都有一个唯一大专栏 golang seelog使用的id方便在别的地方引用它，format属性就是格式了，我们可以指定颜色、日期及调用的地方等。以%开始，后跟特定的字符串

%Level log level (Trace, Debug, Info, Warn, Error, Critical)
%Lev short log level (Trc, Dbg, Inf, Wrn, Err, Crt)
%LEVEL capitalized log level (TRACE, DEBUG, INFO, WARN, ERROR, CRITICAL)
%LEV short capitalized log level (TRC, DBG, INF, WRN, ERR, CRT)
%l super compact log level (t, d, i, w, e, c)
%Msg message text (string)
%FullPath full caller file path
%File caller filename only
%RelFile caller path relative to the application runtime directory
%Func caller function name
%FuncShort caller function name part after the last dot
%Line line number where logger was called
Date and time
%Ns - time.Now().UnixNano()
%Date - shortcut for ‘2006-01-02’
%Time - shortcut for ‘15:04:05’
%Date(…) - date with format, specified in parentheses. Uses standard time.Format, so check http://golang.org/src/pkg/time/format.go for identifiers list. Use it like that: “%Date(2006-01-02)” (or any other format)
%UTCNs - time.Now().UTC().UnixNano()
%UTCDate - shortcut for ‘2006-01-02’ (UTC)
%UTCTime - shortcut for ‘15:04:05’ (UTC)
%UTCDate(…) - UTC date with format, specified in parentheses. Uses standard time.Format, so check http://golang.org/src/pkg/time/format.go for identifiers list. Use it like that: “%UTCDate(2006-01-02)” (or any other format)
Special symbols
%EscN - terminal ANSI CSI n [;k] m escape. Check Colored output for details
%n - newline

%t - tab

自定义formatter

上面这些特殊规则基本都能满足我们的需求，如果想自定义规则要注册：

func createMyFormatter(params string) seelog.FormatterFunc {
	fmt.Println(params)
	return func(message string, level seelog.LogLevel, context seelog.LogContextInterface) interface{} {
		return "hello"
	}
}

seelog.RegisterCustomFormatter("myFormat",createMyFormatter)

在配置文档中使用

1
2
3

<formats>
        <format id="test"  format="%myFormat(10) %Date %Time %LEV %RelFile %Line:%Msg%n"/>
</formats>

这样每次都会在日志钱加上”hello”

约束配置

约束是为了配置保存的日志级别的，分为全局约束和异常

全局约束
全局约束是应用到整个应用的。可以在根节点配置，可以设置最大、最小级别，或者直接列举出所有支持的级别。

<seelog minlevel="info" maxlevel="error">
<seelog levels="trace,info,critical">
```  
2. 异常约束
这个主要是指定特殊的方法或文档中使用异常级别，感觉用处不大，可以去官网看详情。
### Dispatchers and receivers
seelog为我们提供了主流的接收方式：文档、控制面板、网络通道、邮件等。  
举个栗子：
```xml
<seelog>
    <outputs>
        <splitter formatid="common">
            <console/>
            <file path="file.log"/>
            <conn addr="192.168.0.2:8123"/>
        </splitter>
        <filter levels="critical">
            <file path="critical.log" formatid="critical"/>
            <smtp formatid="criticalemail" senderaddress="noreply-notification-service@none.org" sendername="Automatic notification service" hostname="mail.none.org" hostport="587" username="nns" password="123">
                <recipient address="john-smith@none.com"/>
                <recipient address="hans-meier@none.com"/>
            </smtp>
        </filter>
    </outputs>
    <formats>
        <format id="common" format="[%LEV] %Msg"/>
        <format id="critical" format="%Time %Date %RelFile %Func %Msg"/>
        <format id="criticalemail" format="Critical error on our server!n    %Time %Date %RelFile %Func %Msg nSent by Seelog"/>
    </formats>
</seelog>

在这里我们配置输出信息，splitter把数据分为三个组，而filter根据日志级别分为了两个组。具体分组后的流向很容易明白，不再做解释。
问题来了：我们怎么知道接收者和分发的更多属性细节？且听我细细道来：

receivers细节

File writer

这个就比较简单了

<seelog>
    <outputs>
        <file path="log.log"/>
    </outputs>
</seelog>

注意不要使用特殊符号作为文档名即可

Console writer

这个更简单

<seelog>
    <outputs>
        <console/>
    </outputs>
</seelog>

Rolling file writer

通过这个节点我们在日期发生变化或者日志文档达到限制的时候切换另一个新的文档。下面是对属性的解释：

filename 指定日志文档路径，当切换新的日志文档的时候，文档名会有一定格式后面会讲解到
type “date”或者”size”
namemode “postfix”, “prefix”文档名前缀或后缀格式
maxrolls 最多的文档数目，当超过这个现在就回把原来的给删除掉
存档格式，当超过文档数目时可以指定存档格式”none”, “zip”, “gzip”。如果设置为”none”那么就会删除
archivepath 日志存档的目录
maxsize 当type为size类型是，每个文档最大的限制（单位是字节）
datepattern 日志文档名的日期格式，type为date时有效
fullname boolean型的值，是否设置当前日志文档就按过期格式命名

Buffered writer

顾名思义，先把数据存到内存中，当缓冲区满的时候再刷到文档中
1
2
3

<buffered size="10000" flushperiod="1000">
<file path="bufFile.log"/>
</buffered>

除了以上各种writer外还有邮件，网络这里暂时不讲了

自定义receiver

除了控制面板、文档、网络、邮件外，seelog还支持自定义接收者，但是比较复杂，如果有需求可以详细的看文档，此处暂不深究

总结

seelog功能的确很强大！