Documentation
¶
Overview ¶
Package gorm provides helper functions for tracing the jinzhu/gorm package (https://github.com/jinzhu/gorm).
Deprecated: The underlying gopkg.in/jinzhu/gorm packages has known security vulnerabilities and is no longer under active development. As such consider this package DEPRECATED. It is highly recommended that you update to the latest version available here as a contrib package "gorm.io/gorm.v1".
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ContextFromDB ¶
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 (github.com/0angelic0/dd-trace-go/contrib/database/sql).Register.
Example ¶
// 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, with the specified service name.
db, err := gormtrace.Open("postgres", "postgres://pqgotest:password@localhost/pqgotest?sslmode=disable", gormtrace.WithServiceName("my-gorm-service"))
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 ¶
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 ¶
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 ¶
WithAnalytics enables Trace Analytics for all started spans.
func WithAnalyticsRate ¶
WithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.
func WithCustomTag ¶
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 ¶
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 ¶
WithServiceName sets the given service name when registering a driver, or opening a database connection.
Source Files