tracer

Documentation

Overview

Package tracer provides a GORM plugin for distributed tracing using OpenTelemetry.

The tracer plugin creates OpenTelemetry spans for each database operation, recording SQL queries, table names, operation types, and errors as span attributes.

Index

• type Plugin
  • func New(tracer trace.Tracer) *Plugin
  • func (p *Plugin) Initialize(db *gorm.DB) error
  • func (p *Plugin) Name() string

Types

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

Plugin is the GORM tracer plugin.

func New

func New(tracer trace.Tracer) *Plugin

New creates a new tracer plugin.

The tracer parameter should be an OpenTelemetry trace.Tracer. If nil, a default tracer from the global provider will be used.

Example:

import (
    "go.opentelemetry.io/otel"
    tracerplugin "github.com/codesjoy/pkg/basic/xgorm/plugin/tracer"
)

tracer := otel.Tracer("gorm")
tracerPlugin := tracerplugin.New(tracer)
db.Use(tracerPlugin)

func (*Plugin) Initialize

func (p *Plugin) Initialize(db *gorm.DB) error

Initialize registers before/after callbacks for each GORM operation type (create, query, update, delete, raw, row) so that spans are started before execution and ended after execution.

func (*Plugin) Name

func (p *Plugin) Name() string

Name returns the name of the plugin.