-
Notifications
You must be signed in to change notification settings - Fork 3
/
logging.go
159 lines (132 loc) · 4.77 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
package interceptor
import (
"time"
grpc_zap "github.com/grpc-ecosystem/go-grpc-middleware/logging/zap"
grpc_ctxtags "github.com/grpc-ecosystem/go-grpc-middleware/tags"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
"google.golang.org/grpc"
)
// ---------------------------------- client interceptor ----------------------------------
// UnaryClientLog 客户端日志unary拦截器
func UnaryClientLog(logger *zap.Logger, opts ...grpc_zap.Option) grpc.UnaryClientInterceptor {
return grpc_zap.UnaryClientInterceptor(logger, opts...)
}
// StreamClientLog 客户端日志stream拦截器
func StreamClientLog(logger *zap.Logger, opts ...grpc_zap.Option) grpc.StreamClientInterceptor {
return grpc_zap.StreamClientInterceptor(logger, opts...)
}
// ---------------------------------- server interceptor ----------------------------------
var ignoreLogMethods = map[string]struct{}{} // 忽略打印的方法
// LogOption 日志设置
type LogOption func(*logOptions)
type logOptions struct {
fields map[string]interface{}
ignoreMethods map[string]struct{}
}
func defaultLogOptions() *logOptions {
return &logOptions{
fields: make(map[string]interface{}), // 自定义打印kv
ignoreMethods: make(map[string]struct{}), // 忽略打印日志的方法
}
}
func (o *logOptions) apply(opts ...LogOption) {
for _, opt := range opts {
opt(o)
}
}
// WithLogFields 添加自定义打印字段
func WithLogFields(kvs map[string]interface{}) LogOption {
return func(o *logOptions) {
if len(kvs) == 0 {
return
}
o.fields = kvs
}
}
// WithLogIgnoreMethods 忽略打印的方法
// fullMethodName格式: /packageName.serviceName/methodName,
// 示例/api.userExample.v1.userExampleService/GetByID
func WithLogIgnoreMethods(fullMethodNames ...string) LogOption {
return func(o *logOptions) {
for _, method := range fullMethodNames {
o.ignoreMethods[method] = struct{}{}
}
}
}
// UnaryServerLog 服务端日志unary拦截器
func UnaryServerLog(logger *zap.Logger, opts ...LogOption) grpc.UnaryServerInterceptor {
o := defaultLogOptions()
o.apply(opts...)
ignoreLogMethods = o.ignoreMethods
if logger == nil {
logger, _ = zap.NewProduction()
}
grpc_zap.ReplaceGrpcLoggerV2(logger)
// 日志设置,默认打印客户端断开连接信息,示例 https://pkg.go.dev/github.com/grpc-ecosystem/go-grpc-middleware/logging/zap
zapOptions := []grpc_zap.Option{
grpc_zap.WithDurationField(func(duration time.Duration) zapcore.Field {
return zap.Int64("grpc.time_us", duration.Microseconds()) // 默认打印耗时字段
}),
}
// 自定义打印字段
for key, val := range o.fields {
zapOptions = append(zapOptions, grpc_zap.WithDurationField(func(duration time.Duration) zapcore.Field {
return zap.Any(key, val)
}))
}
// 自定义跳过打印日志的调用方法
if len(ignoreLogMethods) > 0 {
zapOptions = append(zapOptions, grpc_zap.WithDecider(func(fullMethodName string, err error) bool {
if err == nil {
if _, ok := ignoreLogMethods[fullMethodName]; ok {
return false
}
}
return true
}))
}
return grpc_zap.UnaryServerInterceptor(logger, zapOptions...)
}
// UnaryServerCtxTags extractor field unary拦截器
func UnaryServerCtxTags() grpc.UnaryServerInterceptor {
return grpc_ctxtags.UnaryServerInterceptor(grpc_ctxtags.WithFieldExtractor(grpc_ctxtags.CodeGenRequestFieldExtractor))
}
// StreamServerLog 服务端日志stream拦截器
func StreamServerLog(logger *zap.Logger, opts ...LogOption) grpc.StreamServerInterceptor {
o := defaultLogOptions()
o.apply(opts...)
ignoreLogMethods = o.ignoreMethods
if logger == nil {
logger, _ = zap.NewProduction()
}
grpc_zap.ReplaceGrpcLoggerV2(logger)
// 日志设置,默认打印客户端断开连接信息,示例 https://pkg.go.dev/github.com/grpc-ecosystem/go-grpc-middleware/logging/zap
zapOptions := []grpc_zap.Option{
grpc_zap.WithDurationField(func(duration time.Duration) zapcore.Field {
return zap.Int64("grpc.time_us", duration.Microseconds()) // 默认打印耗时字段
}),
}
// 自定义打印字段
for key, val := range o.fields {
zapOptions = append(zapOptions, grpc_zap.WithDurationField(func(duration time.Duration) zapcore.Field {
return zap.Any(key, val)
}))
}
// 自定义跳过打印日志的调用方法
if len(ignoreLogMethods) > 0 {
zapOptions = append(zapOptions, grpc_zap.WithDecider(func(fullMethodName string, err error) bool {
if err == nil {
if _, ok := ignoreLogMethods[fullMethodName]; ok {
return false
}
}
return true
}))
}
return grpc_zap.StreamServerInterceptor(logger, zapOptions...)
}
// StreamServerCtxTags extractor field stream拦截器
func StreamServerCtxTags() grpc.StreamServerInterceptor {
return grpc_ctxtags.StreamServerInterceptor(grpc_ctxtags.WithFieldExtractor(grpc_ctxtags.CodeGenRequestFieldExtractor))
}