forked from ego-component/egorm
/
interceptor.go
213 lines (189 loc) · 6.44 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
package egorm
import (
"context"
"errors"
"fmt"
"log"
"runtime"
"strconv"
"strings"
"time"
"github.com/gotomicro/ego/core/eapp"
"github.com/gotomicro/ego/core/elog"
"github.com/gotomicro/ego/core/emetric"
"github.com/gotomicro/ego/core/etrace"
"github.com/gotomicro/ego/core/transport"
"github.com/gotomicro/ego/core/util/xdebug"
"github.com/spf13/cast"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/codes"
semconv "go.opentelemetry.io/otel/semconv/v1.7.0"
"go.opentelemetry.io/otel/trace"
"gorm.io/gorm"
"github.com/auforever/egorm/manager"
)
// Handler ...
type Handler func(*gorm.DB)
// Processor ...
type Processor interface {
Get(name string) func(*gorm.DB)
Replace(name string, handler func(*gorm.DB)) error
}
// Interceptor ...
type Interceptor func(string, *manager.DSN, string, *config, *elog.Component) func(next Handler) Handler
func debugInterceptor(compName string, dsn *manager.DSN, _ string, _ *config, _ *elog.Component) func(Handler) Handler {
return func(next Handler) Handler {
return func(db *gorm.DB) {
if !eapp.IsDevelopmentMode() {
next(db)
return
}
beg := time.Now()
next(db)
cost := time.Since(beg)
if db.Error != nil {
log.Println("[egorm.response]",
xdebug.MakeReqAndResError(fileWithLineNum(), compName, fmt.Sprintf("%v", dsn.Addr+"/"+dsn.DBName), cost, logSQL(db, true), db.Error.Error()),
)
} else {
log.Println("[egorm.response]",
xdebug.MakeReqAndResInfo(fileWithLineNum(), compName, fmt.Sprintf("%v", dsn.Addr+"/"+dsn.DBName), cost, logSQL(db, true), fmt.Sprintf("%v", db.Statement.Dest)),
)
}
}
}
}
func metricInterceptor(compName string, dsn *manager.DSN, op string, config *config, logger *elog.Component) func(Handler) Handler {
return func(next Handler) Handler {
return func(db *gorm.DB) {
beg := time.Now()
next(db)
cost := time.Since(beg)
loggerKeys := transport.CustomContextKeys()
var fields = make([]elog.Field, 0, 15+len(loggerKeys))
fields = append(fields,
elog.FieldMethod(op),
elog.FieldName(dsn.DBName+"."+db.Statement.Table), elog.FieldCost(cost))
if config.EnableAccessInterceptorReq {
fields = append(fields, elog.String("req", logSQL(db, config.EnableDetailSQL)))
}
if config.EnableAccessInterceptorRes {
fields = append(fields, elog.Any("res", db.Statement.Dest))
}
// 开启了链路,那么就记录链路id
if config.EnableTraceInterceptor && etrace.IsGlobalTracerRegistered() {
fields = append(fields, elog.FieldTid(etrace.ExtractTraceID(db.Statement.Context)))
}
// 支持自定义log
for _, key := range loggerKeys {
if value := getContextValue(db.Statement.Context, key); value != "" {
fields = append(fields, elog.FieldCustomKeyValue(key, value))
}
}
// 记录监控耗时
emetric.ClientHandleHistogram.WithLabelValues(emetric.TypeGorm, compName, dsn.DBName+"."+db.Statement.Table, dsn.Addr).Observe(cost.Seconds())
// 如果有慢日志,就记录
if config.SlowLogThreshold > time.Duration(0) && config.SlowLogThreshold < cost {
logger.Warn("slow", fields...)
}
// 如果有错误,记录错误信息
if db.Error != nil {
fields = append(fields, elog.FieldEvent("error"), elog.FieldErr(db.Error))
if errors.Is(db.Error, ErrRecordNotFound) {
logger.Warn("access", fields...)
emetric.ClientHandleCounter.Inc(emetric.TypeGorm, compName, dsn.DBName+"."+db.Statement.Table, dsn.Addr, "Empty")
return
}
logger.Error("access", fields...)
emetric.ClientHandleCounter.Inc(emetric.TypeGorm, compName, dsn.DBName+"."+db.Statement.Table, dsn.Addr, "Error")
return
}
emetric.ClientHandleCounter.Inc(emetric.TypeGorm, compName, dsn.DBName+"."+db.Statement.Table, dsn.Addr, "OK")
// 开启了记录日志信息,那么就记录access
// event normal和error,代表全部access的请求数
if config.EnableAccessInterceptor {
fields = append(fields,
elog.FieldEvent("normal"),
)
logger.Info("access", fields...)
}
}
}
}
func logSQL(db *gorm.DB, enableDetailSQL bool) string {
if enableDetailSQL {
return db.Explain(db.Statement.SQL.String(), db.Statement.Vars...)
}
return db.Statement.SQL.String()
}
func traceInterceptor(compName string, dsn *manager.DSN, _ string, options *config, _ *elog.Component) func(Handler) Handler {
ip, port := peerInfo(dsn.Addr)
attrs := []attribute.KeyValue{
semconv.NetHostIPKey.String(ip),
semconv.NetPeerPortKey.Int(port),
semconv.NetTransportKey.String(dsn.Net),
semconv.DBNameKey.String(dsn.DBName),
attribute.String("db.component_name", compName),
}
tracer := etrace.NewTracer(trace.SpanKindClient)
return func(next Handler) Handler {
return func(db *gorm.DB) {
if db.Statement.Context != nil {
operation := "gorm:"
if len(db.Statement.BuildClauses) > 0 {
operation += strings.ToLower(db.Statement.BuildClauses[0])
}
_, span := tracer.Start(db.Statement.Context, operation, nil, trace.WithAttributes(attrs...))
defer span.End()
next(db)
span.SetAttributes(
semconv.DBSystemKey.String(db.Dialector.Name()),
semconv.DBStatementKey.String(logSQL(db, options.EnableDetailSQL)),
semconv.DBOperationKey.String(operation),
semconv.DBSQLTableKey.String(db.Statement.Table),
semconv.NetPeerNameKey.String(dsn.Addr),
attribute.Int64("db.rows_affected", db.RowsAffected),
)
var err = db.Error
if !options.TraceRecordErrorOnNotFound && errors.Is(err, gorm.ErrRecordNotFound) {
err = nil
}
if err != nil {
span.RecordError(db.Error)
span.SetStatus(codes.Error, db.Error.Error())
return
}
span.SetStatus(codes.Ok, "OK")
return
}
next(db)
}
}
}
func getContextValue(c context.Context, key string) string {
if key == "" {
return ""
}
return cast.ToString(transport.Value(c, key))
}
// todo ipv6
func peerInfo(addr string) (hostname string, port int) {
if idx := strings.IndexByte(addr, ':'); idx >= 0 {
hostname = addr[:idx]
port, _ = strconv.Atoi(addr[idx+1:])
}
return hostname, port
}
func fileWithLineNum() string {
// the second caller usually from internal, so set i start from 2
for i := 3; i < 15; i++ {
_, file, line, ok := runtime.Caller(i)
if !ok {
break
}
if (!(strings.Contains(file, "ego-component/egorm") && strings.HasSuffix(file, "interceptor.go")) && !strings.Contains(file, "gorm.io/gorm")) || strings.HasSuffix(file, "_test.go") {
return file + ":" + strconv.FormatInt(int64(line), 10)
}
}
return ""
}