-
Notifications
You must be signed in to change notification settings - Fork 27
/
Copy pathtracer.go
271 lines (257 loc) · 7.2 KB
/
tracer.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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
package proxy
import (
"bytes"
"context"
"database/sql/driver"
"fmt"
"io"
"sync"
"time"
)
// Outputter is what is used by the tracing proxy created via `NewTraceProxy`.
// Anything that implements a `log.Logger` style `Output` method will satisfy
// this interface.
type Outputter interface {
Output(calldepth int, s string) error
}
// Filter is used by the tracing proxy for skipping database libraries (e.g. O/R mapper).
type Filter interface {
DoOutput(packageName string) bool
}
// PackageFilter is an implementation of Filter.
type PackageFilter map[string]struct{}
// DoOutput returns false if the package is in the ignored list.
func (f PackageFilter) DoOutput(packageName string) bool {
_, ok := f[packageName]
return !ok
}
// Ignore add the package into the ignored list.
func (f PackageFilter) Ignore(packageName string) {
f[packageName] = struct{}{}
}
// DefaultPackageFilter ignores some database util package.
var DefaultPackageFilter = PackageFilter{
"database/sql": struct{}{},
"github.com/shogo82148/go-sql-proxy": struct{}{},
}
// TracerOptions holds the tracing option.
type TracerOptions struct {
// Outputter is the output of the log.
// If is nil nil, log.Output is used.
Outputter Outputter
// Filter is used by the tracing proxy for skipping database libraries (e.g. O/R mapper).
// If it is nil, DefaultPackageFilter is used.
Filter Filter
// SlowQuery is a threshold duration to output into log.
// output all queries if SlowQuery is zero.
SlowQuery time.Duration
}
// NewTraceProxy generates a proxy that logs queries.
func NewTraceProxy(d driver.Driver, o Outputter) *Proxy {
return NewProxyContext(d, NewTraceHooks(TracerOptions{
Outputter: o,
}))
}
// NewTraceProxyWithFilter generates a proxy that logs queries.
func NewTraceProxyWithFilter(d driver.Driver, o Outputter, f Filter) *Proxy {
return NewProxyContext(d, NewTraceHooks(TracerOptions{
Outputter: o,
Filter: f,
}))
}
// NewTraceHooks creates new HooksContext which trace SQL queries.
func NewTraceHooks(opt TracerOptions) *HooksContext {
f := opt.Filter
if f == nil {
f = DefaultPackageFilter
}
o := opt.Outputter
if o == nil {
o = logger{}
}
pool := &sync.Pool{
New: func() interface{} {
return &bytes.Buffer{}
},
}
return &HooksContext{
PreOpen: func(_ context.Context, _ string) (interface{}, error) {
return time.Now(), nil
},
PostOpen: func(_ context.Context, ctx interface{}, conn *Conn, err error) error {
d := time.Since(ctx.(time.Time))
if d < opt.SlowQuery {
return nil
}
buf := pool.Get().(*bytes.Buffer)
buf.Reset()
if conn != nil {
fmt.Fprintf(buf, "Open %p", conn.Conn)
} else {
fmt.Fprint(buf, "Open nil")
}
if err != nil {
fmt.Fprintf(buf, "; err = %#v", err.Error())
}
io.WriteString(buf, " (")
io.WriteString(buf, d.String())
io.WriteString(buf, ")")
s := buf.String()
pool.Put(buf)
o.Output(findCaller(f), s)
return nil
},
PreExec: func(_ context.Context, _ *Stmt, _ []driver.NamedValue) (interface{}, error) {
return time.Now(), nil
},
PostExec: func(_ context.Context, ctx interface{}, stmt *Stmt, args []driver.NamedValue, _ driver.Result, err error) error {
d := time.Since(ctx.(time.Time))
if d < opt.SlowQuery {
return nil
}
buf := pool.Get().(*bytes.Buffer)
buf.Reset()
fmt.Fprintf(buf, "Exec %p: ", stmt.Conn.Conn)
io.WriteString(buf, stmt.QueryString)
io.WriteString(buf, "; args = [")
writeNamedValues(buf, args)
io.WriteString(buf, "]")
if err != nil {
fmt.Fprintf(buf, "; err = %#v", err.Error())
}
io.WriteString(buf, " (")
io.WriteString(buf, d.String())
io.WriteString(buf, ")")
s := buf.String()
pool.Put(buf)
o.Output(findCaller(f), s)
return nil
},
PreQuery: func(_ context.Context, stmt *Stmt, args []driver.NamedValue) (interface{}, error) {
return time.Now(), nil
},
PostQuery: func(_ context.Context, ctx interface{}, stmt *Stmt, args []driver.NamedValue, _ driver.Rows, err error) error {
d := time.Since(ctx.(time.Time))
if d < opt.SlowQuery {
return nil
}
buf := pool.Get().(*bytes.Buffer)
buf.Reset()
fmt.Fprintf(buf, "Query %p: ", stmt.Conn.Conn)
io.WriteString(buf, stmt.QueryString)
io.WriteString(buf, "; args = [")
writeNamedValues(buf, args)
io.WriteString(buf, "]")
if err != nil {
fmt.Fprintf(buf, "; err = %#v", err.Error())
}
io.WriteString(buf, " (")
io.WriteString(buf, d.String())
io.WriteString(buf, ")")
s := buf.String()
pool.Put(buf)
o.Output(findCaller(f), s)
return nil
},
PreBegin: func(_ context.Context, _ *Conn) (interface{}, error) {
return time.Now(), nil
},
PostBegin: func(_ context.Context, ctx interface{}, conn *Conn, err error) error {
d := time.Since(ctx.(time.Time))
if d < opt.SlowQuery {
return nil
}
buf := pool.Get().(*bytes.Buffer)
buf.Reset()
fmt.Fprintf(buf, "Begin %p", conn.Conn)
if err != nil {
fmt.Fprintf(buf, "; err = %#v", err.Error())
}
io.WriteString(buf, " (")
io.WriteString(buf, d.String())
io.WriteString(buf, ")")
s := buf.String()
pool.Put(buf)
o.Output(findCaller(f), s)
return nil
},
PreCommit: func(_ context.Context, _ *Tx) (interface{}, error) {
return time.Now(), nil
},
PostCommit: func(_ context.Context, ctx interface{}, tx *Tx, err error) error {
d := time.Since(ctx.(time.Time))
if d < opt.SlowQuery {
return nil
}
buf := pool.Get().(*bytes.Buffer)
buf.Reset()
fmt.Fprintf(buf, "Commit %p", tx.Conn.Conn)
if err != nil {
fmt.Fprintf(buf, "; err = %#v", err.Error())
}
io.WriteString(buf, " (")
io.WriteString(buf, d.String())
io.WriteString(buf, ")")
s := buf.String()
pool.Put(buf)
o.Output(findCaller(f), s)
return nil
},
PreRollback: func(_ context.Context, _ *Tx) (interface{}, error) {
return time.Now(), nil
},
PostRollback: func(_ context.Context, ctx interface{}, tx *Tx, err error) error {
d := time.Since(ctx.(time.Time))
if d < opt.SlowQuery {
return nil
}
buf := pool.Get().(*bytes.Buffer)
buf.Reset()
fmt.Fprintf(buf, "Rollback %p", tx.Conn.Conn)
if err != nil {
fmt.Fprintf(buf, "; err = %#v", err.Error())
}
io.WriteString(buf, " (")
io.WriteString(buf, d.String())
io.WriteString(buf, ")")
s := buf.String()
pool.Put(buf)
o.Output(findCaller(f), s)
return nil
},
PreClose: func(_ context.Context, _ *Conn) (interface{}, error) {
return time.Now(), nil
},
PostClose: func(_ context.Context, ctx interface{}, conn *Conn, err error) error {
d := time.Since(ctx.(time.Time))
if d < opt.SlowQuery {
return nil
}
buf := pool.Get().(*bytes.Buffer)
buf.Reset()
fmt.Fprintf(buf, "Close %p", conn.Conn)
if err != nil {
fmt.Fprintf(buf, "; err = %#v", err.Error())
}
io.WriteString(buf, " (")
io.WriteString(buf, d.String())
io.WriteString(buf, ")")
s := buf.String()
pool.Put(buf)
o.Output(findCaller(f), s)
return nil
},
}
}
func writeNamedValues(w io.Writer, args []driver.NamedValue) {
for i, arg := range args {
if i != 0 {
io.WriteString(w, ", ")
}
if len(arg.Name) > 0 {
io.WriteString(w, arg.Name)
io.WriteString(w, ":")
}
fmt.Fprintf(w, "%#v", arg.Value)
}
}