news 2026/4/29 2:52:54

GO 日志的规范使用

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
GO 日志的规范使用

平时不太说废话,今天主要讲讲编程素质类的内容大家有兴趣的酌情阅读

GO语言日志的规范使用

在任何服务端的语言项目中,日志是至关重要的组成部分,它能够记录系统的运行状态、错误信息和关键事件,对于问题排查、性能优化以及系统监控都具有不可替代的作用。以下是一些关于如何规范使用GO语言日志的建议,以及相应的实际示例:

  1. 日志等级划分: 日志等级通常包括 Debug、Info、Warn、Error、DPanic 和 Fatal 等级别。不同等级的日志用于记录不同重要程度的信息。
  • Debug:用于记录详细的调试信息,仅在开发和测试阶段启用。
  • Info:用于记录正常运行状态的信息。
  • Warn:用于记录警告,表明可能发生了某些问题,但程序仍能正常运行。
  • Error:用于记录错误信息,表明发生了可恢复的错误。
  • DPanic:用于记录非致命性的错误,但会导致程序崩溃。
  • Fatal:用于记录致命性错误,会导致程序终止运行。
  1. 何时打印何种等级的日志: 根据日志等级的定义,应在以下情况下使用相应的日志等级:
  • Debug:在需要详细调试信息时,例如在开发和测试阶段。
  • Info:在程序正常运行时,记录关键信息和状态。
  • Warn:在发现一些可能的问题,但程序仍可继续运行时。
  • Error:在发生可恢复的错误时,表明程序出现了问题,但还能继续运行。
  • DPanic 和 Fatal:通常用于记录致命性错误,需要立即停止程序运行。
  1. 打印格式与时间戳: 日志格式应包括时间、日志级别、文件名、行号、消息等信息。时区时间是一个重要的考虑因素,确保日志记录的时间是可读的。

  2. 日志分割与存储: 日志应该以天为单位切换文件,并设置文件的最大上限以避免文件过大。当每天的文件大小超过阈值时,需要将当天的文件按序编号。

  3. 实际示例:

    这里 我们采用之前基于zap封装的通用日志模块集中处理Go 统一日志处理中的通用模块

Web服务示例:

