自定义 gin 日志记录中间件截​​断日志

“纵有疾风来，人生不言弃”，这句话送给正在学习Golang的朋友们，也希望在阅读本文《自定义 gin 日志记录中间件截​​断日志》后，能够真的帮助到大家。我也会在后续的文章中，陆续更新Golang相关的技术文章，有好的建议欢迎大家在评论留言，非常感谢！

间歇性地，我看到截断的 json 对象通过我的自定义日志记录中间件写入 loggly。我已经确认传出记录实际上在我的代码中被截断。

日志使用 zerolog 进行格式化，然后在 stdout 和 loggly 之间输出。

我使用的 loggly 包相当旧，但似乎只是实现了带有缓冲区的 io.writer https://github.com/segmentio/go-loggly。

我担心 gin 在日志写入缓冲区之前终止上下文，写入被缩短？但在 gin 文档提供的示例中，我没有看到任何截然不同的东西。我已经删除了尽可能多的仍然遇到问题的无关代码。

写入 stdout 的日志是完整的，但通过 loggly 包发送的日志被截断。

package main

import (
    "io"
    "os"

    "github.com/gin-gonic/gin"
    "github.com/rs/zerolog"
    "github.com/segmentio/go-loggly"
)

var logglyclient *loggly.client

func init() {
    logglytoken := "potato"
    logglyclient = loggly.new(logglytoken)
}

func newlogger() zerolog.logger {
    writers := []io.writer{zerolog.consolewriter{out: os.stdout}}
    writers = append(writers, logglyclient)
    multiwriter := zerolog.multilevelwriter(writers...)
    logger := zerolog.new(multiwriter).with().timestamp().logger()

    return logger
}

func ginmiddleware() gin.handlerfunc {
    return func(gctx *gin.context) {
        logger := newlogger()
        logger.info().msg("api request")

        gctx.next()
    }
}

func main() {
    router := gin.new()
    router.use(ginmiddleware())
    logger := newlogger()
    router.get("/ping", func(c *gin.context) {
        c.json(200, gin.h{
            "message": "pong",
        })
    })
    logger.info().msg("server listening!")
    router.run(":8080")
}

使用以下包

github.com/gin-gonic/gin v1.7.7
github.com/rs/zerolog v1.26.0
github.com/segmentio/go-loggly v0.5.0

正确答案

在退出程序之前刷新 loggly 客户端应该可以做到这一点。

https://github.com/segmentio/go-loggly/blob/7a70408c3650c37ba8e58a934f686d0c44cb9b58/loggly.go#L216

func main() {
    defer logglyclient.flush()

    router := gin.new()
    router.use(ginmiddleware())
    logger := newlogger()
    router.get("/ping", func(c *gin.context) {
        c.json(200, gin.h{
            "message": "pong",
        })
    })
    logger.info().msg("server listening!")
    router.run(":8080")
}

最重要的是，您必须实现服务器的正常关闭，以防止程序突然退出。

gin 文档为此提供了一个示例

https://chenyitian.gitbooks.io/gin-web-framework/content/docs/38.html

func main() {
    router := gin.Default()
    router.GET("/", func(c *gin.Context) {
        time.Sleep(5 * time.Second)
        c.String(http.StatusOK, "Welcome Gin Server")
    })

    srv := &http.Server{
        Addr:    ":8080",
        Handler: router,
    }

    go func() {
        // service connections
        if err := srv.ListenAndServe(); err != nil {
            log.Printf("listen: %s\n", err)
        }
    }()

    // Wait for interrupt signal to gracefully shutdown the server with
    // a timeout of 5 seconds.
    quit := make(chan os.Signal)
    signal.Notify(quit, os.Interrupt)
    <-quit
    log.Println("Shutdown Server ...")

    ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
    defer cancel()
    if err := srv.Shutdown(ctx); err != nil {
        log.Fatal("Server Shutdown:", err)
    }
    log.Println("Server exiting")
}

到这里，我们也就讲完了《自定义 gin 日志记录中间件截​​断日志》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！