56 lines
1.4 KiB
Go
56 lines
1.4 KiB
Go
|
// Package ginrus provides log handling using logrus package.
|
||
|
|
//
|
||
|
|
// Based on github.com/stephenmuss/ginerus but adds more options.
|
||
|
|
package ginrus
|
||
|
|
|
||
|
|
import (
|
||
|
|
"time"
|
||
|
|
|
||
|
|
"github.com/gin-gonic/gin"
|
||
|
|
"github.com/sirupsen/logrus"
|
||
|
|
)
|
||
|
|
|
||
|
|
type loggerEntryWithFields interface {
|
||
|
|
WithFields(fields logrus.Fields) *logrus.Entry
|
||
|
|
}
|
||
|
|
|
||
|
|
// Ginrus returns a gin.HandlerFunc (middleware) that logs requests using logrus.
|
||
|
|
//
|
||
|
|
// Requests with errors are logged using logrus.Error().
|
||
|
|
// Requests without errors are logged using logrus.Info().
|
||
|
|
//
|
||
|
|
// It receives:
|
||
|
|
// 1. A time package format string (e.g. time.RFC3339).
|
||
|
|
// 2. A boolean stating whether to use UTC time zone or local.
|
||
|
|
func Ginrus(logger loggerEntryWithFields, timeFormat string, utc bool) gin.HandlerFunc {
|
||
|
|
return func(c *gin.Context) {
|
||
|
|
start := time.Now()
|
||
|
|
// some evil middlewares modify this values
|
||
|
|
path := c.Request.URL.Path
|
||
|
|
c.Next()
|
||
|
|
|
||
|
|
end := time.Now()
|
||
|
|
latency := end.Sub(start)
|
||
|
|
if utc {
|
||
|
|
end = end.UTC()
|
||
|
|
}
|
||
|
|
|
||
|
|
entry := logger.WithFields(logrus.Fields{
|
||
|
|
"status": c.Writer.Status(),
|
||
|
|
"method": c.Request.Method,
|
||
|
|
"path": path,
|
||
|
|
"ip": c.ClientIP(),
|
||
|
|
"latency": latency,
|
||
|
|
"user-agent": c.Request.UserAgent(),
|
||
|
|
"time": end.Format(timeFormat),
|
||
|
|
})
|
||
|
|
|
||
|
|
if len(c.Errors) > 0 {
|
||
|
|
// Append error field if this is an erroneous request.
|
||
|
|
entry.Error(c.Errors.String())
|
||
|
|
} else {
|
||
|
|
entry.Info()
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|