-
-
Notifications
You must be signed in to change notification settings - Fork 18
/
flog.go
227 lines (199 loc) · 7.09 KB
/
flog.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
// Package flog provides a set of fiber.Ctx helpers for zerolog.
package flog
import (
"context"
"time"
"github.com/gofiber/fiber/v2"
"github.com/rs/xid"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
"exusiai.dev/backend-next/internal/pkg/pgid"
"exusiai.dev/backend-next/internal/util"
)
// FromFiberCtx gets the logger in the request's context.
// This is a shortcut for log.Ctx(r.UserContext())
func FromFiberCtx(r *fiber.Ctx) *zerolog.Logger {
return log.Ctx(r.UserContext())
}
// NewHandlerMiddleware injects log into requests context.
func NewHandlerMiddleware(log zerolog.Logger) func(*fiber.Ctx) error {
return func(ctx *fiber.Ctx) error {
// Create a copy of the logger (including internal context slice)
// to prevent data race when using UpdateContext.
l := log.With().Logger()
// ctx.SetUserContext(context.WithValue(ctx.UserContext(), idKey{}, l))
injectedCtx := l.WithContext(ctx.UserContext())
ctx.SetUserContext(injectedCtx)
return ctx.Next()
}
}
// URLHandler adds the requested URL as a field to the context's logger
// using fieldKey as field key.
func URLHandler(fieldKey string) func(ctx *fiber.Ctx) error {
return func(ctx *fiber.Ctx) error {
log := zerolog.Ctx(ctx.UserContext())
log.UpdateContext(func(c zerolog.Context) zerolog.Context {
return c.Str(fieldKey, string(ctx.Request().URI().RequestURI()))
})
return ctx.Next()
}
}
// MethodHandler adds the request method as a field to the context's logger
// using fieldKey as field key.
func MethodHandler(fieldKey string) func(ctx *fiber.Ctx) error {
return func(ctx *fiber.Ctx) error {
log := zerolog.Ctx(ctx.UserContext())
log.UpdateContext(func(c zerolog.Context) zerolog.Context {
return c.Str(fieldKey, ctx.Method())
})
return ctx.Next()
}
}
// RequestHandler adds the request method and URL as a field to the context's logger
// using fieldKey as field key.
func RequestHandler(fieldKey string) func(ctx *fiber.Ctx) error {
return func(ctx *fiber.Ctx) error {
log := zerolog.Ctx(ctx.UserContext())
log.UpdateContext(func(c zerolog.Context) zerolog.Context {
return c.Str(fieldKey, ctx.Method()+" "+ctx.Path())
})
return ctx.Next()
}
}
// RemoteAddrHandler adds the request's remote address as a field to the context's logger
// using fieldKey as field key.
func RemoteAddrHandler(fieldKey string) func(ctx *fiber.Ctx) error {
return func(ctx *fiber.Ctx) error {
log := zerolog.Ctx(ctx.UserContext())
log.UpdateContext(func(c zerolog.Context) zerolog.Context {
return c.Str(fieldKey, util.ExtractIP(ctx))
})
return ctx.Next()
}
}
// UserAgentHandler adds the request's user-agent as a field to the context's logger
// using fieldKey as field key.
func UserAgentHandler(fieldKey string) func(ctx *fiber.Ctx) error {
return func(ctx *fiber.Ctx) error {
log := zerolog.Ctx(ctx.UserContext())
log.UpdateContext(func(c zerolog.Context) zerolog.Context {
return c.Str(fieldKey, ctx.Get("User-Agent"))
})
return ctx.Next()
}
}
// RefererHandler adds the request's referer as a field to the context's logger
// using fieldKey as field key.
func RefererHandler(fieldKey string) func(ctx *fiber.Ctx) error {
return func(ctx *fiber.Ctx) error {
log := zerolog.Ctx(ctx.UserContext())
log.UpdateContext(func(c zerolog.Context) zerolog.Context {
return c.Bytes(fieldKey, ctx.Request().Header.Referer())
})
return ctx.Next()
}
}
// PenguinIDHandler adds the request's penguin id as a field to the context's logger
func PenguinIDHandler(fieldKey string) func(ctx *fiber.Ctx) error {
return func(ctx *fiber.Ctx) error {
UpdateContext(ctx, func(c zerolog.Context) zerolog.Context {
return c.Str(fieldKey, pgid.Extract(ctx))
})
return ctx.Next()
}
}
// UpdateContext updates the context of the logger in the request's context.
func UpdateContext(ctx *fiber.Ctx, f func(c zerolog.Context) zerolog.Context) {
FromFiberCtx(ctx).UpdateContext(f)
}
type idKey struct{}
// IDFromFiberCtx returns the unique id associated to the *fiber.Ctx if any.
func IDFromFiberCtx(r *fiber.Ctx) (id xid.ID, ok bool) {
if r == nil {
return
}
return IDFromCtx(r.UserContext())
}
// IDFromCtx returns the unique id associated to the context if any.
func IDFromCtx(ctx context.Context) (id xid.ID, ok bool) {
id, ok = ctx.Value(idKey{}).(xid.ID)
return
}
// FiberCtxWithID adds the given xid.ID to the UserContext of *fiber.Ctx
func SetFiberCtxWithID(ctx *fiber.Ctx, id xid.ID) {
ctx.SetUserContext(CtxWithID(ctx.UserContext(), id))
}
// CtxWithID adds the given xid.ID to the context
func CtxWithID(ctx context.Context, id xid.ID) context.Context {
return context.WithValue(ctx, idKey{}, id)
}
// RequestIDHandler returns a handler setting a unique id to the request which can
// be gathered using IDFromFiberCtx(req). This generated id is added as a field to the
// logger using the passed fieldKey as field name. The id is also added as a response
// header if the headerName is not empty.
//
// The generated id is a URL safe base64 encoded mongo object-id-like unique id.
// Mongo unique id generation algorithm has been selected as a trade-off between
// size and ease of use: UUID is less space efficient and snowflake requires machine
// configuration.
func RequestIDHandler(fieldKey, headerName string) fiber.Handler {
return func(ctx *fiber.Ctx) error {
id, ok := IDFromFiberCtx(ctx)
if !ok {
id = xid.New()
SetFiberCtxWithID(ctx, id)
}
if fieldKey != "" {
log := FromFiberCtx(ctx)
log.UpdateContext(func(c zerolog.Context) zerolog.Context {
return c.Str(fieldKey, id.String())
})
}
if headerName != "" {
ctx.Set(headerName, id.String())
}
return ctx.Next()
}
}
// CustomHeaderHandler adds given header from request's header as a field to
// the context's logger using fieldKey as field key.
func CustomHeaderHandler(fieldKey, header string) func(ctx *fiber.Ctx) error {
return func(ctx *fiber.Ctx) error {
log := zerolog.Ctx(ctx.UserContext())
log.UpdateContext(func(c zerolog.Context) zerolog.Context {
return c.Str(fieldKey, ctx.Get(header))
})
return ctx.Next()
}
}
// AccessHandler returns a handler that call f after each request.
func AccessHandler(f func(ctx *fiber.Ctx, duration time.Duration)) fiber.Handler {
return func(ctx *fiber.Ctx) error {
start := time.Now()
err := ctx.Next()
f(ctx, time.Since(start))
return err
}
}
// Logger Level Method Helpers
func TraceFrom(ctx *fiber.Ctx, name string) *zerolog.Event {
return FromFiberCtx(ctx).Trace().Str("evt.name", name)
}
func DebugFrom(ctx *fiber.Ctx, name string) *zerolog.Event {
return FromFiberCtx(ctx).Debug().Str("evt.name", name)
}
func InfoFrom(ctx *fiber.Ctx, name string) *zerolog.Event {
return FromFiberCtx(ctx).Info().Str("evt.name", name)
}
func WarnFrom(ctx *fiber.Ctx, name string) *zerolog.Event {
return FromFiberCtx(ctx).Warn().Str("evt.name", name)
}
func ErrorFrom(ctx *fiber.Ctx, name string) *zerolog.Event {
return FromFiberCtx(ctx).Error().Str("evt.name", name)
}
func FatalFrom(ctx *fiber.Ctx, name string) *zerolog.Event {
return FromFiberCtx(ctx).Fatal().Str("evt.name", name)
}
func PanicFrom(ctx *fiber.Ctx, name string) *zerolog.Event {
return FromFiberCtx(ctx).Panic().Str("evt.name", name)
}