database

Documentation

Overview

Example

package main

import (
	"context"

	ddDatabase "github.com/coopnorge/go-datadog-lib/v2/middleware/database"
	mysqlDriver "github.com/go-sql-driver/mysql"
	"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
)

func main() {
	ctx := context.Background()

	dsn := "example.com/users"
	db, err := ddDatabase.RegisterDriverAndOpen("mysql", mysqlDriver.MySQLDriver{}, dsn)
	if err != nil {
		panic(err)
	}

	span, ctx := tracer.StartSpanFromContext(ctx, "http.request")
	defer span.Finish()
	rows, err := db.QueryContext(ctx, "SELECT * FROM users")
	if err != nil {
		span.Finish(tracer.WithError(err))
		panic(err)
	}
	println(rows)
}

Index

• func RegisterDriverAndOpen(driverName string, driver driver.Driver, dsn string, options ...Option) (*sql.DB, error)
• type Option
  • func WithChildSpansOnly(childSpansOnly bool) Option
  • func WithCustomTag(key string, value interface{}) Option
  • func WithIgnoreQueryTypes(ignoredQueryTypes ...string) Option
  • func WithServiceName(serviceName string) Option

Examples

• Package

Functions

func RegisterDriverAndOpen

func RegisterDriverAndOpen(driverName string, driver driver.Driver, dsn string, options ...Option) (*sql.DB, error)

RegisterDriverAndOpen registers the selected driver with the datadog-lib, and opens a connection to the database using the dsn.

Types

type Option

type Option func(cfg *config)

Option allows for overriding our default-config.

func WithChildSpansOnly

func WithChildSpansOnly(childSpansOnly bool) Option

WithChildSpansOnly causes spans to be created only when there is an existing parent span in the Context.

func WithCustomTag

func WithCustomTag(key string, value interface{}) Option

WithCustomTag will attach the value to the span tagged by the key.

func WithIgnoreQueryTypes

func WithIgnoreQueryTypes(ignoredQueryTypes ...string) Option

WithIgnoreQueryTypes specifies the query types for which spans should not be created. Will replace any existing ignored query-types, so it must be an exhaustive list. See available QueryTypes here: https://pkg.go.dev/gopkg.in/DataDog/dd-trace-go.v1/contrib/database/sql#pkg-constants

func WithServiceName

func WithServiceName(serviceName string) Option

WithServiceName overrides the service-name set in environment-variable "DD_SERVICE".