example_test.go

// Copyright Sam Xie
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package otelsql_test

import (
	"database/sql"
	"database/sql/driver"

	semconv "go.opentelemetry.io/otel/semconv/v1.40.0"

	"github.com/XSAM/otelsql"
)

func init() {
	sql.Register("mysql", otelsql.NewMockDriver())
}

var (
	dri      = otelsql.NewMockDriver()
	mysqlDSN = "root:otel_password@db"
)

func ExampleOpen() {
	// Connect to database
	db, err := otelsql.Open("mysql", mysqlDSN)
	if err != nil {
		panic(err)
	}

	defer func() { _ = db.Close() }()
	// Output:
}

func ExampleOpenDB() {
	driverContext, ok := dri.(driver.DriverContext)
	if !ok {
		panic("driver does not implement driver.DriverContext")
	}

	connector, err := driverContext.OpenConnector(mysqlDSN)
	if err != nil {
		panic(err)
	}

	// Connect to database
	db := otelsql.OpenDB(connector)

	defer func() { _ = db.Close() }()
	// Output:
}

func ExampleWrapDriver() {
	otDriver := otelsql.WrapDriver(dri)

	driverContext, ok := otDriver.(driver.DriverContext)
	if !ok {
		panic("driver does not implement driver.DriverContext")
	}

	connector, err := driverContext.OpenConnector(mysqlDSN)
	if err != nil {
		panic(err)
	}

	// Connect to database
	db := sql.OpenDB(connector)

	defer func() { _ = db.Close() }()
	// Output:
}

func ExampleRegister() {
	// Register an OTel driver
	driverName, err := otelsql.Register("mysql")
	if err != nil {
		panic(err)
	}

	// Connect to database
	db, err := sql.Open(driverName, mysqlDSN)
	if err != nil {
		panic(err)
	}

	defer func() { _ = db.Close() }()
	// Output:
}

func ExampleAttributesFromDSN() {
	attrs := append(otelsql.AttributesFromDSN(mysqlDSN), semconv.DBSystemNameMySQL)

	// Connect to database
	db, err := otelsql.Open("mysql", mysqlDSN, otelsql.WithAttributes(
		attrs...,
	))
	if err != nil {
		panic(err)
	}

	// Register DB stats to meter
	reg, err := otelsql.RegisterDBStatsMetrics(db, otelsql.WithAttributes(
		attrs...,
	))
	if err != nil {
		panic(err)
	}

	defer func() {
		_ = db.Close()
		_ = reg.Unregister()
	}()
	// Output:
}