Go日志包日志输出格式的自定义
Go 日志包基础
在 Go 语言中，标准库提供了 log 包用于日志记录。log 包提供了基本的日志记录功能，包括打印简单的消息到标准输出或标准错误。例如，以下是使用 log 包的简单示例：
package main
import (
"log"
)
func main() {
log.Println("This is a simple log message")
}
上述代码中，log.Println 函数将消息打印到标准输出，并在消息末尾添加换行符。log 包还提供了其他函数，如 log.Print（不添加换行符）和 log.Printf（支持格式化输出）。
日志输出的默认格式
log 包默认的日志输出格式包含时间戳、日志消息。例如：
2023/10/01 12:34:56 This is a simple log message
其中，时间戳的格式是 YYYY/MM/DD HH:MM:SS。
自定义日志输出格式的需求
在实际应用中，默认的日志格式可能无法满足所有需求。例如，在分布式系统中，可能需要在日志中添加服务名称、请求 ID 等信息，以便更好地进行故障排查和性能分析。又或者，在生产环境中，可能希望采用更紧凑、机器可读的格式，如 JSON 格式。因此，自定义日志输出格式变得十分必要。
基于标准库 log 包的简单自定义
设置日志前缀
log 包允许设置日志前缀，通过 log.SetPrefix 函数实现。例如：
package main
import (
"log"
)
func main() {
log.SetPrefix("[MyApp] ")
log.Println("This is a log message with a prefix")
}
运行上述代码，输出结果为：
[MyApp] 2023/10/01 12:34:56 This is a log message with a prefix
这样，通过设置前缀，可以在日志中添加应用相关的标识。
自定义时间格式
默认的时间格式是固定的，但可以通过 log.SetFlags 函数来修改日志标志，从而改变时间格式。log 包提供了一些预定义的标志常量，如 log.Ldate（日期：YYYY/MM/DD）、log.Ltime（时间：HH:MM:SS）、log.Lmicroseconds（微秒精度的时间）等。
以下是一个示例，展示如何只显示日期和小时分钟：
package main
import (
"log"
)
func main() {
log.SetFlags(log.Ldate | log.Ltime)
log.Println("This log shows only date and time in a custom way")
}
输出可能如下：
2023/10/01 12:34 This log shows only date and time in a custom way
实现自定义格式化函数
除了设置前缀和标志，还可以通过实现自定义的格式化函数来完全控制日志输出格式。log 包的 Logger 结构体提供了 Output 方法，该方法用于实际的日志输出。可以通过创建自定义的 Logger 并实现 Output 方法来实现自定义格式化。
package main
import (
"log"
"os"
"time"
)
type CustomLogger struct {
prefix string
}
func (cl *CustomLogger) Output(calldepth int, s string) error {
now := time.Now()
timestamp := now.Format("2006-01-02 15:04:05")
fullMessage := cl.prefix + timestamp + " " + s
_, err := os.Stdout.WriteString(fullMessage + "\n")
return err
}
func main() {
customLogger := &CustomLogger{prefix: "[Custom] "}
log.SetOutput(customLogger)
log.Println("This is a custom - formatted log message")
}
在上述代码中，CustomLogger 结构体实现了 Output 方法。在 Output 方法中，首先获取当前时间并格式化为指定格式，然后将前缀、时间戳和日志消息组合起来输出到标准输出。通过 log.SetOutput 将默认的日志输出设置为自定义的 CustomLogger，从而实现了自定义的日志格式。
使用第三方日志库实现更复杂的自定义
虽然标准库 log 包提供了一定程度的自定义功能，但在处理复杂的日志需求时，第三方日志库通常更为强大。例如，zerolog 和 logrus 就是两个流行的 Go 日志库，它们提供了丰富的功能，包括自定义日志格式、支持结构化日志等。
使用 zerolog 库
安装 zerolog
首先，需要通过 go get 命令安装 zerolog：
go get github.com/rs/zerolog
简单使用 zerolog
package main
import (
"log"
"github.com/rs/zerolog"
)
func main() {
zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
logger := zerolog.New(log.Writer()).With().Timestamp().Logger()
logger.Info().Msg("This is a zerolog info message")
}
在上述代码中，首先设置了时间字段的格式为 Unix 时间戳。然后创建了一个新的 zerolog.Logger，并通过 With().Timestamp() 添加了时间戳。最后，使用 logger.Info().Msg 记录一条信息日志。
自定义日志格式
zerolog 支持 JSON 格式和文本格式的日志输出，并且可以很方便地自定义格式。以下是一个自定义文本格式的示例：
package main
import (
"fmt"
"log"
"github.com/rs/zerolog"
)
func main() {
customFormat := func(i interface{}) string {
event := i.(zerolog.Event)
timestamp := event.Time().Format("2006-01-02 15:04:05")
level := event.Level().String()
message := event.Message()
return fmt.Sprintf("[%s] [%s] %s", timestamp, level, message)
}
zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
logger := zerolog.New(log.Writer()).Output(zerolog.ConsoleWriter{Format: customFormat}).With().Timestamp().Logger()
logger.Info().Msg("This is a custom - formatted zerolog message")
}
在上述代码中，定义了一个 customFormat 函数，该函数接受一个 interface{} 类型的参数，将其转换为 zerolog.Event 类型，然后提取时间戳、日志级别和日志消息，并按照自定义的格式进行组合。通过 zerolog.ConsoleWriter{Format: customFormat} 将自定义格式应用到日志输出中。
使用 logrus 库
安装 logrus
通过 go get 命令安装 logrus：
go get github.com/sirupsen/logrus
简单使用 logrus
package main
import (
"github.com/sirupsen/logrus"
)
func main() {
logrus.Info("This is a logrus info message")
}
上述代码使用 logrus 记录了一条简单的信息日志。
自定义日志格式
logrus 提供了 Formatter 接口来实现自定义日志格式。以下是一个自定义文本格式的示例：
package main
import (
"fmt"
"time"
"github.com/sirupsen/logrus"
)
type CustomFormatter struct{}
func (cf *CustomFormatter) Format(entry *logrus.Entry) ([]byte, error) {
timestamp := entry.Time.Format("2006-01-02 15:04:05")
level := entry.Level.String()
message := entry.Message
return []byte(fmt.Sprintf("[%s] [%s] %s\n", timestamp, level, message)), nil
}
func main() {
logrus.SetFormatter(&CustomFormatter{})
logrus.Info("This is a custom - formatted logrus message")
}
在上述代码中，定义了 CustomFormatter 结构体并实现了 Format 方法。在 Format 方法中，提取时间戳、日志级别和日志消息，并按照自定义格式进行组合。通过 logrus.SetFormatter 将自定义的格式化器设置为日志输出的格式。
结构化日志格式的自定义
结构化日志的概念
结构化日志与传统的文本日志不同，它将日志信息以结构化的方式存储，通常采用 JSON 格式。这种方式使得日志更容易被机器解析和处理，方便进行搜索、过滤和分析。例如，以下是一个结构化日志的示例：
{
"timestamp": "2023-10-01T12:34:56Z",
"level": "info",
"service": "my - service",
"message": "This is a structured log message",
"request_id": "1234567890"
}
使用 zerolog 实现结构化日志
package main
import (
"github.com/rs/zerolog"
"log"
)
func main() {
logger := zerolog.New(log.Writer()).With().
Str("service", "my - service").
Str("request_id", "1234567890").
Logger()
logger.Info().Msg("This is a structured log message")
}
上述代码通过 zerolog 创建了一个结构化日志记录器，并添加了 service 和 request_id 字段。日志输出将是 JSON 格式，类似于：
{"timestamp":"2023-10-01T12:34:56Z","level":"info","service":"my - service","request_id":"1234567890","message":"This is a structured log message"}
使用 logrus 实现结构化日志
package main
import (
"github.com/sirupsen/logrus"
)
func main() {
logger := logrus.New()
logger.WithFields(logrus.Fields{
"service": "my - service",
"request_id": "1234567890",
}).Info("This is a structured log message")
}
上述代码使用 logrus 创建了一个结构化日志记录器，并通过 WithFields 方法添加了 service 和 request_id 字段。日志输出将是 JSON 格式（默认情况下），类似于：
{"timestamp":"2023-10-01T12:34:56Z","level":"info","service":"my - service","request_id":"1234567890","message":"This is a structured log message"}
自定义日志格式的最佳实践
保持一致性
在整个项目中，应保持日志格式的一致性。无论是在不同的模块还是不同的环境（开发、测试、生产），统一的日志格式有助于更好地理解和处理日志。
包含关键信息
日志中应包含足够的关键信息，如时间戳、日志级别、服务名称、请求 ID 等。这些信息对于故障排查和性能分析至关重要。
考虑可读性和机器可解析性
如果日志主要由人工查看，应确保格式具有良好的可读性。但在分布式系统中，机器可解析性也很重要，因此可以考虑采用结构化日志格式，并提供一些工具将其转换为更易读的形式。
性能考量
在自定义日志格式时，要注意性能问题。复杂的格式化操作可能会影响应用的性能，尤其是在高并发场景下。尽量采用高效的格式化方法，避免不必要的计算和字符串拼接。
支持不同环境
不同的环境可能有不同的日志需求。例如，开发环境可能需要更详细的日志信息，而生产环境可能更注重性能和简洁性。应确保自定义的日志格式能够在不同环境下灵活配置和使用。
自定义日志格式在实际项目中的应用
Web 应用中的日志记录
在 Web 应用中，通常需要记录请求的相关信息，如请求方法、URL、响应状态码等。以下是使用 logrus 记录 Web 请求日志的示例：
package main
import (
"net/http"
"github.com/sirupsen/logrus"
)
func main() {
logger := logrus.New()
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
entry := logger.WithFields(logrus.Fields{
"method": r.Method,
"url": r.URL.String(),
})
w.WriteHeader(http.StatusOK)
entry.Info("Request processed successfully")
})
http.ListenAndServe(":8080", nil)
}
上述代码在处理每个 HTTP 请求时，记录了请求方法和 URL，并在请求处理成功时记录一条信息日志。
微服务架构中的日志记录
在微服务架构中，不同的微服务之间可能需要进行分布式跟踪。可以通过在日志中添加跟踪 ID 等信息来实现。以下是使用 zerolog 在微服务中记录带有跟踪 ID 的日志示例：
package main
import (
"context"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
)
func processRequest(ctx context.Context) {
traceID := ctx.Value("trace_id").(string)
logger := log.Ctx(ctx).With().Str("trace_id", traceID).Logger()
logger.Info().Msg("Processing request in microservice")
}
上述代码从上下文中获取跟踪 ID，并在日志中添加该跟踪 ID，以便在分布式系统中进行请求跟踪。
总结自定义日志格式的方法和注意事项
方法总结
- 基于标准库
log包：可以通过设置前缀、标志和实现自定义的Output方法来实现简单的日志格式自定义。 - 使用第三方日志库：如
zerolog和logrus，它们提供了更丰富的功能，包括支持结构化日志、灵活的自定义格式等。 - 结构化日志：采用 JSON 等结构化格式，通过第三方日志库方便地实现，提高日志的可解析性和处理效率。
注意事项
- 性能：避免在日志格式化过程中进行复杂、耗时的操作，以免影响应用性能。
- 一致性：确保整个项目中日志格式的一致性，便于统一管理和分析。
- 关键信息：保证日志中包含足够的关键信息，如时间、级别、服务标识、请求相关信息等，以满足故障排查和性能分析的需求。
- 环境适应性：能够根据不同的环境（开发、测试、生产）灵活调整日志格式和配置。
通过以上对 Go 日志包日志输出格式自定义的详细介绍，希望能帮助开发者在实际项目中更好地定制和管理日志，提高系统的可维护性和可观测性。无论是选择标准库还是第三方日志库，都应根据项目的具体需求和特点进行合理选择和配置。