forked from DataDog/dd-trace-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sqltraced.go
384 lines (321 loc) · 9.27 KB
/
sqltraced.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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
// Package sqltraced provides a traced version of any driver implementing the database/sql/driver interface.
// To trace jmoiron/sqlx, see https://godoc.org/github.com/DataDog/dd-trace-go/tracer/contrib/sqlxtraced.
package sqltraced
import (
"context"
"database/sql"
"database/sql/driver"
"fmt"
log "github.com/cihub/seelog"
"github.com/DataDog/dd-trace-go/tracer"
"github.com/DataDog/dd-trace-go/tracer/contrib/sqltraced/sqlutils"
"github.com/DataDog/dd-trace-go/tracer/ext"
)
// OpenTraced will first register the traced version of the `driver` if not yet registered and will then open a connection with it.
// This is usually the only function to use when there is no need for the granularity offered by Register and Open.
// The last parameter is optional and enables you to use a custom tracer.
func OpenTraced(driver driver.Driver, dataSourceName, service string, trcv ...*tracer.Tracer) (*sql.DB, error) {
driverName := sqlutils.GetDriverName(driver)
Register(driverName, driver, trcv...)
return Open(driverName, dataSourceName, service)
}
// Register takes a driver and registers a traced version of this one.
// The last parameter is optional and enables you to use a custom tracer.
func Register(driverName string, driver driver.Driver, trcv ...*tracer.Tracer) {
if driver == nil {
log.Error("RegisterTracedDriver: driver is nil")
return
}
var trc *tracer.Tracer
if len(trcv) == 0 || (len(trcv) > 0 && trcv[0] == nil) {
trc = tracer.DefaultTracer
} else {
trc = trcv[0]
}
tracedDriverName := sqlutils.GetTracedDriverName(driverName)
if !stringInSlice(sql.Drivers(), tracedDriverName) {
td := tracedDriver{
Driver: driver,
tracer: trc,
driverName: driverName,
}
sql.Register(tracedDriverName, td)
log.Infof("Register %s driver", tracedDriverName)
} else {
log.Warnf("RegisterTracedDriver: %s already registered", tracedDriverName)
}
}
// Open extends the usual API of sql.Open so you can specify the name of the service
// under which the traces will appear in the datadog app.
func Open(driverName, dataSourceName, service string) (*sql.DB, error) {
tracedDriverName := sqlutils.GetTracedDriverName(driverName)
// The service is passed through the DSN
dsnAndService := newDSNAndService(dataSourceName, service)
return sql.Open(tracedDriverName, dsnAndService)
}
// tracedDriver is a driver we use as a middleware between the database/sql package
// and the driver chosen (e.g. mysql, postgresql...).
// It implements the driver.Driver interface and add the tracing features on top
// of the driver's methods.
type tracedDriver struct {
driver.Driver
tracer *tracer.Tracer
driverName string
}
// Open returns a tracedConn so that we can pass all the info we get from the DSN
// all along the tracing
func (td tracedDriver) Open(dsnAndService string) (c driver.Conn, err error) {
var meta map[string]string
var conn driver.Conn
dsn, service := parseDSNAndService(dsnAndService)
// Register the service to Datadog tracing API
td.tracer.SetServiceInfo(service, td.driverName, ext.AppTypeDB)
// Get all kinds of information from the DSN
meta, err = parseDSN(td.driverName, dsn)
if err != nil {
return nil, err
}
conn, err = td.Driver.Open(dsn)
if err != nil {
return nil, err
}
ti := traceInfo{
tracer: td.tracer,
driverName: td.driverName,
service: service,
meta: meta,
}
return &tracedConn{conn, ti}, err
}
// traceInfo stores all information relative to the tracing
type traceInfo struct {
tracer *tracer.Tracer
driverName string
service string
resource string
meta map[string]string
}
func (ti traceInfo) getSpan(ctx context.Context, resource string, query ...string) *tracer.Span {
name := fmt.Sprintf("%s.%s", ti.driverName, "query")
span := ti.tracer.NewChildSpanFromContext(name, ctx)
span.Type = ext.SQLType
span.Service = ti.service
span.Resource = resource
if len(query) > 0 {
span.Resource = query[0]
span.SetMeta(ext.SQLQuery, query[0])
}
for k, v := range ti.meta {
span.SetMeta(k, v)
}
return span
}
type tracedConn struct {
driver.Conn
traceInfo
}
func (tc tracedConn) BeginTx(ctx context.Context, opts driver.TxOptions) (tx driver.Tx, err error) {
span := tc.getSpan(ctx, "Begin")
defer func() {
span.SetError(err)
span.Finish()
}()
if connBeginTx, ok := tc.Conn.(driver.ConnBeginTx); ok {
tx, err = connBeginTx.BeginTx(ctx, opts)
if err != nil {
return nil, err
}
return tracedTx{tx, tc.traceInfo, ctx}, nil
}
tx, err = tc.Conn.Begin()
if err != nil {
return nil, err
}
return tracedTx{tx, tc.traceInfo, ctx}, nil
}
func (tc tracedConn) PrepareContext(ctx context.Context, query string) (stmt driver.Stmt, err error) {
span := tc.getSpan(ctx, "Prepare", query)
defer func() {
span.SetError(err)
span.Finish()
}()
// Check if the driver implements PrepareContext
if connPrepareCtx, ok := tc.Conn.(driver.ConnPrepareContext); ok {
stmt, err := connPrepareCtx.PrepareContext(ctx, query)
if err != nil {
return nil, err
}
return tracedStmt{stmt, tc.traceInfo, ctx, query}, nil
}
// If the driver does not implement PrepareContex (lib/pq for example)
stmt, err = tc.Prepare(query)
if err != nil {
return nil, err
}
return tracedStmt{stmt, tc.traceInfo, ctx, query}, nil
}
func (tc tracedConn) Exec(query string, args []driver.Value) (driver.Result, error) {
if execer, ok := tc.Conn.(driver.Execer); ok {
return execer.Exec(query, args)
}
return nil, driver.ErrSkip
}
func (tc tracedConn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (r driver.Result, err error) {
span := tc.getSpan(ctx, "Exec", query)
defer func() {
span.SetError(err)
span.Finish()
}()
if execContext, ok := tc.Conn.(driver.ExecerContext); ok {
res, err := execContext.ExecContext(ctx, query, args)
if err != nil {
return nil, err
}
return res, nil
}
// Fallback implementation
dargs, err := namedValueToValue(args)
if err != nil {
return nil, err
}
select {
default:
case <-ctx.Done():
return nil, ctx.Err()
}
return tc.Exec(query, dargs)
}
// tracedConn has a Ping method in order to implement the pinger interface
func (tc tracedConn) Ping(ctx context.Context) (err error) {
span := tc.getSpan(ctx, "Ping")
defer func() {
span.SetError(err)
span.Finish()
}()
if pinger, ok := tc.Conn.(driver.Pinger); ok {
err = pinger.Ping(ctx)
}
return err
}
func (tc tracedConn) Query(query string, args []driver.Value) (driver.Rows, error) {
if queryer, ok := tc.Conn.(driver.Queryer); ok {
return queryer.Query(query, args)
}
return nil, driver.ErrSkip
}
func (tc tracedConn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (rows driver.Rows, err error) {
span := tc.getSpan(ctx, "Query", query)
defer func() {
span.SetError(err)
span.Finish()
}()
if queryerContext, ok := tc.Conn.(driver.QueryerContext); ok {
rows, err := queryerContext.QueryContext(ctx, query, args)
if err != nil {
return nil, err
}
return rows, nil
}
dargs, err := namedValueToValue(args)
if err != nil {
return nil, err
}
select {
default:
case <-ctx.Done():
return nil, ctx.Err()
}
return tc.Query(query, dargs)
}
// tracedTx is a traced version of sql.Tx
type tracedTx struct {
driver.Tx
traceInfo
ctx context.Context
}
// Commit sends a span at the end of the transaction
func (t tracedTx) Commit() (err error) {
span := t.getSpan(t.ctx, "Commit")
defer func() {
span.SetError(err)
span.Finish()
}()
return t.Tx.Commit()
}
// Rollback sends a span if the connection is aborted
func (t tracedTx) Rollback() (err error) {
span := t.getSpan(t.ctx, "Rollback")
defer func() {
span.SetError(err)
span.Finish()
}()
return t.Tx.Rollback()
}
// tracedStmt is traced version of sql.Stmt
type tracedStmt struct {
driver.Stmt
traceInfo
ctx context.Context
query string
}
// Close sends a span before closing a statement
func (s tracedStmt) Close() (err error) {
span := s.getSpan(s.ctx, "Close")
defer func() {
span.SetError(err)
span.Finish()
}()
return s.Stmt.Close()
}
// ExecContext is needed to implement the driver.StmtExecContext interface
func (s tracedStmt) ExecContext(ctx context.Context, args []driver.NamedValue) (res driver.Result, err error) {
span := s.getSpan(s.ctx, "Exec", s.query)
defer func() {
span.SetError(err)
span.Finish()
}()
if stmtExecContext, ok := s.Stmt.(driver.StmtExecContext); ok {
res, err = stmtExecContext.ExecContext(ctx, args)
if err != nil {
return nil, err
}
return res, nil
}
// Fallback implementation
dargs, err := namedValueToValue(args)
if err != nil {
return nil, err
}
select {
default:
case <-ctx.Done():
return nil, ctx.Err()
}
return s.Exec(dargs)
}
// QueryContext is needed to implement the driver.StmtQueryContext interface
func (s tracedStmt) QueryContext(ctx context.Context, args []driver.NamedValue) (rows driver.Rows, err error) {
span := s.getSpan(s.ctx, "Query", s.query)
defer func() {
span.SetError(err)
span.Finish()
}()
if stmtQueryContext, ok := s.Stmt.(driver.StmtQueryContext); ok {
rows, err = stmtQueryContext.QueryContext(ctx, args)
if err != nil {
return nil, err
}
return rows, nil
}
// Fallback implementation
dargs, err := namedValueToValue(args)
if err != nil {
return nil, err
}
select {
default:
case <-ctx.Done():
return nil, ctx.Err()
}
return s.Query(dargs)
}