Skip to main content
 首页 » 编程设计

介绍 Golang 日志处理

2022年07月19日169qq78292959

介绍 Golang 日志处理

本文介绍Go语言的Log包及其API,通过示例让你轻松掌握日志处理。

1. 概述

日志文件一般用于记录操作系统或其他软件运行时发生的事件,或通信软件不同用户之间的消息。日志记录是一种记录日志的行为,在最简单的情况下,信息被写入单个日志文件。

很多分布式应用使用Go语言,主要利用其并发特性,如:channel、goroutine等。如果你也复杂构建或支持Go应用,那良好的日志策略可以帮助你理解用户行为、本地错误、监控应用性能等。

在GoLang的log包中,实现了简单的日志功能。定义了Logger类型及格式化输出方法,如:Print[f|ln], Fatal[f|ln], Panic[f|ln] ,这些方法使用起来很方便。

Golang Log提供了丰富的选项,下面我们将讨论其中的几个。

2. 使用Go标准日志库

Golang内置了标准日志库log,缺省的logger无需任何配置就能够写错误信息及时间戳。在实际开发中通常需要通过简单的日志快速获得反馈,而不是需要丰富的结构化日志。如果需要更强大的库,需引入第三方包。

2.1. 在控制台输出日志

下面通过示例进行说明。

// testLog.go 
 
package main 
 
import ( 
    "errors" 
    "fmt" 
    "log" 
) 
 
func division(x float32, y float32) (float32, error) { 
    if y == 0 { 
        return 0, errors.New("can't divide by zero") 
    } 
 
    return x / y, nil 
} 
 
func main() { 
 
    var x float32 = 11 
    var y float32 
 
    res, err := division(x, y) 
 
    if err != nil { 
        log.Print(err) 
    } 
 
    fmt.Println(res) 
} 

输出结果如下,第一行是错误信息,第二行是res的默认值为0.

2019/11/28 18:50:19 can't divide by zero 
0 

上面代码首先引入三个包:errors,fmt,log。然后定义division函数,其接收两个参数,函数体中检查除数是否为0,如何是返回错误信息。

在函数调用时,我们设定y作为除数,但没有赋值缺省为0,因此生成错误信息并打印在控制台上。

标准日志信息包括消息的发生日期和时间,标准错误信息。每个日志信息在单独一行显示,如果错误消息没有以换行符结尾,标准日志会增加换行符。

Fatal函数写日志信息后调用os.Exit(1)。Painic函数在写日志信息后调用painc函数。

2.2. 文件存储日志

上面示例日志在控制台中打印。实际应用中日志一般需存储在文件中,下面看示例:

package main 
 
import ( 
	"errors" 
	"fmt" 
	"log" 
	"os" 
) 
 
func division(x float32, y float32) (float32, error) { 
	if y == 0 { 
		return 0, errors.New("can't divide by zero") 
	} 
 
	return x / y, nil 
} 
 
func main() { 
	var x float32 = 11 
	var y float32  
 
	res, exception := division(x, y) 
	file, err := os.OpenFile("info.log", os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644) 
	log.SetOutput(file) 
 
	if err != nil { 
		log.Fatal(err) 
	} 
 
	if exception != nil { 
		log.Print(exception) 
	} 
 
	defer file.Close() 
 
	fmt.Println(res) 
} 
 

这回控制台仅输出0,错误日志在当前目录中文件info.log中。打开文件能看到内容:

2020/04/25 14:38:41 can't divide by zero 

Go中的os包意在统一所有操作系统的访问接口,对于不通用的特性在特定系统包syscall中。如果打开文件代码几乎能够自解释,创建日志文件并写入日志。最后关闭文件。

3. Github 包logrus格式化日志

logrus
是为结构化日志设计的日志包,非常适合JSON中进行日志记录。JSON格式使机器能够快速解析您的Golang日志。

Json格式是标准格式,增加新增的字段,解析器也很容易解析。使用logrus包可以通过WithFields方法定义标准至json日志。其提供了不同的日志级别,如: Info(), Warn(), and Error()。

logrus库自动在json中插入标准字段及你的自定义字段。要使用受限要现在并安装,命令如下:

go get github.com/Sirupsen/logrus 

现在在代码中导入包进行测试:

package main 
 
import ( 
    log "github.com/sirupsen/logrus" 
) 
 
func main() { 
    log.WithFields(log.Fields{ 
        "Best Song": "Sunflower", 
    }).Info("One of the best song") 
} 

输出为:

level=info msg="One of the best song" Best Song=Sunflower 
 

请注意,它与stdlib日志记录器完全兼容,因此您可以在任何地方用日志“github.com/sirupsen/logrus”替换您的日志导入,重复利用其Logrus的灵活性。你可以定制你想要的一切:

package main 
 
import ( 
	"os" 
 
	log "github.com/sirupsen/logrus" 
) 
 
func init() { 
	// Log as JSON instead of the default ASCII formatter. 
	log.SetFormatter(&log.JSONFormatter{}) 
 
	// Output to stdout instead of the default stderr 
	// Can be any io.Writer, see below for File example 
	log.SetOutput(os.Stdout) 
 
	// Only log the warning severity or above. 
	log.SetLevel(log.WarnLevel) 
} 
 
func main() { 
	log.WithFields(log.Fields{ 
		"animal": "walrus", 
		"size":   10, 
	}).Info("A group of walrus emerges from the ocean") 
 
	log.WithFields(log.Fields{ 
		"omg":    true, 
		"number": 122, 
	}).Warn("The group's number increased tremendously!") 
 
	log.WithFields(log.Fields{ 
		"omg":    true, 
		"number": 100, 
	}).Fatal("The ice breaks!") 
 
	// A common pattern is to re-use fields between logging statements by re-using 
	// the logrus.Entry returned from WithFields() 
	contextLogger := log.WithFields(log.Fields{ 
		"common": "this is a common field", 
		"other":  "I also should be logged always", 
	}) 
 
	contextLogger.Info("I'll be logged with common and other field") 
	contextLogger.Info("Me too") 
} 
 

输出:

{"level":"warning","msg":"The group's number increased tremendously!","number":1 
22,"omg":true,"time":"2020-04-25T15:24:07+08:00"} 
{"level":"fatal","msg":"The ice breaks!","number":100,"omg":true,"time":"2020-04 
-25T15:24:07+08:00"} 
 

总结

写日志首要任务是先找一个合适库,然后计划在哪里调用日志代码,如何存储,存储多久,如何分析日志。最佳实践:

  1. 一般建议应用程序的主流程中调用日志,不要在goroutine中使用。
  2. 最好把日志写在本地,即使后面要集中至中央服务进行处理。
  3. 可以使用预定义的消息使日志信息更加标准、规范。
  4. 发送日志至中央平台进行集中分析处理。
  5. 使用HTTP头和唯一ID记录用户访问微服务的行为。

本文通过示例介绍了Go的标准库log包,以及第三方库logrus。通过示例说明如何使用日志,最后顺便总结下使用日志最佳实践。


本文参考链接:https://blog.csdn.net/neweastsun/article/details/105755112
阅读延展