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
|
// Copyright 2020 New Relic Corporation. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
// +build go1.10
// Package nrmysql instruments https://github.com/go-sql-driver/mysql.
//
// Use this package to instrument your MySQL calls without having to manually
// create DatastoreSegments. This is done in a two step process:
//
// 1. Use this package's driver in place of the mysql driver.
//
// If your code is using sql.Open like this:
//
// import (
// _ "github.com/go-sql-driver/mysql"
// )
//
// func main() {
// db, err := sql.Open("mysql", "user@unix(/path/to/socket)/dbname")
// }
//
// Then change the side-effect import to this package, and open "nrmysql" instead:
//
// import (
// _ "github.com/newrelic/go-agent/_integrations/nrmysql"
// )
//
// func main() {
// db, err := sql.Open("nrmysql", "user@unix(/path/to/socket)/dbname")
// }
//
// 2. Provide a context containing a newrelic.Transaction to all exec and query
// methods on sql.DB, sql.Conn, sql.Tx, and sql.Stmt. This requires using the
// context methods ExecContext, QueryContext, and QueryRowContext in place of
// Exec, Query, and QueryRow respectively. For example, instead of the
// following:
//
// row := db.QueryRow("SELECT count(*) from tables")
//
// Do this:
//
// ctx := newrelic.NewContext(context.Background(), txn)
// row := db.QueryRowContext(ctx, "SELECT count(*) from tables")
//
// A working example is shown here:
// https://github.com/newrelic/go-agent/tree/master/_integrations/nrmysql/example/main.go
package nrmysql
import (
"database/sql"
"net"
"github.com/go-sql-driver/mysql"
newrelic "github.com/newrelic/go-agent"
"github.com/newrelic/go-agent/internal"
"github.com/newrelic/go-agent/internal/sqlparse"
)
var (
baseBuilder = newrelic.SQLDriverSegmentBuilder{
BaseSegment: newrelic.DatastoreSegment{
Product: newrelic.DatastoreMySQL,
},
ParseQuery: sqlparse.ParseQuery,
ParseDSN: parseDSN,
}
)
func init() {
sql.Register("nrmysql", newrelic.InstrumentSQLDriver(mysql.MySQLDriver{}, baseBuilder))
internal.TrackUsage("integration", "driver", "mysql")
}
func parseDSN(s *newrelic.DatastoreSegment, dsn string) {
cfg, err := mysql.ParseDSN(dsn)
if nil != err {
return
}
parseConfig(s, cfg)
}
func parseConfig(s *newrelic.DatastoreSegment, cfg *mysql.Config) {
s.DatabaseName = cfg.DBName
var host, ppoid string
switch cfg.Net {
case "unix", "unixgram", "unixpacket":
host = "localhost"
ppoid = cfg.Addr
case "cloudsql":
host = cfg.Addr
default:
var err error
host, ppoid, err = net.SplitHostPort(cfg.Addr)
if nil != err {
host = cfg.Addr
} else if host == "" {
host = "localhost"
}
}
s.Host = host
s.PortPathOrID = ppoid
}
|