Documentation ¶
Overview ¶
Package gorm provides helper functions for tracing the jinzhu/gorm package (https://github.com/jinzhu/gorm).
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ContextFromDB ¶ added in v1.25.0
ContextFromDB returns any context previously attached to db using WithContext, otherwise returning context.Background.
func Open ¶
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) }
Output:
func WithCallbacks ¶ added in v1.18.0
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 ¶ added in v1.18.0
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 ¶ added in v1.18.0
type Option func(*config)
Option represents an option that can be passed to Register, Open or OpenDB.
func WithAnalytics ¶ added in v1.18.0
WithAnalytics enables Trace Analytics for all started spans.
func WithAnalyticsRate ¶ added in v1.18.0
WithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.
func WithCustomTag ¶ added in v1.27.0
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 ¶ added in v1.29.0
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 ¶ added in v1.18.0
WithServiceName sets the given service name when registering a driver, or opening a database connection.