Skip to content

Instantly share code, notes, and snippets.

@alfonmga
Created August 16, 2022 17:11
Show Gist options
  • Save alfonmga/ed53eab8aa28a471dffb6dc3f6186ef6 to your computer and use it in GitHub Desktop.
Save alfonmga/ed53eab8aa28a471dffb6dc3f6186ef6 to your computer and use it in GitHub Desktop.

Revisions

  1. alfonmga created this gist Aug 16, 2022.
    78 changes: 78 additions & 0 deletions ginlogrus.go
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,78 @@
    package ginlogrus

    import (
    "fmt"
    "math"
    "net/http"
    "os"
    "time"

    "github.com/gin-gonic/gin"
    "github.com/sirupsen/logrus"
    )

    var timeFormat = "02/Jan/2006:15:04:05 -0700"

    // Logger is the logrus logger handler
    func Logger(logger logrus.FieldLogger, notLogged ...string) gin.HandlerFunc {
    hostname, err := os.Hostname()
    if err != nil {
    hostname = "unknow"
    }

    var skip map[string]struct{}

    if length := len(notLogged); length > 0 {
    skip = make(map[string]struct{}, length)

    for _, p := range notLogged {
    skip[p] = struct{}{}
    }
    }

    return func(c *gin.Context) {
    // other handler can change c.Path so:
    path := c.Request.URL.Path
    start := time.Now()
    c.Next()
    stop := time.Since(start)
    latency := int(math.Ceil(float64(stop.Nanoseconds()) / 1000000.0))
    statusCode := c.Writer.Status()
    clientIP := c.ClientIP()
    clientUserAgent := c.Request.UserAgent()
    referer := c.Request.Referer()
    dataLength := c.Writer.Size()
    if dataLength < 0 {
    dataLength = 0
    }

    if _, ok := skip[path]; ok {
    return
    }

    entry := logger.WithFields(logrus.Fields{
    "hostname": hostname,
    "statusCode": statusCode,
    "latency": latency, // time to process
    "clientIP": clientIP,
    "method": c.Request.Method,
    "path": path,
    "referer": referer,
    "dataLength": dataLength,
    "userAgent": clientUserAgent,
    })

    if len(c.Errors) > 0 {
    entry.Error(c.Errors.ByType(gin.ErrorTypePrivate).String())
    } else {
    msg := fmt.Sprintf("%s - %s [%s] \"%s %s\" %d %d \"%s\" \"%s\" (%dms)", clientIP, hostname, time.Now().Format(timeFormat), c.Request.Method, path, statusCode, dataLength, referer, clientUserAgent, latency)
    if statusCode >= http.StatusInternalServerError {
    entry.Error(msg)
    } else if statusCode >= http.StatusBadRequest {
    entry.Warn(msg)
    } else {
    entry.Debug(msg)
    }
    }
    }
    }