Golang高性能日志记录与过滤插件库ozzo-log的使用

简介

ozzo-log是一个为Go程序提供增强日志记录支持的包。它具有以下特性：

• 通过异步日志记录实现高性能
• 记录消息的严重级别
• 记录消息的分类
• 记录消息的调用栈
• 通过严重级别和分类进行过滤
• 可自定义的消息格式
• 通过日志目标可配置和可插拔的消息处理
• 包含控制台、文件、网络和邮件日志目标

安装

运行以下命令安装包：

go get github.com/go-ozzo/ozzo-log

快速开始

以下代码片段展示了如何使用这个包：

package main

import (
	"github.com/go-ozzo/ozzo-log"
)

func main() {
    // 创建根日志记录器
	logger := log.NewLogger()

	// 添加控制台目标和文件目标
	t1 := log.NewConsoleTarget()
	t2 := log.NewFileTarget()
	t2.FileName = "app.log"
	t2.MaxLevel = log.LevelError
	logger.Targets = append(logger.Targets, t1, t2)

	logger.Open()
	defer logger.Close()

	// 调用日志方法记录各种日志消息
	logger.Error("plain text error")
	logger.Error("error with format: %v", true)
	logger.Debug("some debug info")

	// 自定义日志分类
	l := logger.GetLogger("app.services")
	l.Info("some info")
	l.Warning("some warning")
}

日志记录器和目标

日志记录器提供各种日志方法，可以被应用程序代码调用来记录不同严重级别的消息。

目标通过严重级别和消息分类过滤日志消息，并以各种方式处理过滤后的消息，例如将它们保存在文件中、通过电子邮件发送等。

一个日志记录器可以配备多个目标，每个目标有不同的过滤条件。

ozzo-log包中包含以下目标：

• ConsoleTarget: 在控制台窗口显示过滤后的消息
• FileTarget: 将过滤后的消息保存到文件中(支持文件轮转)
• NetworkTarget: 将过滤后的消息发送到网络地址
• MailTarget: 通过电子邮件发送过滤后的消息

严重级别

您可以通过调用Logger结构的以下方法之一来记录特定严重级别(遵循RFC5424标准)的消息：

• Emergency(): 系统不可用
• Alert(): 必须立即采取行动
• Critical(): 严重情况
• Error(): 错误情况
• Warning(): 警告情况
• Notice(): 正常但重要的情况
• Info(): 信息性目的
• Debug(): 调试目的

消息分类

每条日志消息都与一个分类相关联，该分类可用于对消息进行分组。例如，您可以使用相同的分类来记录由同一个Go包记录的消息。这将允许您有选择地将消息发送到不同的目标。

当您调用log.NewLogger()时，会返回一个根日志记录器，它使用名为app的分类记录消息。要使用不同的分类记录消息，可以调用根日志记录器或父日志记录器的GetLogger()方法来获取子日志记录器，然后调用其日志方法：

logger := log.NewLogger()
// 消息分类为"app"
logger.Error("...")

l1 := logger.GetLogger("system")
// 消息分类为"system"
l1.Error("...")

l2 := l1.GetLogger("app.models")
// 消息分类为"app.models"
l2.Error("...")

消息格式化

默认情况下，当发送到不同目标时，每条日志消息采用以下格式：

2015-10-22T08:39:28-04:00 [Error][app.models] something is wrong
...call stack (if enabled)...

您可以通过在调用Logger.GetLogger()时指定自己的消息格式化程序来自定义消息格式。例如：

logger := log.NewLogger()
logger = logger.GetLogger("app", func (l *Logger, e *Entry) string {
    return fmt.Sprintf("%v [%v][%v] %v%v", e.Time.Format(time.RFC822Z), e.Level, e.Category, e.Message, e.CallStack)
})

记录调用栈

通过将Logger.CallStackDepth设置为正数，可以记录每个日志方法调用的调用栈信息。您可以进一步配置Logger.CallStackFilter，以便只记录包含指定子字符串的调用栈帧。例如：

logger := log.NewLogger()
// 记录包含"myapp/src"的调用栈，每个日志消息最多5帧
logger.CallStackDepth = 5
logger.CallStackFilter = "myapp/src"

消息过滤

默认情况下，将记录所有严重级别的消息。您可以自定义Logger.MaxLevel来改变这种行为。例如：

logger := log.NewLogger()
// 只记录Emergency到Warning级别的消息
logger.MaxLevel = log.LevelWarning

除了在日志记录器级别过滤消息外，还可以在目标级别进行更细粒度的消息过滤。对于每个目标，您可以指定其MaxLevel，类似于日志记录器；您还可以指定目标应处理哪些分类的消息。例如：

target := log.NewConsoleTarget()
// 处理Emergency到Info级别的消息
target.MaxLevel = log.LevelInfo
// 处理以"system.db."或"app."开头的分类消息
target.Categories = []string{"system.db.*", "app.*"}

配置日志记录器

当应用程序部署到生产环境时，一个常见的需求是允许在不重新编译源代码的情况下更改应用程序的日志记录配置。ozzo-log就是为此而设计的。

例如，您可以使用JSON文件来指定应用程序及其日志记录器应如何配置：

{
    "Logger": {
        "Targets": [
            {
                "type": "ConsoleTarget",
            },
            {
                "type": "FileTarget",
                "FileName": "app.log",
                "MaxLevel": 4   // Warning或以上
            }
        ]
    }
}

假设JSON文件是app.json，在您的应用程序代码中，您可以使用ozzo-config包加载JSON文件并配置应用程序使用的日志记录器：

package main

import (
	"github.com/go-ozzo/ozzo-config"
    "github.com/go-ozzo/ozzo-log"
)

func main() {
    c := config.New()
    c.Load("app.json")
    // 注册目标类型以允许配置Logger.Targets
    c.Register("ConsoleTarget", log.NewConsoleTarget)
    c.Register("FileTarget", log.NewFileTarget)

    logger := log.NewLogger()
    if err := c.Configure(logger, "Logger"); err != nil {
        panic(err)
    }
}

要更改日志记录器配置，只需修改JSON文件而无需重新编译Go源文件。