文章目录
- 日志与错误
- log包
- 记录到文件
- 记录框架
- Contextual Logging
- Leveled Logging
- Setting Global Log Level
- Error Logging
日志与错误
通常，发生错误时，最终用户只会看到一条消息，指示程序出现问题。日志是简单错误消息以外的更多信息。
log包
Go 提供了一个用于处理日志的简单标准包。 可以像使用 fmt 包一样使用此包。 该标准包不提供日志级别，且不允许为每个包配置单独的记录器。 如果需要编写更复杂的日志记录配置，可以使用记录框架执行此操作。
代码
package main
import (
"log"
)
func main() {
log.SetPrefix("main(): ")
log.Print("Hey, I'm a log!")
log.Fatal("Hey, I'm an error log!")
}
输出
main(): 2021/01/05 13:59:58 Hey, I'm a log!
main(): 2021/01/05 13:59:58 Hey, I'm an error log!
exit status 1
只需设置一次前缀，日志就会包含日志源自的函数的名称等信息。
记录到文件
除了将日志打印到控制台之外，你可能还希望将日志发送到文件，以便稍后或实时处理这些日志。
为什么想要将日志发送到文件？
- 首先，你可能想要对最终用户隐藏特定信息。 他们可能对这些信息不感兴趣，或者你可能公开了敏感信息。
- 在文件中添加日志后，可以将所有日志集中在一个位置，并将它们与其他事件关联。
- 此模式为典型模式：具有可能是临时的分布式应用程序，例如容器。
代码
package main
import (
"log"
"os"
)
func main() {
//首先创建或打开文件
file, err := os.OpenFile("info.log", os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
if err != nil {
log.Fatal(err)
}
defer file.Close()
//配置为将所有输出发送到文件
log.SetOutput(file)
//像通常做法那样继续使用 log.Print() 函数
log.Print("Hey, I'm a log!")
}
记录框架
从Go 1.8开始，将GOPATH设置为环境变量不是必需的。如果我们没有设置一个，Go使用默认的GOPATH为$HOME/go。可以使用go env查看环境变量信息。
创建项目
# 创建项目目录
mkdir helloLog
cd helloLog
# 使用go mod初始化项目,生成go.mod文件
go mod init gitcode.net/gostudy/test001
# 创建main文件
touch main.go
main.go代码
package main
import (
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
)
func main() {
zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
log.Print("Hey! I'm a log message!")
}
通过go get -u github.com/rs/zerolog/log下载依赖。
查看go.mod文件。
项目目录下还多了一下go.sm文件
运行项目
$ go run main.go
{"level":"debug","time":1700291572,"message":"Hey! I'm a log message!"}
Contextual Logging
package main
import (
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
)
func main() {
zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
log.Debug().
Str("Scale", "833 cents").
Float64("Interval", 833.09).
Msg("Fibonacci is everywhere")
log.Debug().
Str("Name", "Tom").
Send()
}
// Output: {"level":"debug","Scale":"833 cents","Interval":833.09,"time":1562212768,"message":"Fibonacci is everywhere"}
// Output: {"level":"debug","Name":"Tom","time":1562212768}
Leveled Logging
package main
import (
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
)
func main() {
zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
log.Info().Msg("hello world")
}
// Output: {"time":1516134303,"level":"info","message":"hello world"}
zerolog允许在以下级别（从最高到最低）进行日志记录：
- panic (
zerolog.PanicLevel, 5) - fatal (
zerolog.FatalLevel, 4) - error (
zerolog.ErrorLevel, 3) - warn (
zerolog.WarnLevel, 2) - info (
zerolog.InfoLevel, 1) - debug (
zerolog.DebugLevel, 0) - trace (
zerolog.TraceLevel, -1)
Setting Global Log Level
此示例使用命令行标志来演示取决于所选日志级别的各种输出。
package main
import (
"flag"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
)
func main() {
zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
debug := flag.Bool("debug", false, "sets log level to debug")
flag.Parse()
// Default level for this example is info, unless debug flag is present
zerolog.SetGlobalLevel(zerolog.InfoLevel)
if *debug {
zerolog.SetGlobalLevel(zerolog.DebugLevel)
}
log.Debug().Msg("This message appears only when log level set to Debug")
log.Info().Msg("This message appears when log level set to Debug or Info")
if e := log.Debug(); e.Enabled() {
// Compute log output only if enabled.
value := "bar"
e.Str("foo", value).Msg("some debug message")
}
}
Info Output (no flag)
$ ./logLevelExample
{"time":1516387492,"level":"info","message":"This message appears when log level set to Debug or Info"}
Debug Output (debug flag set)
$ ./logLevelExample -debug
{"time":1516387573,"level":"debug","message":"This message appears only when log level set to Debug"}
{"time":1516387573,"level":"info","message":"This message appears when log level set to Debug or Info"}
{"time":1516387573,"level":"debug","foo":"bar","message":"some debug message"}
Error Logging
您可以使用Err方法记录错误
package main
import (
"errors"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
)
func main() {
zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
err := errors.New("seems we have an error here")
log.Error().Err(err).Msg("")
}
// Output: {"level":"error","error":"seems we have an error here","time":1609085256}
错误的默认字段名称是error，您可以通过设置zerolog来更改此名称。ErrorFieldName以满足您的需求。
