-
Notifications
You must be signed in to change notification settings - Fork 9
/
logging.go
217 lines (176 loc) · 5.56 KB
/
logging.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
// Copyright 2022 Namespace Labs Inc; All rights reserved.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
package logging
import (
"context"
"encoding/json"
"fmt"
"os"
"strconv"
"strings"
"time"
"github.com/rs/zerolog"
"golang.org/x/exp/slices"
"google.golang.org/grpc"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/peer"
"namespacelabs.dev/foundation/std/go/core"
nsgrpc "namespacelabs.dev/foundation/std/grpc"
"namespacelabs.dev/foundation/std/grpc/requestid"
)
var (
maxOutputToTerminal = 1024
skipLogging []string
)
func init() {
zerolog.TimeFieldFormat = time.RFC3339Nano // Setting external package globals does not make me happy.
if v := os.Getenv("FOUNDATION_GRPCLOG_MESSAGE_MAX_BYTES"); v != "" {
if parsed, err := strconv.ParseInt(v, 10, 32); err != nil {
panic(err)
} else {
maxOutputToTerminal = int(parsed)
}
}
if v := os.Getenv("FOUNDATION_GRPCLOG_SKIP_METHODS"); v != "" {
skipLogging = strings.Split(v, ",")
}
}
var Log = core.ZLog
func Background() context.Context {
return Log.WithContext(context.Background())
}
type interceptor struct{}
func (interceptor) unary(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error) {
rdata, has := requestid.RequestDataFromContext(ctx)
if !has {
return handler(ctx, req)
}
zero := prepareLogger(ctx, rdata.RequestID, info.FullMethod)
logger := zero.Logger()
loggable := !slices.Contains(skipLogging, strings.TrimPrefix(info.FullMethod, "/"))
if loggable {
makeNewEvent(ctx, logger.Info().Str("kind", "grpclog").Str("what", "request")).Str("request_body", SerializeMessage(req)).Send()
}
resp, err := handler(logger.WithContext(ctx), req)
if loggable {
if err == nil {
logger.Info().Str("kind", "grpclog").Dur("took", time.Since(rdata.Started)).Str("what", "response").Str("response_body", SerializeMessage(resp)).Send()
} else {
logger.Info().Str("kind", "grpclog").Dur("took", time.Since(rdata.Started)).Str("what", "response").Err(err).Send()
}
}
return resp, err
}
func (interceptor) streaming(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error {
ctx := stream.Context()
rdata, has := requestid.RequestDataFromContext(ctx)
if !has {
return handler(srv, stream)
}
zero := prepareLogger(ctx, rdata.RequestID, info.FullMethod)
logger := zero.Logger()
loggable := !slices.Contains(skipLogging, strings.TrimPrefix(info.FullMethod, "/"))
if loggable {
makeNewEvent(ctx, logger.Info().Str("kind", "grpclog").Str("what", "stream_start")).Send()
}
err := handler(srv, &serverStream{stream, logger.WithContext(ctx)})
if loggable {
if err == nil {
logger.Info().Str("kind", "grpclog").Dur("took", time.Since(rdata.Started)).Str("what", "stream_end").Send()
} else {
logger.Info().Str("kind", "grpclog").Dur("took", time.Since(rdata.Started)).Str("what", "stream_end").Err(err).Send()
}
}
return err
}
func ParsePeerAddress(p *peer.Peer, md metadata.MD) (string, string) {
peerAddr := "unknown"
originalAddr := ""
if p != nil {
peerAddr = p.Addr.String()
}
if realIp := single(md, "x-real-ip"); realIp != "" {
originalAddr = peerAddr
peerAddr = realIp
// XXX use conditional printing instead.
delete(md, "x-real-ip")
delete(md, "x-forwarded-for")
delete(md, "x-forwarded-host")
delete(md, "x-forwarded-port")
delete(md, "x-forwarded-proto")
delete(md, "x-forwarded-scheme")
delete(md, "x-scheme")
}
return peerAddr, originalAddr
}
func prepareLogger(ctx context.Context, reqid requestid.RequestID, fullMethod string) zerolog.Context {
service, method := nsgrpc.SplitMethodName(fullMethod)
return Log.With().Str("service", service).Str("method", method).
Str("request_id", string(reqid))
}
func makeNewEvent(ctx context.Context, ev *zerolog.Event) *zerolog.Event {
var authType string
p, _ := peer.FromContext(ctx)
if p != nil && p.AuthInfo != nil {
authType = p.AuthInfo.AuthType()
}
// It's OK to modify the map below, because `FromIncomingContext` returns a copy.
md, _ := metadata.FromIncomingContext(ctx)
delete(md, "accept-encoding")
delete(md, "content-type")
authority := single(md, ":authority")
delete(md, ":authority")
if _, ok := md["authorization"]; ok {
if authType != "" {
authType = fmt.Sprintf("bearer (was %s)", authType)
} else {
authType = "bearer"
}
delete(md, "authorization")
}
peerAddr, wasAddr := ParsePeerAddress(p, md)
ev = ev.Str("peer", peerAddr)
if wasAddr != "" {
ev = ev.Str("original_peer", wasAddr)
}
if authType != "" {
ev = ev.Str("auth_type", authType)
}
if authority != "" {
ev = ev.Str("authority", authority)
}
if t, ok := ctx.Deadline(); ok {
ev = ev.Dur("deadline_left", time.Until(t))
}
return ev
}
func single(md metadata.MD, key string) string {
if value, ok := md[key]; ok && len(value) == 1 {
return value[0]
}
return ""
}
func Prepare(ctx context.Context, deps ExtensionDeps) error {
var interceptor interceptor
deps.Interceptors.ForServer(interceptor.unary, interceptor.streaming)
return nil
}
func SerializeMessage(msg interface{}) string {
if msg == nil {
return "<nil>"
}
reqBytes, _ := json.Marshal(msg)
reqStr := string(reqBytes)
if len(reqStr) > maxOutputToTerminal {
return fmt.Sprintf("%s [...%d chars truncated]", reqStr[:maxOutputToTerminal], len(reqStr)-maxOutputToTerminal)
}
return reqStr
}
type serverStream struct {
grpc.ServerStream
ctx context.Context
}
func (w *serverStream) Context() context.Context {
return w.ctx
}