前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >gin框架之log处理

gin框架之log处理

作者头像
大话swift
发布2020-03-26 15:35:28
8.5K0
发布2020-03-26 15:35:28
举报
文章被收录于专栏:大话swift
我们在开发的过程中往往需要记录日志,记录日志可以帮我们追踪错误,追踪业务需求。那么gin中是如何记录日志的呢?
代码语言:javascript
复制
package main


import (
  "github.com/gin-gonic/gin"
  "io"
  "os"
)


func main() {
  // 记录到文件。
  f, _ := os.Create("gin.log")
  gin.DefaultWriter = io.MultiWriter(f)


  router := gin.Default()


  router.Run()
}

我们自定义了log的记录方式,但是这种方式国语简单,不利于我们收集错误信息。在这里为大家推荐一个记录日志的库`github.com/sirupsen/logrus`。logrus是目前Github上star数量最多的日志库.

logrus特性

  1. 完全兼容golang标准库日志模块:logrus拥有六种日志级别:debug、info、warn、error、fatal和panic,这是golang标准库日志模块的API的超集。如果您的项目使用标准库日志模块,完全可以以最低的代价迁移到logrus上。
  2. 可扩展的Hook机制:允许使用者通过hook的方式将日志分发到任意地方,如本地文件系统、标准输出、logstash、elasticsearch或者mq等,或者通过hook定义日志内容和格式等。
  3. 可选的日志输出格式:logrus内置了两种日志格式,JSONFormatter和TextFormatter,如果这两个格式不满足需求,可以自己动手实现接口Formatter,来定义自己的日志格式。
  4. Field机制:logrus鼓励通过Field机制进行精细化的、结构化的日志记录,而不是通过冗长的消息来记录日志。

logrus是一个可插拔的、结构化的日志框架。

代码语言:javascript
复制
package main

import (
  "fmt"
  "github.com/gin-gonic/gin"
  "github.com/sirupsen/logrus"
  "os"
  "path"
  "time"
)

func Logger() *logrus.Logger {
  now := time.Now()
  logFilePath := ""
  if dir, err := os.Getwd(); err == nil {
    logFilePath = dir + "/logs/"
  }
  if err := os.MkdirAll(logFilePath, 0777); err != nil {
    fmt.Println(err.Error())
  }
  logFileName := now.Format("2006-01-02") + ".log"
  //日志文件
  fileName := path.Join(logFilePath, logFileName)
  if _, err := os.Stat(fileName); err != nil {
    if _, err := os.Create(fileName); err != nil {
      fmt.Println(err.Error())
    }
  }
  //写入文件
  src, err := os.OpenFile(fileName, os.O_APPEND|os.O_WRONLY, os.ModeAppend)
  if err != nil {
    fmt.Println("err", err)
  }

  //实例化
  logger := logrus.New()

  //设置输出
  logger.Out = src

  //设置日志级别
  logger.SetLevel(logrus.DebugLevel)

  //设置日志格式
  logger.SetFormatter(&logrus.TextFormatter{
    TimestampFormat: "2006-01-02 15:04:05",
  })
  return logger
}

func LoggerToFile() gin.HandlerFunc {
  logger := Logger()
  return func(c *gin.Context) {
    // 开始时间
    startTime := time.Now()

    // 处理请求
    c.Next()

    // 结束时间
    endTime := time.Now()

    // 执行时间
    latencyTime := endTime.Sub(startTime)

    // 请求方式
    reqMethod := c.Request.Method

    // 请求路由
    reqUri := c.Request.RequestURI

    // 状态码
    statusCode := c.Writer.Status()

    // 请求IP
    clientIP := c.ClientIP()

    //日志格式
    logger.Infof("| %3d | %13v | %15s | %s | %s |",
      statusCode,
      latencyTime,
      clientIP,
      reqMethod,
      reqUri,
    )
  }
}

func main() {
  // 记录到文件。

  router := gin.Default()
  router.Use(LoggerToFile())
  router.GET("/", func(context *gin.Context) {
    //Info级别的日志
    Logger().WithFields(logrus.Fields{
      "name": "hanyun",
    }).Info("记录一下日志", "Info")
    //Error级别的日志
    Logger().WithFields(logrus.Fields{
      "name": "hanyun",
    }).Error("记录一下日志", "Error")
    //Warn级别的日志
    Logger().WithFields(logrus.Fields{
      "name": "hanyun",
    }).Warn("记录一下日志", "Warn")
    //Debug级别的日志
    Logger().WithFields(logrus.Fields{
      "name": "hanyun",
    }).Debug("记录一下日志", "Debug")
  })
  router.Run()
}

我们在路由中间件中使用了自定的日志中间件

代码语言:javascript
复制
  router.Use(LoggerToFile())

最终的日志格式如下

代码语言:javascript
复制
time="2020-03-09 17:23:00" level=info msg="记录一下日志Info" name=hanyun
time="2020-03-09 17:23:00" level=error msg="记录一下日志Error" name=hanyun
time="2020-03-09 17:23:00" level=warning msg="记录一下日志Warn" name=hanyun
time="2020-03-09 17:23:00" level=debug msg="记录一下日志Debug" name=hanyun
time="2020-03-09 17:23:00" level=info msg="| 200 |      2.9923ms |       127.0.0.1 | GET | / |"

当然了,这个日志库还可以将日志发送到elasticsearch,有兴趣的小伙伴可以尝试一下。

奉上代码,喜欢的小伙伴可以去自行下载

链接:https://pan.baidu.com/s/1fFsogIpPssm35CWV6H8m-g

提取码:xu7m

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2020-03-14,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 大话swift 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
相关产品与服务
Elasticsearch Service
腾讯云 Elasticsearch Service(ES)是云端全托管海量数据检索分析服务,拥有高性能自研内核,集成X-Pack。ES 支持通过自治索引、存算分离、集群巡检等特性轻松管理集群,也支持免运维、自动弹性、按需使用的 Serverless 模式。使用 ES 您可以高效构建信息检索、日志分析、运维监控等服务,它独特的向量检索还可助您构建基于语义、图像的AI深度应用。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档