|
| 1 | +package internalstorage |
| 2 | + |
| 3 | +/* |
| 4 | + Ref from https://github.com/go-gorm/opentelemetry/tree/master/[email protected] |
| 5 | +*/ |
| 6 | + |
| 7 | +import ( |
| 8 | + "database/sql" |
| 9 | + "database/sql/driver" |
| 10 | + "fmt" |
| 11 | + "io" |
| 12 | + "regexp" |
| 13 | + "strings" |
| 14 | + |
| 15 | + "go.opentelemetry.io/otel/attribute" |
| 16 | + semconv "go.opentelemetry.io/otel/semconv/v1.17.0" |
| 17 | + "go.opentelemetry.io/otel/trace" |
| 18 | + "gorm.io/gorm" |
| 19 | +) |
| 20 | + |
| 21 | +var ( |
| 22 | + firstWordRegex = regexp.MustCompile(`^\w+`) |
| 23 | + cCommentRegex = regexp.MustCompile(`(?is)/\*.*?\*/`) |
| 24 | + lineCommentRegex = regexp.MustCompile(`(?im)(?:--|#).*?$`) |
| 25 | + sqlPrefixRegex = regexp.MustCompile(`^[\s;]*`) |
| 26 | + |
| 27 | + dbRowsAffected = attribute.Key("db.rows_affected") |
| 28 | +) |
| 29 | + |
| 30 | +type tracePlugin struct { |
| 31 | + attrs []attribute.KeyValue |
| 32 | + excludeQueryVars bool |
| 33 | +} |
| 34 | + |
| 35 | +func NewGormTrace(excludeQueryVars bool) gorm.Plugin { |
| 36 | + return &tracePlugin{ |
| 37 | + excludeQueryVars: excludeQueryVars, |
| 38 | + } |
| 39 | +} |
| 40 | + |
| 41 | +func (p tracePlugin) Name() string { |
| 42 | + return "gorm:oteltracing" |
| 43 | +} |
| 44 | + |
| 45 | +type gormHookFunc func(tx *gorm.DB) |
| 46 | + |
| 47 | +type gormRegister interface { |
| 48 | + Register(name string, fn func(*gorm.DB)) error |
| 49 | +} |
| 50 | + |
| 51 | +func (p tracePlugin) Initialize(db *gorm.DB) (err error) { |
| 52 | + cb := db.Callback() |
| 53 | + hooks := []struct { |
| 54 | + callback gormRegister |
| 55 | + hook gormHookFunc |
| 56 | + name string |
| 57 | + }{ |
| 58 | + {cb.Query().Before("gorm:query"), p.before("gorm.Query"), "before:select"}, |
| 59 | + {cb.Query().After("gorm:query"), p.after("gorm.Query"), "after:select"}, |
| 60 | + |
| 61 | + /* |
| 62 | + {cb.Create().Before("gorm:create"), p.before("gorm.Create"), "before:create"}, |
| 63 | + {cb.Create().After("gorm:create"), p.after("gorm.Create"), "after:create"}, |
| 64 | +
|
| 65 | + {cb.Delete().Before("gorm:delete"), p.before("gorm.Delete"), "before:delete"}, |
| 66 | + {cb.Delete().After("gorm:delete"), p.after("gorm.Delete"), "after:delete"}, |
| 67 | +
|
| 68 | + {cb.Update().Before("gorm:update"), p.before("gorm.Update"), "before:update"}, |
| 69 | + {cb.Update().After("gorm:update"), p.after("gorm.Update"), "after:update"}, |
| 70 | +
|
| 71 | + {cb.Row().Before("gorm:row"), p.before("gorm.Row"), "before:row"}, |
| 72 | + {cb.Row().After("gorm:row"), p.after("gorm.Row"), "after:row"}, |
| 73 | +
|
| 74 | + {cb.Raw().Before("gorm:raw"), p.before("gorm.Raw"), "before:raw"}, |
| 75 | + {cb.Raw().After("gorm:raw"), p.after("gorm.Raw"), "after:raw"}, |
| 76 | + */ |
| 77 | + } |
| 78 | + |
| 79 | + var firstErr error |
| 80 | + for _, h := range hooks { |
| 81 | + if err := h.callback.Register("otel:"+h.name, h.hook); err != nil && firstErr == nil { |
| 82 | + firstErr = fmt.Errorf("callback register %s failed: %w", h.name, err) |
| 83 | + } |
| 84 | + } |
| 85 | + |
| 86 | + return firstErr |
| 87 | +} |
| 88 | + |
| 89 | +func (p *tracePlugin) before(operate string) gormHookFunc { |
| 90 | + return func(tx *gorm.DB) { |
| 91 | + span := trace.SpanFromContext(tx.Statement.Context) |
| 92 | + if !span.IsRecording() { |
| 93 | + return |
| 94 | + } |
| 95 | + span.AddEvent("About " + operate) |
| 96 | + } |
| 97 | +} |
| 98 | + |
| 99 | +func (p *tracePlugin) after(operate string) gormHookFunc { |
| 100 | + return func(tx *gorm.DB) { |
| 101 | + span := trace.SpanFromContext(tx.Statement.Context) |
| 102 | + if !span.IsRecording() { |
| 103 | + return |
| 104 | + } |
| 105 | + |
| 106 | + attrs := make([]attribute.KeyValue, 0, len(p.attrs)+4) |
| 107 | + attrs = append(attrs, p.attrs...) |
| 108 | + |
| 109 | + if sys := dbSystem(tx); sys.Valid() { |
| 110 | + attrs = append(attrs, sys) |
| 111 | + } |
| 112 | + |
| 113 | + vars := tx.Statement.Vars |
| 114 | + |
| 115 | + var query string |
| 116 | + if p.excludeQueryVars { |
| 117 | + query = tx.Statement.SQL.String() |
| 118 | + } else { |
| 119 | + query = tx.Dialector.Explain(tx.Statement.SQL.String(), vars...) |
| 120 | + } |
| 121 | + |
| 122 | + formatQuery := p.formatQuery(query) |
| 123 | + attrs = append(attrs, semconv.DBStatementKey.String(formatQuery)) |
| 124 | + attrs = append(attrs, semconv.DBOperationKey.String(dbOperation(formatQuery))) |
| 125 | + if tx.Statement.Table != "" { |
| 126 | + attrs = append(attrs, semconv.DBSQLTableKey.String(tx.Statement.Table)) |
| 127 | + } |
| 128 | + if tx.Statement.RowsAffected != -1 { |
| 129 | + attrs = append(attrs, dbRowsAffected.Int64(tx.Statement.RowsAffected)) |
| 130 | + } |
| 131 | + |
| 132 | + span.AddEvent(fmt.Sprintf("%s succeeded", operate), trace.WithAttributes(attrs...)) |
| 133 | + switch tx.Error { |
| 134 | + case nil, |
| 135 | + gorm.ErrRecordNotFound, |
| 136 | + driver.ErrSkip, |
| 137 | + io.EOF, // end of rows iterator |
| 138 | + sql.ErrNoRows: |
| 139 | + // ignore |
| 140 | + default: |
| 141 | + span.RecordError(tx.Error) |
| 142 | + } |
| 143 | + } |
| 144 | +} |
| 145 | + |
| 146 | +func (p *tracePlugin) formatQuery(query string) string { |
| 147 | + return query |
| 148 | +} |
| 149 | + |
| 150 | +func dbSystem(tx *gorm.DB) attribute.KeyValue { |
| 151 | + switch tx.Dialector.Name() { |
| 152 | + case "mysql": |
| 153 | + return semconv.DBSystemMySQL |
| 154 | + case "mssql": |
| 155 | + return semconv.DBSystemMSSQL |
| 156 | + case "postgres", "postgresql": |
| 157 | + return semconv.DBSystemPostgreSQL |
| 158 | + case "sqlite": |
| 159 | + return semconv.DBSystemSqlite |
| 160 | + case "sqlserver": |
| 161 | + return semconv.DBSystemKey.String("sqlserver") |
| 162 | + case "clickhouse": |
| 163 | + return semconv.DBSystemKey.String("clickhouse") |
| 164 | + case "spanner": |
| 165 | + return semconv.DBSystemKey.String("spanner") |
| 166 | + default: |
| 167 | + return attribute.KeyValue{} |
| 168 | + } |
| 169 | +} |
| 170 | + |
| 171 | +func dbOperation(query string) string { |
| 172 | + s := cCommentRegex.ReplaceAllString(query, "") |
| 173 | + s = lineCommentRegex.ReplaceAllString(s, "") |
| 174 | + s = sqlPrefixRegex.ReplaceAllString(s, "") |
| 175 | + return strings.ToLower(firstWordRegex.FindString(s)) |
| 176 | +} |
0 commit comments