forked from honeycombio/beeline-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sql.go
702 lines (591 loc) · 16.4 KB
/
sql.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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
package hnysql
import (
"context"
"database/sql"
"database/sql/driver"
"time"
"github.com/google/uuid"
"github.com/honeycombio/beeline-go/wrappers/common"
"github.com/honeycombio/libhoney-go"
)
type DB struct {
// wdb is the wrapped sql db. It is not embedded because it's better to fail
// compilation if some methods are missing than it is to silently not
// instrument those methods. If you believe that this wraps all methods, it
// would be reasonable to think that calls that don't show up in Honeycomb
// aren't happening when they are - they just fell through to the underlying
// *sql.DB. So all methods present on *sql.DB are recreated here, but as the
// wrapped package changes, we will fail to compile against apps using those
// new features and need a patch.
wdb *sql.DB
// Builder is available in case you wish to add fields to every SQL event
// that will be created.
Builder *libhoney.Builder
}
func WrapDB(s *sql.DB) *DB {
b := libhoney.NewBuilder()
db := &DB{
wdb: s,
Builder: b,
}
addConns := func() interface{} {
stats := s.Stats()
return stats.OpenConnections
}
b.AddDynamicField("db.open_conns", addConns)
b.AddField("meta.type", "sql")
return db
}
func (db *DB) Begin() (*Tx, error) {
var err error
ev, sender := common.BuildDBEvent(db.Builder, "")
defer sender(err)
bld := db.Builder.Clone()
wrapTx := &Tx{
Builder: bld,
}
newid, _ := uuid.NewRandom()
txid := newid.String()
bld.AddField("db.txId", txid)
ev.AddField("db.txId", txid)
// do DB call
tx, err := db.wdb.Begin()
wrapTx.wtx = tx
return wrapTx, err
}
func (db *DB) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error) {
var err error
ctx, span, sender := common.BuildDBSpan(ctx, db.Builder, "")
defer sender(err)
// TODO if ctx.Cancel is called, the transaction is rolled back. We should
// submit an event indicating the rollback.
bld := db.Builder.Clone()
wrapTx := &Tx{
Builder: bld,
}
newid, _ := uuid.NewRandom()
txid := newid.String()
bld.AddField("db.txId", txid)
if span != nil {
span.AddField("db.txId", txid)
}
bld.AddField("db.options", opts)
if span != nil {
span.AddField("db.options", opts)
}
// do DB call
tx, err := db.wdb.BeginTx(ctx, opts)
wrapTx.wtx = tx
return wrapTx, err
}
func (db *DB) Conn(ctx context.Context) (*Conn, error) {
var err error
ctx, span, sender := common.BuildDBSpan(ctx, db.Builder, "")
defer sender(err)
bld := db.Builder.Clone()
id, _ := uuid.NewRandom()
connid := id.String()
wrapConn := &Conn{
Builder: bld,
}
bld.AddField("db.connId", connid)
if span != nil {
span.AddField("db.connId", connid)
}
// do DB call
conn, err := db.wdb.Conn(ctx)
wrapConn.wconn = conn
return wrapConn, err
}
func (db *DB) Exec(query string, args ...interface{}) (sql.Result, error) {
var err error
ev, sender := common.BuildDBEvent(db.Builder, query, args...)
defer sender(err)
// do DB call
res, err := db.wdb.Exec(query, args...)
// capture results
if err == nil {
id, lierr := res.LastInsertId()
if lierr == nil {
ev.AddField("db.last_insert_id", id)
}
numrows, nrerr := res.RowsAffected()
if nrerr == nil {
ev.AddField("db.rows_affected", numrows)
}
}
return res, err
}
func (db *DB) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) {
var err error
ctx, span, sender := common.BuildDBSpan(ctx, db.Builder, query, args...)
defer sender(err)
// do DB call
res, err := db.wdb.ExecContext(ctx, query, args...)
// capture results
if err == nil {
id, lierr := res.LastInsertId()
if lierr == nil {
if span != nil {
span.AddField("db.last_insert_id", id)
}
}
numrows, nrerr := res.RowsAffected()
if nrerr == nil {
if span != nil {
span.AddField("db.rows_affected", numrows)
}
}
}
return res, err
}
func (db *DB) Ping() error {
var err error
_, sender := common.BuildDBEvent(db.Builder, "")
defer sender(err)
err = db.wdb.Ping()
return err
}
func (db *DB) PingContext(ctx context.Context) error {
var err error
ctx, _, sender := common.BuildDBSpan(ctx, db.Builder, "")
defer sender(err)
err = db.wdb.Ping()
return err
}
func (db *DB) Prepare(query string) (*Stmt, error) {
var err error
ev, sender := common.BuildDBEvent(db.Builder, query)
defer sender(err)
bld := db.Builder.Clone()
id, _ := uuid.NewRandom()
stmtid := id.String()
wrapStmt := &Stmt{
Builder: bld,
}
bld.AddField("db.stmtId", stmtid)
// add the query to the builder so all executions of this prepared statement
// have the query right there
bld.AddField("db.query", query)
ev.AddField("db.stmtId", stmtid)
// do DB call
stmt, err := db.wdb.Prepare(query)
wrapStmt.wstmt = stmt
return wrapStmt, err
}
func (db *DB) PrepareContext(ctx context.Context, query string) (*Stmt, error) {
var err error
ctx, span, sender := common.BuildDBSpan(ctx, db.Builder, query)
defer sender(err)
bld := db.Builder.Clone()
id, _ := uuid.NewRandom()
stmtid := id.String()
wrapStmt := &Stmt{
Builder: bld,
}
bld.AddField("db.stmtId", stmtid)
// add the query to the builder so all executions of this prepared statement
// have the query right there
bld.AddField("db.query", query)
if span != nil {
span.AddField("db.stmtId", stmtid)
}
// do DB call
stmt, err := db.wdb.PrepareContext(ctx, query)
wrapStmt.wstmt = stmt
return wrapStmt, err
}
func (db *DB) Query(query string, args ...interface{}) (*sql.Rows, error) {
var err error
_, sender := common.BuildDBEvent(db.Builder, query, args)
defer sender(err)
// do DB call
rows, err := db.wdb.Query(query, args...)
// TODO can we figure out the number of rows returned or anything like that?
return rows, err
}
func (db *DB) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error) {
var err error
ctx, _, sender := common.BuildDBSpan(ctx, db.Builder, query, args)
defer sender(err)
// do DB call
rows, err := db.wdb.QueryContext(ctx, query, args...)
return rows, err
}
func (db *DB) QueryRow(query string, args ...interface{}) *sql.Row {
_, sender := common.BuildDBEvent(db.Builder, query, args)
defer sender(nil)
// do DB call
row := db.wdb.QueryRow(query, args...)
return row
}
func (db *DB) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row {
ctx, _, sender := common.BuildDBSpan(ctx, db.Builder, query, args)
defer sender(nil)
// do DB call
row := db.wdb.QueryRowContext(ctx, query, args...)
return row
}
func (db *DB) Close() error {
var err error
_, sender := common.BuildDBEvent(db.Builder, "")
defer sender(err)
err = db.wdb.Close()
return err
}
// these are not instrumented calls since they're more configuration-esque
func (db *DB) Driver() driver.Driver { return db.wdb.Driver() }
func (db *DB) SetConnMaxLifetime(d time.Duration) { db.wdb.SetConnMaxLifetime(d) }
func (db *DB) SetMaxIdleConns(n int) { db.wdb.SetMaxIdleConns(n) }
func (db *DB) SetMaxOpenConns(n int) { db.wdb.SetMaxOpenConns(n) }
func (db *DB) Stats() sql.DBStats { return db.wdb.Stats() }
type Conn struct {
wconn *sql.Conn
Builder *libhoney.Builder
}
func (c *Conn) BeginTx(ctx context.Context, opts *sql.TxOptions) (*Tx, error) {
var err error
ctx, span, sender := common.BuildDBSpan(ctx, c.Builder, "")
defer sender(err)
// TODO if ctx.Cancel is called, the transaction is rolled back. We should
// submit an event indicating the rollback.
bld := c.Builder.Clone()
id, _ := uuid.NewRandom()
txid := id.String()
wrapTx := &Tx{
Builder: bld,
}
bld.AddField("db.txId", txid)
if span != nil {
span.AddField("db.txId", txid)
}
if span != nil {
span.AddField("db.options", opts)
}
bld.AddField("db.options", opts)
// do DB call
tx, err := c.wconn.BeginTx(ctx, opts)
wrapTx.wtx = tx
return wrapTx, err
}
func (c *Conn) Close() error {
var err error
_, sender := common.BuildDBEvent(c.Builder, "")
defer sender(err)
// do DB call
err = c.wconn.Close()
return err
}
func (c *Conn) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) {
var err error
ctx, span, sender := common.BuildDBSpan(ctx, c.Builder, query, args...)
defer sender(err)
// do DB call
res, err := c.wconn.ExecContext(ctx, query, args...)
// capture results
if err == nil {
id, lierr := res.LastInsertId()
if lierr == nil {
if span != nil {
span.AddField("db.last_insert_id", id)
}
}
numrows, nrerr := res.RowsAffected()
if nrerr == nil {
if span != nil {
span.AddField("db.rows_affected", numrows)
}
}
}
return res, err
}
func (c *Conn) PingContext(ctx context.Context) error {
var err error
ctx, _, sender := common.BuildDBSpan(ctx, c.Builder, "")
defer sender(err)
err = c.wconn.PingContext(ctx)
return err
}
func (c *Conn) PrepareContext(ctx context.Context, query string) (*Stmt, error) {
var err error
ctx, span, sender := common.BuildDBSpan(ctx, c.Builder, query)
defer sender(err)
bld := c.Builder.Clone()
id, _ := uuid.NewRandom()
stmtid := id.String()
wrapStmt := &Stmt{
Builder: bld,
}
bld.AddField("db.stmtId", stmtid)
bld.AddField("db.query", query)
if span != nil {
span.AddField("db.stmtId", stmtid)
}
// do DB call
stmt, err := c.wconn.PrepareContext(ctx, query)
wrapStmt.wstmt = stmt
return wrapStmt, err
}
func (c *Conn) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error) {
var err error
ctx, _, sender := common.BuildDBSpan(ctx, c.Builder, query, args)
defer sender(err)
// do DB call
rows, err := c.wconn.QueryContext(ctx, query, args...)
return rows, err
}
func (c *Conn) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row {
ctx, _, sender := common.BuildDBSpan(ctx, c.Builder, query, args)
defer sender(nil)
// do DB call
row := c.wconn.QueryRowContext(ctx, query, args...)
return row
}
type Stmt struct {
wstmt *sql.Stmt
Builder *libhoney.Builder
}
func (s *Stmt) Close() error {
var err error
_, sender := common.BuildDBEvent(s.Builder, "")
defer sender(err)
err = s.wstmt.Close()
return err
}
func (s *Stmt) Exec(args ...interface{}) (sql.Result, error) {
var err error
ev, sender := common.BuildDBEvent(s.Builder, "", args...)
defer sender(err)
// do DB call
res, err := s.wstmt.Exec(args...)
// capture results
if err == nil {
id, lierr := res.LastInsertId()
if lierr == nil {
ev.AddField("db.last_insert_id", id)
}
numrows, nrerr := res.RowsAffected()
if nrerr == nil {
ev.AddField("db.rows_affected", numrows)
}
}
return res, err
}
func (s *Stmt) ExecContext(ctx context.Context, args ...interface{}) (sql.Result, error) {
var err error
ctx, span, sender := common.BuildDBSpan(ctx, s.Builder, "", args...)
defer sender(err)
// do DB call
res, err := s.wstmt.ExecContext(ctx, args...)
// capture results
if err == nil {
id, lierr := res.LastInsertId()
if lierr == nil {
if span != nil {
span.AddField("db.last_insert_id", id)
}
}
numrows, nrerr := res.RowsAffected()
if nrerr == nil {
if span != nil {
span.AddField("db.rows_affected", numrows)
}
}
}
return res, err
}
func (s *Stmt) Query(args ...interface{}) (*sql.Rows, error) {
var err error
_, sender := common.BuildDBEvent(s.Builder, "", args)
defer sender(err)
// do DB call
rows, err := s.wstmt.Query(args...)
return rows, err
}
func (s *Stmt) QueryContext(ctx context.Context, args ...interface{}) (*sql.Rows, error) {
var err error
ctx, _, sender := common.BuildDBSpan(ctx, s.Builder, "", args)
defer sender(err)
// do DB call
rows, err := s.wstmt.QueryContext(ctx, args...)
return rows, err
}
func (s *Stmt) QueryRow(args ...interface{}) *sql.Row {
_, sender := common.BuildDBEvent(s.Builder, "", args)
defer sender(nil)
// do DB call
row := s.wstmt.QueryRow(args...)
return row
}
func (s *Stmt) QueryRowContext(ctx context.Context, args ...interface{}) *sql.Row {
ctx, _, sender := common.BuildDBSpan(ctx, s.Builder, "", args)
defer sender(nil)
// do DB call
row := s.wstmt.QueryRowContext(ctx, args...)
return row
}
type Tx struct {
// wtx is the wrapped transaction
wtx *sql.Tx
Builder *libhoney.Builder
}
func (tx *Tx) Commit() error {
var err error
_, sender := common.BuildDBEvent(tx.Builder, "")
defer sender(err)
// do DB call
err = tx.wtx.Commit()
return err
}
func (tx *Tx) Exec(query string, args ...interface{}) (sql.Result, error) {
var err error
ev, sender := common.BuildDBEvent(tx.Builder, query, args...)
defer sender(err)
// do DB call
res, err := tx.wtx.Exec(query, args...)
// capture results
if err == nil {
id, lierr := res.LastInsertId()
if lierr == nil {
ev.AddField("db.last_insert_id", id)
}
numrows, nrerr := res.RowsAffected()
if nrerr == nil {
ev.AddField("db.rows_affected", numrows)
}
}
return res, err
}
func (tx *Tx) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) {
var err error
ctx, span, sender := common.BuildDBSpan(ctx, tx.Builder, query, args...)
defer sender(err)
// do DB call
res, err := tx.wtx.ExecContext(ctx, query, args...)
// capture results
if err == nil {
id, lierr := res.LastInsertId()
if lierr == nil {
if span != nil {
span.AddField("db.last_insert_id", id)
}
}
numrows, nrerr := res.RowsAffected()
if nrerr == nil {
if span != nil {
span.AddField("db.rows_affected", numrows)
}
}
}
return res, err
}
func (tx *Tx) Prepare(query string) (*Stmt, error) {
var err error
ev, sender := common.BuildDBEvent(tx.Builder, query)
defer sender(err)
bld := tx.Builder.Clone()
id, _ := uuid.NewRandom()
stmtid := id.String()
wrapStmt := &Stmt{
Builder: bld,
}
bld.AddField("db.stmtId", stmtid)
ev.AddField("db.stmtId", stmtid)
bld.AddField("db.query", query)
// do DB call
stmt, err := tx.wtx.Prepare(query)
wrapStmt.wstmt = stmt
return wrapStmt, err
}
func (tx *Tx) PrepareContext(ctx context.Context, query string) (*Stmt, error) {
var err error
ctx, span, sender := common.BuildDBSpan(ctx, tx.Builder, query)
defer sender(err)
bld := tx.Builder.Clone()
id, _ := uuid.NewRandom()
stmtid := id.String()
wrapStmt := &Stmt{
Builder: bld,
}
bld.AddField("db.stmtId", stmtid)
if span != nil {
span.AddField("db.stmtId", stmtid)
}
bld.AddField("db.query", query)
// do DB call
stmt, err := tx.wtx.PrepareContext(ctx, query)
wrapStmt.wstmt = stmt
return wrapStmt, err
}
func (tx *Tx) Query(query string, args ...interface{}) (*sql.Rows, error) {
var err error
_, sender := common.BuildDBEvent(tx.Builder, query, args)
defer sender(err)
// do DB call
rows, err := tx.wtx.Query(query, args...)
return rows, err
}
func (tx *Tx) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error) {
var err error
ctx, _, sender := common.BuildDBSpan(ctx, tx.Builder, query, args)
defer sender(err)
// do DB call
rows, err := tx.wtx.QueryContext(ctx, query, args...)
return rows, err
}
func (tx *Tx) QueryRow(query string, args ...interface{}) *sql.Row {
_, sender := common.BuildDBEvent(tx.Builder, query, args)
defer sender(nil)
// do DB call
row := tx.wtx.QueryRow(query, args...)
return row
}
func (tx *Tx) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row {
ctx, _, sender := common.BuildDBSpan(ctx, tx.Builder, query, args)
defer sender(nil)
// do DB call
row := tx.wtx.QueryRowContext(ctx, query, args...)
return row
}
func (tx *Tx) Rollback() error {
var err error
_, sender := common.BuildDBEvent(tx.Builder, "")
defer sender(err)
// do DB call
err = tx.wtx.Rollback()
return err
}
func (tx *Tx) Stmt(stmt *Stmt) *Stmt {
ev, sender := common.BuildDBEvent(tx.Builder, "")
defer sender(nil)
bld := stmt.Builder.Clone()
wrapStmt := &Stmt{
Builder: bld,
}
// add the transaction's ID to the statement so that when it gets executed
// you get both
bld.AddField("db.txid", tx.Builder.Fields()["db.txid"])
ev.AddField("db.stmtid", stmt.Builder.Fields()["db.stmtid"])
// do DB call
newStmt := tx.wtx.Stmt(stmt.wstmt)
wrapStmt.wstmt = newStmt
return wrapStmt
}
func (tx *Tx) StmtContext(ctx context.Context, stmt *Stmt) *Stmt {
ctx, span, sender := common.BuildDBSpan(ctx, tx.Builder, "")
defer sender(nil)
bld := stmt.Builder.Clone()
wrapStmt := &Stmt{
Builder: bld,
}
// add the transaction's ID to the statement so that when it gets executed
// you get both
bld.AddField("db.txid", tx.Builder.Fields()["db.txid"])
if span != nil {
span.AddField("db.stmtid", stmt.Builder.Fields()["db.stmtid"])
}
// do DB call
newStmt := tx.wtx.StmtContext(ctx, stmt.wstmt)
wrapStmt.wstmt = newStmt
return wrapStmt
}