-
-
Notifications
You must be signed in to change notification settings - Fork 66
/
log.go
92 lines (78 loc) · 2.51 KB
/
log.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
package log
import (
"io"
"time"
"goyave.dev/goyave/v3"
)
// Formatter is a function that builds a log entry.
// As logs are written at the end of the request's lifecycle, all the
// data is available to formatters at the time they are called, and all
// modifications will have no effect.
type Formatter func(now time.Time, response *goyave.Response, request *goyave.Request, length int) string
// Writer chained writer keeping response body in memory.
// Used for loggin in common format.
type Writer struct {
formatter Formatter
writer io.Writer
now time.Time
request *goyave.Request
response *goyave.Response
length int
}
var _ io.Closer = (*Writer)(nil)
var _ goyave.PreWriter = (*Writer)(nil)
// NewWriter create a new LogWriter.
// The given Request and Response will be used and passed to the given
// formatter.
func NewWriter(response *goyave.Response, request *goyave.Request, formatter Formatter) *Writer {
return &Writer{
now: time.Now(),
request: request,
writer: response.Writer(),
response: response,
formatter: formatter,
}
}
// PreWrite calls PreWrite on the
// child writer if it implements PreWriter.
func (w *Writer) PreWrite(b []byte) {
if pr, ok := w.writer.(goyave.PreWriter); ok {
pr.PreWrite(b)
}
}
// Write writes the data as a response and keeps it in memory
// for later logging.
func (w *Writer) Write(b []byte) (int, error) {
w.length += len(b)
return w.writer.Write(b)
}
// Close the writer and its child ResponseWriter, flushing response
// output to the logs.
func (w *Writer) Close() error {
goyave.AccessLogger.Println(w.formatter(w.now, w.response, w.request, w.length))
if wr, ok := w.writer.(io.Closer); ok {
return wr.Close()
}
return nil
}
// Middleware captures response data and outputs it to the default logger
// using the given formatter.
func Middleware(formatter Formatter) goyave.Middleware {
return func(next goyave.Handler) goyave.Handler {
return func(response *goyave.Response, request *goyave.Request) {
logWriter := NewWriter(response, request, formatter)
response.SetWriter(logWriter)
next(response, request)
}
}
}
// CommonLogMiddleware captures response data and outputs it to the default logger
// using the common log format.
func CommonLogMiddleware() goyave.Middleware {
return Middleware(CommonLogFormatter)
}
// CombinedLogMiddleware captures response data and outputs it to the default logger
// using the combined log format.
func CombinedLogMiddleware() goyave.Middleware {
return Middleware(CombinedLogFormatter)
}