nrmysql

package module
Version: v1.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 7, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

README

v3/integrations/nrmysql GoDoc

Package nrmysql instruments https://github.com/go-sql-driver/mysql.

import "github.com/newrelic/go-agent/v3/integrations/nrmysql"

For more information, see godocs.

Documentation

Overview

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/v3/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/v3/integrations/nrmysql/example/main.go

Source Files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL