otelsql

README

OpenTelemetry Go instrumentation for database/sql package

Moved to https://github.com/uptrace/opentelemetry-go-extra/tree/main/otelsql

Documentation

Index

• func Open(driverName, dsn string, opts ...Option) (*sql.DB, error)
• func OpenDB(connector driver.Connector, opts ...Option) *sql.DB
• func PatchDB(db *sql.DB, dsn string, opts ...Option) (*sql.DB, error)
• func ReportDBStatsMetrics(db *sql.DB, opts ...Option)
• type Option
  • func WithAttributes(attrs ...attribute.KeyValue) Option
  • func WithDBName(name string) Option
  • func WithDBSystem(system string) Option
  • func WithMeter(meter metric.Meter) Option
  • func WithTracerProvider(provider trace.TracerProvider) Option

Functions

func Open

func Open(driverName, dsn string, opts ...Option) (*sql.DB, error)

Open is a wrapper over sql.Open that instruments the sql.DB to record executed queries using OpenTelemetry API.

func OpenDB

func OpenDB(connector driver.Connector, opts ...Option) *sql.DB

OpenDB is a wrapper over sql.OpenDB that instruments the sql.DB to record executed queries using OpenTelemetry API.

func PatchDB

func PatchDB(db *sql.DB, dsn string, opts ...Option) (*sql.DB, error)

func ReportDBStatsMetrics

func ReportDBStatsMetrics(db *sql.DB, opts ...Option)

ReportDBStatsMetrics reports DBStats metrics using OpenTelemetry Metrics API.

Types

type Option

type Option func(c *config)

func WithAttributes

func WithAttributes(attrs ...attribute.KeyValue) Option

WithAttributes configures attributes that are used to create a span.

func WithDBName

func WithDBName(name string) Option

WithDBName configures a db.name attribute.

func WithDBSystem

func WithDBSystem(system string) Option

WithDBSystem configures a db.system attribute. You should prefer using WithAttributes and semconv, for example, `otelsql.WithAttributes(semconv.DBSystemSqlite)`.

func WithMeter

func WithMeter(meter metric.Meter) Option

WithMeter configures a metric.Meter used to create instruments.

func WithTracerProvider

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider configures a tracer provider that is used to create a tracer.