gormotel

README

gorm-otel

opentelemetry support for gorm2.

Features

• Record SQL in span logs.
• Record Result in span logs.
• Record Table in span tags.
• Record Error in span tags and logs.
• Register Create Query Delete Update Row Raw tracing callbacks.

Get Started

I assume that you already have an opentelemetry Tracer client started in your project.

func main() {
	var db *gorm.DB
	
	db.Use(gormotel.New())
	
	// if you want to use customized tracer instead of opentelemetry.GlobalTracer() which is default,
	// you can use the option WithTracer(yourTracer)
}

Documentation

Index

• func New(opts ...applyOption) gorm.Plugin
• func WithIgnoreErrNotFound(ignoreErrNotFound bool) applyOption
• func WithLogResult(logResult bool) applyOption
• func WithSqlParameters(logSqlParameters bool) applyOption
• func WithTracerProvider(provider trace.TracerProvider) applyOption

Functions

func New

func New(opts ...applyOption) gorm.Plugin

New constructs a new plugin based opentelemetry. It supports to trace all operations in gorm, so if you have already traced your servers, now this plugin will perfect your tracing job.

func WithIgnoreErrNotFound

func WithIgnoreErrNotFound(ignoreErrNotFound bool) applyOption

func WithLogResult

func WithLogResult(logResult bool) applyOption

WithLogResult enable otelPlugin to log the result of each executed sql.

func WithSqlParameters

func WithSqlParameters(logSqlParameters bool) applyOption

func WithTracerProvider

func WithTracerProvider(provider trace.TracerProvider) applyOption

WithTracerProvider specifies a tracer provider to use for creating a tracer. If none is specified, the global provider is used.