-
Notifications
You must be signed in to change notification settings - Fork 13
/
logger.go
307 lines (262 loc) · 9.28 KB
/
logger.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
package middleware
import (
"bufio"
"bytes"
"context"
"io"
"net"
"net/http"
"net/url"
"strings"
"time"
"github.com/allaboutapps/integresql/pkg/util"
"github.com/labstack/echo/v4"
"github.com/labstack/echo/v4/middleware"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
)
// RequestBodyLogSkipper defines a function to skip logging certain request bodies.
// Returning true skips logging the payload of the request.
type RequestBodyLogSkipper func(req *http.Request) bool
// DefaultRequestBodyLogSkipper returns true for all requests with Content-Type
// application/x-www-form-urlencoded or multipart/form-data as those might contain
// binary or URL-encoded file uploads unfit for logging purposes.
func DefaultRequestBodyLogSkipper(req *http.Request) bool {
contentType := req.Header.Get(echo.HeaderContentType)
switch {
case strings.HasPrefix(contentType, echo.MIMEApplicationForm),
strings.HasPrefix(contentType, echo.MIMEMultipartForm):
return true
default:
return false
}
}
// ResponseBodyLogSkipper defines a function to skip logging certain response bodies.
// Returning true skips logging the payload of the response.
type ResponseBodyLogSkipper func(req *http.Request, res *echo.Response) bool
// DefaultResponseBodyLogSkipper returns false for all responses with Content-Type
// application/json, preventing logging for all other types of payloads as those
// might contain binary or URL-encoded data unfit for logging purposes.
func DefaultResponseBodyLogSkipper(_ *http.Request, res *echo.Response) bool {
contentType := res.Header().Get(echo.HeaderContentType)
switch {
case strings.HasPrefix(contentType, echo.MIMEApplicationJSON):
return false
default:
return true
}
}
// BodyLogReplacer defines a function to replace certain parts of a body before logging it,
// mainly used to strip sensitive information from a request or response payload.
// The []byte returned should contain a sanitized payload ready for logging.
type BodyLogReplacer func(body []byte) []byte
// DefaultBodyLogReplacer returns the body received without any modifications.
func DefaultBodyLogReplacer(body []byte) []byte {
return body
}
// HeaderLogReplacer defines a function to replace certain parts of a header before logging it,
// mainly used to strip sensitive information from a request or response header.
// The http.Header returned should be a sanitized copy of the original header as not to modify
// the request or response while logging.
type HeaderLogReplacer func(header http.Header) http.Header
// DefaultHeaderLogReplacer replaces all Authorization, X-CSRF-Token and Proxy-Authorization
// header entries with a redacted string, indicating their presence without revealing actual,
// potentially sensitive values in the logs.
func DefaultHeaderLogReplacer(header http.Header) http.Header {
sanitizedHeader := http.Header{}
for k, vv := range header {
shouldRedact := strings.EqualFold(k, echo.HeaderAuthorization) ||
strings.EqualFold(k, echo.HeaderXCSRFToken) ||
strings.EqualFold(k, "Proxy-Authorization")
for _, v := range vv {
if shouldRedact {
sanitizedHeader.Add(k, "*****REDACTED*****")
} else {
sanitizedHeader.Add(k, v)
}
}
}
return sanitizedHeader
}
// QueryLogReplacer defines a function to replace certain parts of a URL query before logging it,
// mainly used to strip sensitive information from a request query.
// The url.Values returned should be a sanitized copy of the original query as not to modify the
// request while logging.
type QueryLogReplacer func(query url.Values) url.Values
// DefaultQueryLogReplacer returns the query received without any modifications.
func DefaultQueryLogReplacer(query url.Values) url.Values {
return query
}
var (
DefaultLoggerConfig = LoggerConfig{
Skipper: middleware.DefaultSkipper,
Level: zerolog.DebugLevel,
LogRequestBody: false,
LogRequestHeader: false,
LogRequestQuery: false,
RequestBodyLogSkipper: DefaultRequestBodyLogSkipper,
RequestBodyLogReplacer: DefaultBodyLogReplacer,
RequestHeaderLogReplacer: DefaultHeaderLogReplacer,
RequestQueryLogReplacer: DefaultQueryLogReplacer,
LogResponseBody: false,
LogResponseHeader: false,
ResponseBodyLogSkipper: DefaultResponseBodyLogSkipper,
ResponseBodyLogReplacer: DefaultBodyLogReplacer,
}
)
type LoggerConfig struct {
Skipper middleware.Skipper
Level zerolog.Level
LogRequestBody bool
LogRequestHeader bool
LogRequestQuery bool
RequestBodyLogSkipper RequestBodyLogSkipper
RequestBodyLogReplacer BodyLogReplacer
RequestHeaderLogReplacer HeaderLogReplacer
RequestQueryLogReplacer QueryLogReplacer
LogResponseBody bool
LogResponseHeader bool
ResponseBodyLogSkipper ResponseBodyLogSkipper
ResponseBodyLogReplacer BodyLogReplacer
ResponseHeaderLogReplacer HeaderLogReplacer
}
// Logger with default logger output and configuration
func Logger() echo.MiddlewareFunc {
return LoggerWithConfig(DefaultLoggerConfig, nil)
}
// LoggerWithConfig returns a new MiddlewareFunc which creates a logger with the desired configuration.
// If output is set to nil, the default output is used. If more output params are provided, the first is being used.
func LoggerWithConfig(config LoggerConfig, output ...io.Writer) echo.MiddlewareFunc {
if config.Skipper == nil {
config.Skipper = DefaultLoggerConfig.Skipper
}
if config.RequestBodyLogSkipper == nil {
config.RequestBodyLogSkipper = DefaultRequestBodyLogSkipper
}
if config.RequestBodyLogReplacer == nil {
config.RequestBodyLogReplacer = DefaultBodyLogReplacer
}
if config.RequestHeaderLogReplacer == nil {
config.RequestHeaderLogReplacer = DefaultHeaderLogReplacer
}
if config.RequestQueryLogReplacer == nil {
config.RequestQueryLogReplacer = DefaultQueryLogReplacer
}
if config.ResponseBodyLogSkipper == nil {
config.ResponseBodyLogSkipper = DefaultResponseBodyLogSkipper
}
if config.ResponseBodyLogReplacer == nil {
config.ResponseBodyLogReplacer = DefaultBodyLogReplacer
}
if config.ResponseHeaderLogReplacer == nil {
config.ResponseHeaderLogReplacer = DefaultHeaderLogReplacer
}
return func(next echo.HandlerFunc) echo.HandlerFunc {
return func(c echo.Context) error {
if config.Skipper(c) {
return next(c)
}
req := c.Request()
res := c.Response()
id := req.Header.Get(echo.HeaderXRequestID)
if len(id) == 0 {
id = res.Header().Get(echo.HeaderXRequestID)
}
in := req.Header.Get(echo.HeaderContentLength)
if len(in) == 0 {
in = "0"
}
l := log.With().
Dict("req", zerolog.Dict().
Str("id", id).
Str("host", req.Host).
Str("method", req.Method).
Str("url", req.URL.String()).
Str("bytes_in", in),
).Logger()
if len(output) > 0 {
l = l.Output(output[0])
}
le := l.WithLevel(config.Level)
req = req.WithContext(l.WithContext(context.WithValue(req.Context(), util.CTXKeyRequestID, id)))
if config.LogRequestBody && !config.RequestBodyLogSkipper(req) {
var reqBody []byte
var err error
if req.Body != nil {
reqBody, err = io.ReadAll(req.Body)
if err != nil {
l.Error().Err(err).Msg("Failed to read body while logging request")
return err
}
req.Body = io.NopCloser(bytes.NewBuffer(reqBody))
}
le = le.Bytes("req_body", config.RequestBodyLogReplacer(reqBody))
}
if config.LogRequestHeader {
header := zerolog.Dict()
for k, v := range config.RequestHeaderLogReplacer(req.Header) {
header.Strs(k, v)
}
le = le.Dict("req_header", header)
}
if config.LogRequestQuery {
query := zerolog.Dict()
for k, v := range req.URL.Query() {
query.Strs(k, v)
}
le = le.Dict("req_query", query)
}
le.Msg("Request received")
c.SetRequest(req)
var resBody bytes.Buffer
if config.LogResponseBody {
mw := io.MultiWriter(res.Writer, &resBody)
writer := &bodyDumpResponseWriter{Writer: mw, ResponseWriter: res.Writer}
res.Writer = writer
}
start := time.Now()
err := next(c)
if err != nil {
c.Error(err)
}
stop := time.Now()
// Retrieve logger from context again since other middlewares might have enhanced it
ll := util.LogFromEchoContext(c)
lle := ll.WithLevel(config.Level).
Dict("res", zerolog.Dict().
Int("status", res.Status).
Int64("bytes_out", res.Size).
TimeDiff("duration_ms", stop, start).
Err(err),
)
if config.LogResponseBody && !config.ResponseBodyLogSkipper(req, res) {
lle = lle.Bytes("res_body", config.ResponseBodyLogReplacer(resBody.Bytes()))
}
if config.LogResponseHeader {
header := zerolog.Dict()
for k, v := range config.ResponseHeaderLogReplacer(res.Header()) {
header.Strs(k, v)
}
lle = lle.Dict("res_header", header)
}
lle.Msg("Response sent")
return nil
}
}
}
type bodyDumpResponseWriter struct {
io.Writer
http.ResponseWriter
}
func (w *bodyDumpResponseWriter) WriteHeader(code int) {
w.ResponseWriter.WriteHeader(code)
}
func (w *bodyDumpResponseWriter) Write(b []byte) (int, error) {
return w.Writer.Write(b)
}
func (w *bodyDumpResponseWriter) Flush() {
w.ResponseWriter.(http.Flusher).Flush()
}
func (w *bodyDumpResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error) {
return w.ResponseWriter.(http.Hijacker).Hijack()
}