packagemain ​import("github.com/gin-gonic/gin""your_project/common")funcmain(){common.Info("Web service started")​ router:=gin.Default()// Handlersrouter.GET("/",func(c*gin.Context){common.Debug("Handling root endpoint")c.JSON(200,gin.H{"message":"Hello, World!"})})// ...// Start the servererr:=router.Run(":8080")iferr!=nil{common.Error("Failed to start server",err)}}

GO Micro 示例:

packagemain ​import("context""github.com/micro/go-micro""github.com/micro/go-micro/service/grpc""your_project/common")funcmain(){// Create a new serviceservice:=grpc.NewService(micro.Name("example"),)// ...// Register the serviceiferr:=service.Run();err!=nil{common.Fatal("Service registration failed",err)}}

读取请求示例(Web服务):

packagemain ​import("github.com/gin-gonic/gin""your_project/common")funcgetUserHandler(c*gin.Context){// Reading parameters from the requestuserID:=c.Param("id")// Logging the received requestcommon.Info("Received request to fetch user with ID:",userID)// Perform necessary operations, e.g., fetch user from the database// Logging the completion of the requestcommon.Info("Request processed successfully")​ c.JSON(200,gin.H{"message":"User fetched successfully"})}funcmain(){router:=gin.Default()​ router.GET("/user/:id",getUserHandler)// Start the servererr:=router.Run(":8080")iferr!=nil{common.Fatal("Failed to start server",err)}}

被动接受请求示例(GO Micro):

packagemain ​import("context""github.com/micro/go-micro""github.com/micro/go-micro/service/grpc""your_project/common")// UserServiceHandler implements the UserService interfacetypeUserServiceHandlerstruct{}func(u*UserServiceHandler)GetUser(ctx context.Context,req*UserRequest,res*UserResponse)error{// Log the received requestcommon.Info("Received GetUser request for user ID:",req.UserId)// Perform necessary operations, e.g., fetch user from the database// Log the completion of the requestcommon.Info("GetUser request processed successfully")returnnil}funcmain(){// Create a new serviceservice:=grpc.NewService(micro.Name("example"),)// Register the service handlerservice.Init()UserService:=micro.NewService()UserService.Server().Handle(UserService.Server().NewHandler(&UserServiceHandler{}),)// ...// Run the serviceiferr:=service.Run();err!=nil{common.Fatal("Service registration failed",err)}}

读取消息中间件(如 Kafka)示例:

packagemain ​import("context""github.com/segmentio/kafka-go""your_project/common")funcmain(){r:=kafka.NewReader(kafka.ReaderConfig{// ...})for{m,err:=r.ReadMessage(context.Background())iferr!=nil{common.Error("Error reading message from Kafka",err)continue}// Process the messagecommon.Info("Message received:",string(m.Value))}}

Redis 缓存使用示例:

packagemain ​import("context""github.com/go-redis/redis/v8""your_project/common")funcmain(){// ...// Example: Fetch data from Redis cachekey:="example_key"val,err:=redisClient.Get(context.Background(),key).Result()iferr==redis.Nil{// Cache misscommon.Warn("Cache miss for key:",key)}elseiferr!=nil{// Error accessing Redis cachecommon.Error("Error accessing Redis cache:",err)}else{// Data retrieved successfully from cachecommon.Info("Data retrieved from cache:",val)}}
  1. 日志库的选择与封装: 选择一个高性能、结构化的日志库,如 Zap,可以提高日志记录的效率和可读性。对日志库进行适当的封装,如提供的 common 包中的例子,可以简化日志记录的使用并保持代码的一致性。

总结,规范使用GO语言日志的关键在于理解日志等级的含义,根据实际情况选择合适的日志等级,保持一致的日志格式和合理的日志分割与存储策略。通过恰当的日志记录,可以提高项目的可维护性和可靠性,使得问题排查和系统监控变得更加容易。以上示例展示了在实际项目中如何结合具体场景使用日志功能。

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/4/23 13:16:10

Langchain v1.0+ 浅出

Langchain 浅出 原本的计划是发一篇《langchain深入浅出》,但是太长了就切割成了两部份,先发了这篇浅出 中间还经历了大版本的更新╮(╯▽╰)╭但是有惊无险还是写完了。 作者:吴佳浩 最后更新:2025-11-27 适用版本:…

作者头像 李华
网站建设 2026/4/29 2:52:53

一篇拿下!C++:类和对象(中)构造函数与析构函数

第一:我们不写时,编译器默认生成的函数行为是什么,是否满足我们的需求。第二:编译器默认生成的函数不满足我们的需求,我们需要自己实现,那么如何自己实现?二、构造函数构造函数是特殊的成员函数…

作者头像 李华
网站建设 2026/4/27 9:54:07

torch 操作函数

torch.multinomial torch.multinomial 用于从多项分布中采样。给定一个包含概率的张量,该函数会根据这些概率返回采样的索引。适用于需要根据概率分布进行随机选择的场景,例如在强化学习中根据策略选择动作。 输入是一个概率分布张量,每个元素…

作者头像 李华
网站建设 2026/4/27 6:56:19

23、PHP编程与相关技术全解析

PHP编程与相关技术全解析 1. PHP基础操作与数据获取 在PHP编程中,对于日志条目的操作是一个常见场景。首先,会将日志条目的ID号存储在 $id 变量中。接着,会进行条件判断,如果存在ID号且该ID号大于0,程序会执行一系列操作。具体步骤如下: 1. 连接到服务器。 2. 选择…

作者头像 李华
网站建设 2026/4/28 7:17:21

46、使用容器更新和管理 SQL Server:全面指南

使用容器更新和管理 SQL Server:全面指南 1. 使用容器更新 SQL Server 在 RHEL 上更新 Linux 版 SQL Server 到新的累积更新时,通常会运行 sudo yum update mssql-server 命令。此命令会下载最新累积更新,关闭 SQL Server,应用新二进制文件,然后重新启动 SQL Server。…

作者头像 李华
网站建设 2026/4/27 17:14:57

k8s-应用部署和组件及常用命令(2)

、相关组件介绍:node是k8s的集群节点,和实际的机器对应pod是应用容器,不同的应用部署在不同的pod中,k8s协调资源,将pod部署到集群中的node节点上(非master节点)。同时pod又是挂在namespace下面的…

作者头像 李华