feat: add traces on migrations

Author: gfyrag

migrations/migrator.go

@@ -4,6 +4,9 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/trace"
+	"go.opentelemetry.io/otel/trace/noop"
 	"math"
 	"strconv"
 	"strings"
@@ -42,6 +45,7 @@ type Migrator struct {
 	schema     string
 	tableName  string
 	rootDB     bun.IDB
+	tracer     trace.Tracer
 }
 
 func (m *Migrator) GetSchema() string {
@@ -160,6 +164,11 @@ func (m *Migrator) GetLastVersion(ctx context.Context) (int, error) {
 }
 
 func (m *Migrator) Up(ctx context.Context) error {
+	ctx, span := m.tracer.Start(ctx, "migrations.Up")
+	defer span.End()
+
+	span.SetAttributes(attribute.String("schema", m.GetSchema()))
+
 	for {
 		err := m.UpByOne(ctx)
 		if err != nil {
@@ -414,15 +423,26 @@ func (m *Migrator) upByOne(ctx context.Context, db bun.IDB) error {
 }
 
 func (m *Migrator) UpByOne(ctx context.Context) error {
-	return m.upByOne(ctx, m.rootDB)
+	ctx, span := m.tracer.Start(ctx, "migrations.UpByOne")
+	defer span.End()
+
+	span.SetAttributes(attribute.String("schema", m.GetSchema()))
+
+	err := m.upByOne(ctx, m.rootDB)
+	if err != nil && !errors.Is(err, ErrAlreadyUpToDate) {
+		span.RecordError(err)
+		return err
+	}
+
+	return err
 }
 
 func NewMigrator(db bun.IDB, opts ...Option) *Migrator {
 	ret := &Migrator{
 		rootDB:    db,
 		tableName: migrationTable,
 	}
-	for _, opt := range opts {
+	for _, opt := range append(defaultOptions, opts...) {
 		opt(ret)
 	}
 	return ret
@@ -441,3 +461,13 @@ func WithTableName(name string) Option {
 		m.tableName = name
 	}
 }
+
+func WithTracer(tracer trace.Tracer) Option {
+	return func(m *Migrator) {
+		m.tracer = tracer
+	}
+}
+
+var defaultOptions = []Option{
+	WithTracer(noop.Tracer{}),
+}