-
-
Notifications
You must be signed in to change notification settings - Fork 158
/
interceptor.go
202 lines (180 loc) · 7.52 KB
/
interceptor.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
package egrpc
import (
"context"
"encoding/json"
"fmt"
"log"
"time"
"github.com/opentracing/opentracing-go"
"github.com/opentracing/opentracing-go/ext"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/peer"
"google.golang.org/grpc/status"
"github.com/gotomicro/ego/core/eapp"
"github.com/gotomicro/ego/core/ecode"
"github.com/gotomicro/ego/core/elog"
"github.com/gotomicro/ego/core/emetric"
"github.com/gotomicro/ego/core/etrace"
"github.com/gotomicro/ego/core/util/xdebug"
"github.com/gotomicro/ego/core/util/xstring"
)
// metricUnaryClientInterceptor returns grpc unary request metrics collector interceptor
func metricUnaryClientInterceptor(name string) func(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
return func(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
beg := time.Now()
err := invoker(ctx, method, req, reply, cc, opts...)
// 收敛err错误,将err过滤后,可以知道err是否为系统错误码
spbStatus := ecode.ExtractCodes(err)
// 只记录系统级别错误
if spbStatus.Code < ecode.EcodeNum {
// 只记录系统级别的详细错误码
emetric.ClientHandleCounter.Inc(emetric.TypeGRPCUnary, name, method, cc.Target(), spbStatus.GetMessage())
emetric.ClientHandleHistogram.Observe(time.Since(beg).Seconds(), emetric.TypeGRPCUnary, name, method, cc.Target())
} else {
emetric.ClientHandleCounter.Inc(emetric.TypeGRPCUnary, name, method, cc.Target(), "biz error")
emetric.ClientHandleHistogram.Observe(time.Since(beg).Seconds(), emetric.TypeGRPCUnary, name, method, cc.Target())
}
return err
}
}
// metricStreamClientInterceptor returns grpc stream request metrics collector interceptor
func metricStreamClientInterceptor(name string) func(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string, streamer grpc.Streamer, opts ...grpc.CallOption) (grpc.ClientStream, error) {
return func(ctx context.Context, desc *grpc.StreamDesc, cc *grpc.ClientConn, method string, streamer grpc.Streamer, opts ...grpc.CallOption) (grpc.ClientStream, error) {
beg := time.Now()
clientStream, err := streamer(ctx, desc, cc, method, opts...)
// 暂时用默认的grpc的默认err收敛
codes := ecode.ExtractCodes(err)
emetric.ClientHandleCounter.Inc(emetric.TypeGRPCStream, name, method, cc.Target(), codes.GetMessage())
emetric.ClientHandleHistogram.Observe(time.Since(beg).Seconds(), emetric.TypeGRPCStream, name, method, cc.Target())
return clientStream, err
}
}
// debugUnaryClientInterceptor returns grpc unary request request and response details interceptor
func debugUnaryClientInterceptor(logger *elog.Component, compName, addr string) grpc.UnaryClientInterceptor {
return func(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
var p peer.Peer
prefix := fmt.Sprintf("[%s]", addr)
if remote, ok := peer.FromContext(ctx); ok && remote.Addr != nil {
prefix = prefix + "(" + remote.Addr.String() + ")"
}
beg := time.Now()
err := invoker(ctx, method, req, reply, cc, append(opts, grpc.Peer(&p))...)
cost := time.Since(beg)
if eapp.IsDevelopmentMode() {
if err != nil {
log.Println("grpc.response", xdebug.MakeReqResError(compName, addr, cost, method+" | "+fmt.Sprintf("%v", req), err.Error()))
} else {
log.Println("grpc.response", xdebug.MakeReqResInfo(compName, addr, cost, method+" | "+fmt.Sprintf("%v", req), reply))
}
} else {
// todo log
}
return err
}
}
// traceUnaryClientInterceptor returns grpc unary opentracing interceptor
func traceUnaryClientInterceptor() grpc.UnaryClientInterceptor {
return func(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
md, ok := metadata.FromOutgoingContext(ctx)
if !ok {
md = metadata.New(nil)
} else {
md = md.Copy()
}
span, ctx := etrace.StartSpanFromContext(
ctx,
method,
etrace.TagSpanKind("client"),
etrace.TagComponent("grpc"),
)
defer span.Finish()
err := invoker(etrace.MetadataInjector(ctx, md), method, req, reply, cc, opts...)
if err != nil {
code := codes.Unknown
if s, ok := status.FromError(err); ok {
code = s.Code()
}
span.SetTag("response_code", code)
ext.Error.Set(span, true)
span.LogFields(etrace.String("event", "error"), etrace.String("message", err.Error()))
}
return err
}
}
// appNameUnaryClientInterceptor returns interceptor inject app name
func appNameUnaryClientInterceptor() grpc.UnaryClientInterceptor {
return func(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
md, ok := metadata.FromOutgoingContext(ctx)
clientAppName := metadata.Pairs("app", eapp.Name())
if ok {
md = metadata.Join(md, clientAppName)
} else {
md = clientAppName
}
ctx = metadata.NewOutgoingContext(ctx, md)
return invoker(ctx, method, req, reply, cc, opts...)
}
}
// timeoutUnaryClientInterceptor settings timeout
func timeoutUnaryClientInterceptor(_logger *elog.Component, timeout time.Duration, slowThreshold time.Duration) grpc.UnaryClientInterceptor {
return func(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
// 若无自定义超时设置,默认设置超时
_, ok := ctx.Deadline()
if !ok {
var cancel context.CancelFunc
ctx, cancel = context.WithTimeout(ctx, timeout)
defer cancel()
}
return invoker(ctx, method, req, reply, cc, opts...)
}
}
// loggerUnaryClientInterceptor returns log interceptor for logging
func loggerUnaryClientInterceptor(_logger *elog.Component, config *Config) grpc.UnaryClientInterceptor {
return func(ctx context.Context, method string, req, res interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
beg := time.Now()
err := invoker(ctx, method, req, res, cc, opts...)
cost := time.Since(beg)
spbStatus := ecode.ExtractCodes(err)
var fields = make([]elog.Field, 0, 15)
fields = append(fields,
elog.FieldType("unary"),
elog.FieldCode(spbStatus.Code),
elog.FieldDescription(spbStatus.Message),
elog.FieldMethod(method),
elog.FieldCost(cost),
elog.FieldName(cc.Target()),
)
// 开启了链路,那么就记录链路id
if config.EnableTraceInterceptor && opentracing.IsGlobalTracerRegistered() {
fields = append(fields, elog.FieldTid(etrace.ExtractTraceID(ctx)))
}
if config.EnableAccessInterceptorReq {
fields = append(fields, elog.Any("req", json.RawMessage(xstring.JSON(req))))
}
if config.EnableAccessInterceptorRes {
fields = append(fields, elog.Any("res", json.RawMessage(xstring.JSON(res))))
}
if config.SlowLogThreshold > time.Duration(0) && cost > config.SlowLogThreshold {
_logger.Warn("slow", fields...)
}
if err != nil {
fields = append(fields, elog.FieldEvent("error"), elog.FieldErr(err))
// 只记录系统级别错误
if spbStatus.Code < ecode.EcodeNum {
// 只记录系统级别错误
_logger.Error("access", fields...)
return err
}
// 业务报错只做warning
_logger.Warn("access", fields...)
return err
}
if config.EnableAccessInterceptor {
fields = append(fields, elog.FieldEvent("normal"))
_logger.Info("access", fields...)
}
return nil
}
}