Zap: Unlock the Full Potential of Logging in Go

GO Language High Performance Library ZAP Detailed Explanation and Application

This article explores the high -performance GO log library ZAP developed by Uber, covering its characteristics, usage methods and advanced applications, such as log file division and level output. ZAP is famous for its speed and structured log output. The performance is better than similar libraries and even surpass the standard library.

github address: https://www.php.cn/link/26ac49243aa3065a10ca1796c2d1e57b

Example creation

ZAP provides three methods for creating Logger instances:

,

and zap.NewProduction(). The difference is that they record the details of the information, and the parameter type is limited to the string. zap.NewDevelopment() zap.Example()

// 代码示例
var log *zap.Logger
log = zap.NewExample()
log, _ := zap.NewDevelopment()
log, _ := zap.NewProduction()
log.Debug("这是一条DEBUG信息")
log.Info("这是一条INFO信息")

<code>// Example 输出
{"level":"debug","msg":"这是一条DEBUG信息"}
{"level":"info","msg":"这是一条INFO信息"}</code>

<code>// Development 输出
2025-01-28T00:00:00.000+0800    DEBUG    development/main.go:7    这是一条DEBUG信息
2025-01-28T00:00:00.000+0800    INFO    development/main.go:8    这是一条INFO信息</code>

Three creation methods comparison:

<code>// Production 输出
{"level":"info","ts":1737907200.0000000,"caller":"production/main.go:8","msg":"这是一条INFO信息"}
{"level":"info","ts":1737907200.0000000,"caller":"production/main.go:9","msg":"这是一条包含字段的INFO信息","region":["us-west"],"id":2}</code>

and

Using JSON format output,
• use line format output. Example Production Development Development
• Start printing stack information from the warning level, for tracking. Always printed package/file/line number (method).
  • Add additional fields as the JSON string to the tail.
  • Printing the name of the uppercase letter.
  • Use millisecond -level ISO8601 format to print timestamp.
  • Production
No record of debugging level news.
• For errors and panic records, the files in the stack will be tracked, but the warning level will not.
  Always add the file information of the caller.
  Printing date with a time stamp format.
  Print the name of the lowercase letter.
  • Format output
  ZAP provides two logger types:
and

. The difference is that you can obtain

by calling the

method of the main logger, and use it to record the statement in the Printf format:

*zap.Logger *zap.SugaredLogger Write the file .Sugar() By default, log output to the application console. To facilitate the inquiries, the log can be written into the file. At this time, the three methods of creating instances mentioned earlier cannot be used, but SugaredLogger.

var sugarLogger *zap.SugaredLogger

func InitLogger() {
  logger, _ := zap.NewProduction()
    sugarLogger = logger.Sugar()
}

func main() {
    InitLogger()
    defer sugarLogger.Sync()
    sugarLogger.Errorf("获取URL %s 失败：错误 = %s", url, err)
}

At the same time, output to the console and file

zap.New() If you need to output to the console and file at the same time, you only need to modify

. Examples as follows:

package main

import (
    "go.uber.org/zap"
    "go.uber.org/zap/zapcore"
    "os"
)

var log *zap.Logger
func main() {
    writeSyncer, _ := os.Create("./info.log")                           // 日志文件存储目录
    encoderConfig := zap.NewProductionEncoderConfig()                    // 指定时间格式
    encoderConfig.EncodeTime = zapcore.ISO8601TimeEncoder
    encoderConfig.EncodeLevel = zapcore.CapitalLevelEncoder
    encoder := zapcore.NewConsoleEncoder(encoderConfig)                 // 获取编码器，NewJSONEncoder() 输出JSON格式，NewConsoleEncoder() 输出纯文本格式
    core := zapcore.NewCore(encoder, writeSyncer, zapcore.DebugLevel)    // 第三及后续参数是写入文件的日志级别。ErrorLevel模式下，只记录错误级别的日志。
    log = zap.New(core,zap.AddCaller())                                // AddCaller() 用于显示文件名和行号。
    log.Info("hello world")
    log.Error("hello world")
}

<code>// 日志文件输出结果：
2025-01-28T00:00:00.000+0800    INFO    geth/main.go:18 hello world
2025-01-28T00:00:00.000+0800    ERROR   geth/main.go:19 hello world</code>

File segmentation

Log files will become larger and larger over time. To avoid occupying a large number of disk space, log files are needed according to specific conditions. ZAP itself does not provide file segmentation function, but you can use the Lumberjack package recommended by ZAP to achieve it.

// 代码示例
var log *zap.Logger
log = zap.NewExample()
log, _ := zap.NewDevelopment()
log, _ := zap.NewProduction()
log.Debug("这是一条DEBUG信息")
log.Info("这是一条INFO信息")

Write the file at the level

In order to facilitate the inquiries of managers, the logs below the error level are usually written into info.log. The logs of error level and above are written into the error.log file. You only need to modify the third parameter of the method, and then divide the file to the info and error. Examples as follows: zapcore.NewCore

After modification, the log and Debug -level logs are stored in info.log, and the ERROR -level logs are stored in the error.log file alone.

<code>// Example 输出
{"level":"debug","msg":"这是一条DEBUG信息"}
{"level":"info","msg":"这是一条INFO信息"}</code>

The console shows the color at the level

Just specify the

of the encoder.

EncodeLevel

Display file path and line number

<code>// Development 输出
2025-01-28T00:00:00.000+0800    DEBUG    development/main.go:7    这是一条DEBUG信息
2025-01-28T00:00:00.000+0800    INFO    development/main.go:8    这是一条INFO信息</code>

As mentioned earlier, to display the file path and line number, just add parameters

to the

method. If you want to display the complete path, you need to specify in the encoder configuration. zap.New zap.AddCaller()

Full code

<code>// Production 输出
{"level":"info","ts":1737907200.0000000,"caller":"production/main.go:8","msg":"这是一条INFO信息"}
{"level":"info","ts":1737907200.0000000,"caller":"production/main.go:9","msg":"这是一条包含字段的INFO信息","region":["us-west"],"id":2}</code>

Leapcell: Best Golang application hosting, asynchronous task and Redis platform

var sugarLogger *zap.SugaredLogger

func InitLogger() {
  logger, _ := zap.NewProduction()
    sugarLogger = logger.Sugar()
}

func main() {
    InitLogger()
    defer sugarLogger.Sync()
    sugarLogger.Errorf("获取URL %s 失败：错误 = %s", url, err)
}

Finally, recommend a best platform to deploy Golang services: Leapcell

1. Multi -language support

Use JavaScript, Python, GO or Rust for development.

2. Deploy unlimited projects for free

Just pay for use -no request, no cost.

3. Unparalleled cost benefits

Pay on demand, no idle costs.

For example: $ 25 supports 6.94 million requests, with an average response time of 60 milliseconds.

4. Simplified developer experience

intuitive UI, easy settings.

Full automatic CI/CD pipeline and gitops integration.

• Real -time indicators and log records provide operating insights.
5. Easy expansion and high performance

Automatic extension to easily handle high and merger.

Zero operation expenses -just focus on construction.

Learn more information in the document!

Leapcell Twitter: https://www.php.cn/link/7884effb9452a6d7a79499EF854AFD

This Revied Output Maintains The Original Meaning and Image Placement While Significantly ALTERING AND Structure for Originality. Remember to re Place the Sections with the actual code from the input.

The above is the detailed content of Zap: Unlock the Full Potential of Logging in Go. For more information, please follow other related articles on the PHP Chinese website!