-
Notifications
You must be signed in to change notification settings - Fork 701
/
interceptor.go
255 lines (224 loc) · 8.87 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
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
// Copyright 2020 Douyu
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package grpc
import (
"context"
"encoding/json"
"errors"
"fmt"
"time"
"github.com/alibaba/sentinel-golang/api"
"github.com/alibaba/sentinel-golang/core/base"
"github.com/douyu/jupiter/pkg"
"github.com/douyu/jupiter/pkg/core/ecode"
"github.com/douyu/jupiter/pkg/core/metric"
"github.com/douyu/jupiter/pkg/core/sentinel"
"github.com/douyu/jupiter/pkg/core/xtrace"
"github.com/douyu/jupiter/pkg/util/xstring"
"github.com/douyu/jupiter/pkg/xlog"
"github.com/fatih/color"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/codes"
semconv "go.opentelemetry.io/otel/semconv/v1.12.0"
"go.opentelemetry.io/otel/trace"
"google.golang.org/grpc"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/peer"
)
var (
errSlowCommand = errors.New("grpc unary slow command")
)
// metric统计
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 {
// 只记录系统级别的详细错误码
metric.ClientHandleCounter.Inc(metric.TypeGRPCUnary, name, method, cc.Target(), spbStatus.GetMessage())
metric.ClientHandleHistogram.Observe(time.Since(beg).Seconds(), metric.TypeGRPCUnary, name, method, cc.Target())
} else {
metric.ClientHandleCounter.Inc(metric.TypeGRPCUnary, name, method, cc.Target(), "biz error")
metric.ClientHandleHistogram.Observe(time.Since(beg).Seconds(), metric.TypeGRPCUnary, name, method, cc.Target())
}
return err
}
}
// 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)
// metric.ClientHandleCounter.Inc(metric.TypeGRPCStream, name, method, cc.Target(), codes.GetMessage())
// metric.ClientHandleHistogram.Observe(time.Since(beg).Seconds(), metric.TypeGRPCStream, name, method, cc.Target())
// return clientStream, err
// }
// }
func sentinelUnaryClientInterceptor(name string) grpc.UnaryClientInterceptor {
return func(ctx context.Context, method string, req, reply interface{},
cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
entry, blockerr := sentinel.Entry(name,
api.WithResourceType(base.ResTypeRPC),
api.WithTrafficType(base.Outbound))
if blockerr != nil {
return blockerr
}
err := invoker(ctx, method, req, reply, cc, opts...)
entry.Exit(base.WithError(err))
return err
}
}
func debugUnaryClientInterceptor(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() + ")"
}
fmt.Printf("%-50s[%s] => %s\n", color.GreenString(prefix), time.Now().Format("04:05.000"), color.GreenString("Send: "+method+" | "+xstring.Json(req)))
err := invoker(ctx, method, req, reply, cc, append(opts, grpc.Peer(&p))...)
if err != nil {
fmt.Printf("%-50s[%s] => %s\n", color.RedString(prefix), time.Now().Format("04:05.000"), color.RedString("Erro: "+err.Error()))
} else {
fmt.Printf("%-50s[%s] => %s\n", color.GreenString(prefix), time.Now().Format("04:05.000"), color.GreenString("Recv: "+xstring.Json(reply)))
}
return err
}
}
func TraceUnaryClientInterceptor() grpc.UnaryClientInterceptor {
tracer := xtrace.NewTracer(trace.SpanKindClient)
attrs := []attribute.KeyValue{
semconv.RPCSystemGRPC,
}
return func(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) (err error) {
md, ok := metadata.FromOutgoingContext(ctx)
if !ok {
md = metadata.New(nil)
} else {
md = md.Copy()
}
ctx, span := tracer.Start(ctx, method, xtrace.MetadataReaderWriter(md), trace.WithAttributes(attrs...))
ctx = metadata.NewOutgoingContext(ctx, md)
span.SetAttributes(
semconv.RPCMethodKey.String(method),
)
err = invoker(ctx, method, req, reply, cc, opts...)
span.SetStatus(codes.Ok, "ok")
if err != nil {
span.RecordError(err)
span.SetStatus(codes.Error, err.Error())
}
span.End()
return err
}
}
func aidUnaryClientInterceptor() 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)
clientAidMD := metadata.Pairs("aid", pkg.AppID())
if ok {
md = metadata.Join(md, clientAidMD)
} else {
md = clientAidMD
}
ctx = metadata.NewOutgoingContext(ctx, md)
return invoker(ctx, method, req, reply, cc, opts...)
}
}
// timeoutUnaryClientInterceptor gRPC客户端超时拦截器
func timeoutUnaryClientInterceptor(_logger *xlog.Logger, 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 {
now := time.Now()
// 若无自定义超时设置,默认设置超时
_, ok := ctx.Deadline()
if !ok {
var cancel context.CancelFunc
ctx, cancel = context.WithTimeout(ctx, timeout)
defer cancel()
}
err := invoker(ctx, method, req, reply, cc, opts...)
du := time.Since(now)
remoteIP := "unknown"
if remote, ok := peer.FromContext(ctx); ok && remote.Addr != nil {
remoteIP = remote.Addr.String()
}
if slowThreshold > time.Duration(0) && du > slowThreshold {
_logger.Error("slow",
xlog.FieldErr(errSlowCommand),
xlog.FieldMethod(method),
xlog.FieldName(cc.Target()),
xlog.FieldCost(du),
xlog.FieldAddr(remoteIP),
)
}
return err
}
}
// loggerUnaryClientInterceptor gRPC客户端日志中间件
func loggerUnaryClientInterceptor(_logger *xlog.Logger, name string, accessInterceptorLevel string) grpc.UnaryClientInterceptor {
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...)
spbStatus := ecode.ExtractCodes(err)
if err != nil {
// 只记录系统级别错误
if spbStatus.Code < ecode.EcodeNum {
// 只记录系统级别错误
_logger.Error(
"access",
xlog.FieldType("unary"),
xlog.FieldCode(spbStatus.Code),
xlog.FieldStringErr(spbStatus.Message),
xlog.FieldName(name),
xlog.FieldMethod(method),
xlog.FieldCost(time.Since(beg)),
xlog.Any("req", json.RawMessage(xstring.Json(req))),
xlog.Any("reply", json.RawMessage(xstring.Json(reply))),
)
} else {
// 业务报错只做warning
_logger.Warn(
"access",
xlog.FieldType("unary"),
xlog.FieldCode(spbStatus.Code),
xlog.FieldStringErr(spbStatus.Message),
xlog.FieldName(name),
xlog.FieldMethod(method),
xlog.FieldCost(time.Since(beg)),
xlog.Any("req", json.RawMessage(xstring.Json(req))),
xlog.Any("reply", json.RawMessage(xstring.Json(reply))),
)
}
return err
} else {
if accessInterceptorLevel == "info" {
_logger.Info(
"access",
xlog.FieldType("unary"),
xlog.FieldCode(spbStatus.Code),
xlog.FieldName(name),
xlog.FieldMethod(method),
xlog.FieldCost(time.Since(beg)),
xlog.Any("req", json.RawMessage(xstring.Json(req))),
xlog.Any("reply", json.RawMessage(xstring.Json(reply))),
)
}
}
return nil
}
}