otelsqlx

README

sqlx instrumentation for OpenTelemetry Go

otelsqlx instrumentation records sqlx queries (including Tx and Stmt queries) and reports DBStats metrics.

go get github.com/middleware-labs/opentelemetry-go-extra/otelsqlx

Usage

To instrument sqlx, you need to connect to a database using the API provided by this package:

sqlx	otelsqlx
sqlx.Connect	otelsqlx.Connect
sqlx.ConnectContext	otelsqlx.ConnectContext
sqlx.MustConnect	otelsqlx.MustConnect
sqlx.Open	otelsqlx.Open
sqlx.MustOpen	otelsqlx.MustOpen
sqlx.NewDb	not supported

import (
    "github.com/middleware-labs/opentelemetry-go-extra/otelsqlx"
    semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
    _ "modernc.org/sqlite"
)

db, err := otelsqlx.Open("sqlite", "file::memory:?cache=shared",
	otelsql.WithAttributes(semconv.DBSystemSqlite))
if err != nil {
	panic(err)
}

// db is *sqlx.DB

And then use context-aware API to propagate the active span via context:

var num int
if err := db.QueryRowContext(ctx, "SELECT 42").Scan(&num); err != nil {
	panic(err)
}

See example for details.

Options

otelsqlx accepts all the options from otelsql package, for example:

import (
    "github.com/middleware-labs/opentelemetry-go-extra/otelsqlx"
    semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
    _ "modernc.org/sqlite"
)

db, err := otelsqlx.Open("sqlite", "file::memory:?cache=shared",
	otelsql.WithAttributes(semconv.DBSystemSqlite),
	otelsql.WithDBName("mydb"))

Documentation

Index

• func Connect(driverName, dataSourceName string, opts ...otelsql.Option) (*sqlx.DB, error)
• func ConnectContext(ctx context.Context, driverName, dataSourceName string, opts ...otelsql.Option) (*sqlx.DB, error)
• func MustConnect(driverName, dataSourceName string, opts ...otelsql.Option) *sqlx.DB
• func MustOpen(driverName, dataSourceName string, opts ...otelsql.Option) *sqlx.DB
• func Open(driverName, dataSourceName string, opts ...otelsql.Option) (*sqlx.DB, error)

Functions

func Connect

func Connect(driverName, dataSourceName string, opts ...otelsql.Option) (*sqlx.DB, error)

Connect to a database and verify with a ping.

func ConnectContext

func ConnectContext(
	ctx context.Context, driverName, dataSourceName string, opts ...otelsql.Option,
) (*sqlx.DB, error)

ConnectContext to a database and verify with a ping.

func MustConnect

func MustConnect(driverName, dataSourceName string, opts ...otelsql.Option) *sqlx.DB

MustConnect connects to a database and panics on error.

func MustOpen

func MustOpen(driverName, dataSourceName string, opts ...otelsql.Option) *sqlx.DB

MustOpen is the same as sql.Open, but returns an *sqlx.DB instead and panics on error.

func Open

func Open(driverName, dataSourceName string, opts ...otelsql.Option) (*sqlx.DB, error)

Open is the same as sql.Open, but returns an *sqlx.DB instead.