/
instagorm.go
144 lines (102 loc) · 3.46 KB
/
instagorm.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
// (c) Copyright IBM Corp. 2023
//go:build go1.18
// +build go1.18
// Package instagorm provides instrumentation for the gorm library.
package instagorm
import (
instana "github.com/instana/go-sensor"
"github.com/opentracing/opentracing-go/ext"
otlog "github.com/opentracing/opentracing-go/log"
"gorm.io/gorm"
)
type wrappedDB struct {
connDetails instana.DbConnDetails
sensor instana.TracerLogger
*gorm.DB
}
// Instrument adds instrumentation for the specified gorm database instance.
func Instrument(db *gorm.DB, s instana.TracerLogger, dsn string) {
wdB := wrappedDB{
connDetails: instana.ParseDBConnDetails(dsn),
sensor: s,
DB: db,
}
wdB.registerCreateCallbacks()
wdB.registerQueryCallbacks()
wdB.registerRowCallbacks()
wdB.registerRawCallbacks()
wdB.registerDeleteCallbacks()
wdB.registerUpdateCallbacks()
}
func (wdB *wrappedDB) registerCreateCallbacks() {
wdB.logError(wdB.Callback().Create().Before("gorm:create").Register("instagorm:before_create",
preOpCb(wdB)))
wdB.logError(wdB.Callback().Create().After("gorm:create").Register("instagorm:after_create",
postOpCb()))
}
func (wdB *wrappedDB) registerUpdateCallbacks() {
wdB.logError(wdB.Callback().Update().Before("gorm:update").Register("instagorm:before_update",
preOpCb(wdB)))
wdB.logError(wdB.Callback().Update().After("gorm:update").Register("instagorm:after_update",
postOpCb()))
}
func (wdB *wrappedDB) registerDeleteCallbacks() {
wdB.logError(wdB.Callback().Delete().Before("gorm:delete").Register("instagorm:before_delete",
preOpCb(wdB)))
wdB.logError(wdB.Callback().Delete().After("gorm:delete").Register("instagorm:after_delete",
postOpCb()))
}
func (wdB *wrappedDB) registerQueryCallbacks() {
wdB.logError(wdB.Callback().Query().Before("gorm:query").Register("instagorm:before_query",
preOpCb(wdB)))
wdB.logError(wdB.Callback().Query().After("gorm:query").Register("instagorm:after_query",
postOpCb()))
}
func (wdB *wrappedDB) registerRowCallbacks() {
wdB.logError(wdB.Callback().Raw().Before("gorm:row").Register("instagorm:before_row",
preOpCb(wdB)))
wdB.logError(wdB.Callback().Raw().After("gorm:row").Register("instagorm:after_row",
postOpCb()))
}
func (wdB *wrappedDB) registerRawCallbacks() {
wdB.logError(wdB.Callback().Raw().Before("gorm:raw").Register("instagorm:before_raw",
preOpCb(wdB)))
wdB.logError(wdB.Callback().Raw().After("gorm:raw").Register("instagorm:after_raw",
postOpCb()))
}
func (wdB *wrappedDB) logError(err error) {
if err != nil {
wdB.sensor.Logger().Error("unable to register callback, error: ", err.Error())
}
}
func preOpCb(wdB *wrappedDB) func(db *gorm.DB) {
return func(db *gorm.DB) {
ctx := db.Statement.Context
sp, dbKey := instana.StartSQLSpan(ctx, wdB.connDetails, db.Statement.SQL.String(), wdB.sensor)
sp.SetBaggageItem("dbKey", dbKey)
ctx = instana.ContextWithSpan(ctx, sp)
db.Statement.Context = ctx
}
}
func postOpCb() func(db *gorm.DB) {
return func(db *gorm.DB) {
sp, ok := instana.SpanFromContext(db.Statement.Context)
if !ok {
return
}
defer sp.Finish()
dbKey := sp.BaggageItem("dbKey")
var stmtKey string = dbKey + ".stmt"
var errKey string = dbKey + ".error"
if dbKey == "db" {
stmtKey = string(ext.DBStatement)
errKey = "error"
sp.SetTag(string(ext.DBType), db.Dialector.Name())
}
sp.SetTag(stmtKey, db.Statement.SQL.String())
if err := db.Statement.Error; err != nil {
sp.SetTag(errKey, err.Error())
sp.LogFields(otlog.Error(err))
}
}
}