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
|
// Copyright 2020 New Relic Corporation. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
// +build go1.10
package newrelic
import (
"context"
"database/sql/driver"
"time"
)
// SQLDriverSegmentBuilder populates DatastoreSegments for sql.Driver
// instrumentation. Use this to instrument a database that is not supported by
// an existing integration package (nrmysql, nrpq, and nrsqlite3). See
// https://github.com/newrelic/go-agent/blob/master/v3/integrations/nrmysql/nrmysql.go
// for example use.
type SQLDriverSegmentBuilder struct {
BaseSegment DatastoreSegment
ParseQuery func(segment *DatastoreSegment, query string)
ParseDSN func(segment *DatastoreSegment, dataSourceName string)
}
// InstrumentSQLDriver wraps a driver.Driver, adding instrumentation for exec
// and query calls made with a transaction-containing context. Use this to
// instrument a database driver that is not supported by an existing integration
// package (nrmysql, nrpq, and nrsqlite3). See
// https://github.com/newrelic/go-agent/blob/master/v3/integrations/nrmysql/nrmysql.go
// for example use.
func InstrumentSQLDriver(d driver.Driver, bld SQLDriverSegmentBuilder) driver.Driver {
return optionalMethodsDriver(&wrapDriver{bld: bld, original: d})
}
// InstrumentSQLConnector wraps a driver.Connector, adding instrumentation for
// exec and query calls made with a transaction-containing context. Use this to
// instrument a database connector that is not supported by an existing
// integration package (nrmysql, nrpq, and nrsqlite3). See
// https://github.com/newrelic/go-agent/blob/master/v3/integrations/nrmysql/nrmysql.go
// for example use.
func InstrumentSQLConnector(connector driver.Connector, bld SQLDriverSegmentBuilder) driver.Connector {
return &wrapConnector{original: connector, bld: bld}
}
func (bld SQLDriverSegmentBuilder) useDSN(dsn string) SQLDriverSegmentBuilder {
if f := bld.ParseDSN; nil != f {
f(&bld.BaseSegment, dsn)
}
return bld
}
func (bld SQLDriverSegmentBuilder) useQuery(query string) SQLDriverSegmentBuilder {
if f := bld.ParseQuery; nil != f {
f(&bld.BaseSegment, query)
}
return bld
}
func (bld SQLDriverSegmentBuilder) startSegment(ctx context.Context) DatastoreSegment {
return bld.startSegmentAt(ctx, time.Now())
}
func (bld SQLDriverSegmentBuilder) startSegmentAt(ctx context.Context, at time.Time) DatastoreSegment {
segment := bld.BaseSegment
segment.StartTime = FromContext(ctx).startSegmentAt(at)
return segment
}
type wrapDriver struct {
bld SQLDriverSegmentBuilder
original driver.Driver
}
type wrapConnector struct {
bld SQLDriverSegmentBuilder
original driver.Connector
}
type wrapConn struct {
bld SQLDriverSegmentBuilder
original driver.Conn
}
type wrapStmt struct {
bld SQLDriverSegmentBuilder
original driver.Stmt
}
func (w *wrapDriver) Open(name string) (driver.Conn, error) {
original, err := w.original.Open(name)
if err != nil {
return nil, err
}
return optionalMethodsConn(&wrapConn{
original: original,
bld: w.bld.useDSN(name),
}), nil
}
// OpenConnector implements DriverContext.
func (w *wrapDriver) OpenConnector(name string) (driver.Connector, error) {
original, err := w.original.(driver.DriverContext).OpenConnector(name)
if err != nil {
return nil, err
}
return &wrapConnector{
original: original,
bld: w.bld.useDSN(name),
}, nil
}
func (w *wrapConnector) Connect(ctx context.Context) (driver.Conn, error) {
original, err := w.original.Connect(ctx)
if nil != err {
return nil, err
}
return optionalMethodsConn(&wrapConn{
bld: w.bld,
original: original,
}), nil
}
func (w *wrapConnector) Driver() driver.Driver {
return optionalMethodsDriver(&wrapDriver{
bld: w.bld,
original: w.original.Driver(),
})
}
func prepare(original driver.Stmt, err error, bld SQLDriverSegmentBuilder, query string) (driver.Stmt, error) {
if nil != err {
return nil, err
}
return optionalMethodsStmt(&wrapStmt{
bld: bld.useQuery(query),
original: original,
}), nil
}
func (w *wrapConn) Prepare(query string) (driver.Stmt, error) {
original, err := w.original.Prepare(query)
return prepare(original, err, w.bld, query)
}
// PrepareContext implements ConnPrepareContext.
func (w *wrapConn) PrepareContext(ctx context.Context, query string) (driver.Stmt, error) {
original, err := w.original.(driver.ConnPrepareContext).PrepareContext(ctx, query)
return prepare(original, err, w.bld, query)
}
func (w *wrapConn) Close() error {
return w.original.Close()
}
func (w *wrapConn) Begin() (driver.Tx, error) {
return w.original.Begin()
}
// BeginTx implements ConnBeginTx.
func (w *wrapConn) BeginTx(ctx context.Context, opts driver.TxOptions) (driver.Tx, error) {
return w.original.(driver.ConnBeginTx).BeginTx(ctx, opts)
}
// Exec implements Execer.
func (w *wrapConn) Exec(query string, args []driver.Value) (driver.Result, error) {
return w.original.(driver.Execer).Exec(query, args)
}
// ExecContext implements ExecerContext.
func (w *wrapConn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error) {
startTime := time.Now()
result, err := w.original.(driver.ExecerContext).ExecContext(ctx, query, args)
if err != driver.ErrSkip {
seg := w.bld.useQuery(query).startSegmentAt(ctx, startTime)
seg.End()
}
return result, err
}
// CheckNamedValue implements NamedValueChecker.
func (w *wrapConn) CheckNamedValue(v *driver.NamedValue) error {
return w.original.(driver.NamedValueChecker).CheckNamedValue(v)
}
// Ping implements Pinger.
func (w *wrapConn) Ping(ctx context.Context) error {
return w.original.(driver.Pinger).Ping(ctx)
}
func (w *wrapConn) Query(query string, args []driver.Value) (driver.Rows, error) {
return w.original.(driver.Queryer).Query(query, args)
}
// QueryContext implements QueryerContext.
func (w *wrapConn) QueryContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Rows, error) {
startTime := time.Now()
rows, err := w.original.(driver.QueryerContext).QueryContext(ctx, query, args)
if err != driver.ErrSkip {
seg := w.bld.useQuery(query).startSegmentAt(ctx, startTime)
seg.End()
}
return rows, err
}
// ResetSession implements SessionResetter.
func (w *wrapConn) ResetSession(ctx context.Context) error {
return w.original.(driver.SessionResetter).ResetSession(ctx)
}
func (w *wrapStmt) Close() error {
return w.original.Close()
}
func (w *wrapStmt) NumInput() int {
return w.original.NumInput()
}
func (w *wrapStmt) Exec(args []driver.Value) (driver.Result, error) {
return w.original.Exec(args)
}
func (w *wrapStmt) Query(args []driver.Value) (driver.Rows, error) {
return w.original.Query(args)
}
// ColumnConverter implements ColumnConverter.
func (w *wrapStmt) ColumnConverter(idx int) driver.ValueConverter {
return w.original.(driver.ColumnConverter).ColumnConverter(idx)
}
// CheckNamedValue implements NamedValueChecker.
func (w *wrapStmt) CheckNamedValue(v *driver.NamedValue) error {
return w.original.(driver.NamedValueChecker).CheckNamedValue(v)
}
// ExecContext implements StmtExecContext.
func (w *wrapStmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error) {
segment := w.bld.startSegment(ctx)
result, err := w.original.(driver.StmtExecContext).ExecContext(ctx, args)
segment.End()
return result, err
}
// QueryContext implements StmtQueryContext.
func (w *wrapStmt) QueryContext(ctx context.Context, args []driver.NamedValue) (driver.Rows, error) {
segment := w.bld.startSegment(ctx)
rows, err := w.original.(driver.StmtQueryContext).QueryContext(ctx, args)
segment.End()
return rows, err
}
var (
_ interface {
driver.Driver
driver.DriverContext
} = &wrapDriver{}
_ interface {
driver.Connector
} = &wrapConnector{}
_ interface {
driver.Conn
driver.ConnBeginTx
driver.ConnPrepareContext
driver.Execer
driver.ExecerContext
driver.NamedValueChecker
driver.Pinger
driver.Queryer
driver.QueryerContext
} = &wrapConn{}
_ interface {
driver.Stmt
driver.ColumnConverter
driver.NamedValueChecker
driver.StmtExecContext
driver.StmtQueryContext
} = &wrapStmt{}
)
|