gorm

Documentation

Overview

Package gorm provides helper functions for tracing the jinzhu/gorm package (https://github.com/jinzhu/gorm).

Deprecated: The underlying github.com/jinzhu/gorm packages has known security vulnerabilities and is no longer under active development. It is highly recommended that you update to the latest version available here as a contrib package "gorm.io/gorm.v1".

Index

• func ContextFromDB(db *gorm.DB) context.Context
• func Open(dialect, source string, opts ...Option) (*gorm.DB, error)
• func WithCallbacks(db *gorm.DB, opts ...Option) *gorm.DB
• func WithContext(ctx context.Context, db *gorm.DB) *gorm.DB
• type Option
  • func WithAnalytics(on bool) Option
  • func WithAnalyticsRate(rate float64) Option
  • func WithCustomTag(tag string, tagFn func(scope *gorm.Scope) interface{}) Option
  • func WithErrorCheck(fn func(err error) bool) Option
  • func WithServiceName(name string) Option

Examples

• Open

Functions

func ContextFromDB

func ContextFromDB(db *gorm.DB) context.Context

ContextFromDB returns any context previously attached to db using WithContext, otherwise returning context.Background.

func Open

func Open(dialect, source string, opts ...Option) (*gorm.DB, error)

Open opens a new (traced) database connection. The used dialect must be formerly registered using (gopkg.in/DataDog/dd-trace-go.v1/contrib/database/sql).Register.

Example

package main

import (
	"log"

	sqltrace "gopkg.in/DataDog/dd-trace-go.v1/contrib/database/sql"
	gormtrace "gopkg.in/DataDog/dd-trace-go.v1/contrib/jinzhu/gorm"

	"github.com/jinzhu/gorm"
	"github.com/lib/pq"
)

func main() {
	// Register augments the provided driver with tracing, enabling it to be loaded by gormtrace.Open.
	sqltrace.Register("postgres", &pq.Driver{}, sqltrace.WithServiceName("my-service"))

	// Open the registered driver, allowing all uses of the returned *gorm.DB to be traced.
	db, err := gormtrace.Open("postgres", "postgres://pqgotest:password@localhost/pqgotest?sslmode=disable")
	defer db.Close()
	if err != nil {
		log.Fatal(err)
	}

	user := struct {
		gorm.Model
		Name string
	}{}

	// All calls through gorm.DB are now traced.
	db.Where("name = ?", "jinzhu").First(&user)
}

func WithCallbacks

func WithCallbacks(db *gorm.DB, opts ...Option) *gorm.DB

WithCallbacks registers callbacks to the gorm.DB for tracing. It should be called once, after opening the db. The callbacks are triggered by Create, Update, Delete, Query and RowQuery operations.

func WithContext

func WithContext(ctx context.Context, db *gorm.DB) *gorm.DB

WithContext attaches the specified context to the given db. The context will be used as a basis for creating new spans. An example use case is providing a context which contains a span to be used as a parent.

Types

type Option

type Option func(*config)

Option represents an option that can be passed to Register, Open or OpenDB.

func WithAnalytics

func WithAnalytics(on bool) Option

WithAnalytics enables Trace Analytics for all started spans.

func WithAnalyticsRate

func WithAnalyticsRate(rate float64) Option

WithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.

func WithCustomTag

func WithCustomTag(tag string, tagFn func(scope *gorm.Scope) interface{}) Option

WithCustomTag will cause the given tagFn to be evaluated after executing a query and attach the result to the span tagged by the key.

func WithErrorCheck

func WithErrorCheck(fn func(err error) bool) Option

WithErrorCheck specifies a function fn which determines whether the passed error should be marked as an error. The fn is called whenever a gorm operation finishes with an error

func WithServiceName

func WithServiceName(name string) Option

WithServiceName sets the given service name when registering a driver, or opening a database connection.