splunkgorm

README

Splunk Instrumentation for github.com/jinzhu/gorm

This package provides instrumentation for the github.com/jinzhu/gorm package. The instrumentation is provided by wrapping the splunksql instrumentation.

Getting Started

To start using this instrumentation, replace the use of the gorm.Open function Open from this package. The returned *gorm.DB can then be use as normal with the gorm package.

An example of this can be found here.

Documentation

Overview

Package splunkgorm provides instrumentation for the github.com/jinzhu/gorm package.

Index

• func Open(driverName, dataSourceName string, opts ...splunksql.Option) (*gorm.DB, error)

Examples

• Open

Functions

func Open

func Open(driverName, dataSourceName string, opts ...splunksql.Option) (*gorm.DB, error)

Open opens a traced gorm database connection specified by its database driver name and a driver-specific data source name. The driver must already be registered by the driver package.

Example

package main

import (
	"log"

	"github.com/jinzhu/gorm"

	"github.com/signalfx/splunk-otel-go/instrumentation/github.com/jinzhu/gorm/splunkgorm"
)

func main() {
	// This assumes the instrumented driver,
	// "github.com/signalfx/splunk-otel-go/instrumentation/github.com/jackc/pgx/splunkpgx",
	// is imported. That will ensure the driver and the instrumentation setup
	// for the driver are registered with the appropriate packages.
	db, err := splunkgorm.Open("pgx", "postgres://localhost/db")
	if err != nil {
		log.Fatal(err)
	}
	defer func() {
		if err := db.Close(); err != nil {
			log.Printf("failed to close db: %v", err)
		}
	}()

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

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