mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-12-29 20:00:30 +00:00
62 lines
1.7 KiB
Go
62 lines
1.7 KiB
Go
// Copyright 2023 Woodpecker Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package middleware
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/rs/zerolog/log"
|
|
)
|
|
|
|
// Logger returns a gin.HandlerFunc (middleware) that logs requests using zerolog.
|
|
//
|
|
// Requests with errors are logged using log.Err().
|
|
// Requests without errors are logged using log.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 Logger(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 := map[string]any{
|
|
"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.
|
|
log.Error().Str("error", c.Errors.String()).Fields(entry).Msg("")
|
|
} else {
|
|
log.Debug().Fields(entry).Msg("")
|
|
}
|
|
}
|
|
}
|