On error save SQL request parameters to span.

collection.go

@@ -8,6 +8,7 @@ import (
 	"git.bit5.ru/backend/meta"
 
 	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/codes"
 )
 
 type DataCollection struct {
@@ -41,7 +42,10 @@ func (coll *DataCollection) Save(ctx context.Context) error {
 	fields := coll.GetDbFields()
 	countFields := len(fields)
 	if countFields == 0 {
-		return errors.New("Fields list is empty")
+		err := errors.New("Fields list is empty")
+		span.RecordError(err)
+		span.SetStatus(codes.Error, err.Error())
+		return err
 	}
 
 	countRows := len(coll.Items)
@@ -60,10 +64,21 @@ func (coll *DataCollection) Save(ctx context.Context) error {
 
 	// NOTE: performance fix: if none of rows have mask we can save all data by one sql query
 	if allDataWithoutMask {
-		return coll.saveWithoutMask(ctx)
+		if err := coll.saveWithoutMask(ctx); err != nil {
+			span.RecordError(err)
+			span.SetStatus(codes.Error, err.Error())
+			return err
+		}
+		return nil
 	}
 
-	return coll.saveByMask(ctx)
+	if err := coll.saveByMask(ctx); err != nil {
+		span.RecordError(err)
+		span.SetStatus(codes.Error, err.Error())
+		return err
+	}
+
+	return nil
 }
 
 func (coll *DataCollection) saveByMask(ctx context.Context) error {
@@ -77,7 +92,8 @@ func (coll *DataCollection) saveByMask(ctx context.Context) error {
 	tableName := coll.GetTableName()
 
 	span.SetAttributes(
-		attribute.String("db.sql.table", tableName),
+		attribute.String("table", tableName),
+		attribute.Int("field_amount", countFields),
 	)
 
 	for _, item := range coll.Items {
@@ -110,7 +126,10 @@ func (coll *DataCollection) saveByMask(ctx context.Context) error {
 				log_len = 200
 			}
 
-			return errors.Errorf("%s (%s)", err.Error(), sqlSmt[0:log_len])
+			resultErr := errors.Errorf("%s (%s)", err.Error(), sqlSmt[0:log_len])
+			span.RecordError(resultErr)
+			span.SetStatus(codes.Error, resultErr.Error())
+			return resultErr
 		}
 	}
 	return nil
@@ -128,7 +147,7 @@ func (coll *DataCollection) saveWithoutMask(ctx context.Context) error {
 	countRows := len(coll.Items)
 
 	span.SetAttributes(
-		attribute.String("db.sql.table", tableName),
+		attribute.String("table", tableName),
 		attribute.Int("field_amount", countFields),
 		attribute.Int("item_amount", countRows),
 	)
@@ -143,7 +162,10 @@ func (coll *DataCollection) saveWithoutMask(ctx context.Context) error {
 		if ownerValue == uint32(0) {
 			rows[start+coll.ownerFieldIndex] = coll.OwnerId
 		} else if ownerValue != coll.OwnerId {
-			return errors.Errorf("Wrong owner_id in %s value %d (!= %d)", tableName, ownerValue, coll.OwnerId)
+			err := errors.Errorf("Wrong owner_id in %s value %d (!= %d)", tableName, ownerValue, coll.OwnerId)
+			span.RecordError(err)
+			span.SetStatus(codes.Error, err.Error())
+			return err
 		}
 		offset++
 	}
@@ -151,7 +173,10 @@ func (coll *DataCollection) saveWithoutMask(ctx context.Context) error {
 	sqlSmt := createInsertSQLForFields(ctx, tableName, fields, countRows)
 	_, err := coll.Db.UpdateBySQL(sqlSmt, rows...).Exec()
 	if err != nil {
-		return errors.Errorf("error: %s, sql: %s", err.Error(), sqlSmt)
+		resultErr := errors.Errorf("error: %s, sql: %s", err.Error(), sqlSmt)
+		span.RecordError(resultErr)
+		span.SetStatus(codes.Error, resultErr.Error())
+		return resultErr
 	}
 	return nil
 }

go.mod

@@ -3,10 +3,11 @@ module git.bit5.ru/backend/dbmeta
 go 1.13
 
 require (
-	git.bit5.ru/backend/db v1.2.3
+	git.bit5.ru/backend/db v1.2.6
 	git.bit5.ru/backend/errors v1.0.0
 	git.bit5.ru/backend/meta v1.0.0
 	github.com/go-logr/stdr v1.2.2
 	github.com/stretchr/testify v1.8.1
 	go.opentelemetry.io/otel v1.11.1
+	go.opentelemetry.io/otel/trace v1.11.1
 )

go.sum

@@ -1,7 +1,7 @@
-git.bit5.ru/backend/db v1.2.3 h1:FYGUbu7nYMny9CoTU6oLrJuQdn+xG42cAHkWI6JLGgE=
-git.bit5.ru/backend/db v1.2.3/go.mod h1:2PB9QennBZaH8u5i3IvnuVaWnAK5Ck5kCrJ9+5ZnQp8=
-git.bit5.ru/backend/dbr v1.2.0 h1:SQndOC9KW/jPGRSFSPYRqmMd+EHEyZHWDO9B+imEEzU=
-git.bit5.ru/backend/dbr v1.2.0/go.mod h1:3iCyHEkyj2M+lx3fSlv3lC1r5cLZZz+6QLVCml7ZAy8=
+git.bit5.ru/backend/db v1.2.6 h1:ANfRTQ+C4BaMKbG+7onjET7qCcsFwq71dbolt0Po7Y4=
+git.bit5.ru/backend/db v1.2.6/go.mod h1:+1VkFgSf3zkGlHmG3gw5HyWBoucZDQ+bixQ6rpO6AqU=
+git.bit5.ru/backend/dbr v1.3.1 h1:O3fy+aztnNVzto/nMcydd9BVahAJTXPE8VuGY3dC1NY=
+git.bit5.ru/backend/dbr v1.3.1/go.mod h1:oVVFv6hIzFkO4Wy0KcS4CYqkBjW1kFHYNLcmKmDlPow=
 git.bit5.ru/backend/errors v1.0.0 h1:WWJ0sly44q1HQjN01X75ZAGKZwwY5Ml+XVDXMjCkToA=
 git.bit5.ru/backend/errors v1.0.0/go.mod h1:75faRwsnpM0Se00/Bh7fysWQXV8oMjNJFQ6f7+r9k3Y=
 git.bit5.ru/backend/meta v1.0.0 h1:1mZgEoOSA/P+IrnKkoiULpFUFX3JxyxGU6OXVn7j2kY=

save.go

@@ -12,7 +12,9 @@ import (
 
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/codes"
 	semconv "go.opentelemetry.io/otel/semconv/v1.12.0"
+	"go.opentelemetry.io/otel/trace"
 )
 
 const tracerName = "git.bit5.ru/backend/dbmeta"
@@ -48,6 +50,8 @@ func SaveRow(ctx context.Context, db *db.DBC, dataItem meta.IMetaStruct) error {
 
 	info, err := makeDataRowInfo(dataItem)
 	if err != nil {
+		span.RecordError(err)
+		span.SetStatus(codes.Error, err.Error())
 		return err
 	}
 
@@ -76,25 +80,46 @@ func SaveRow(ctx context.Context, db *db.DBC, dataItem meta.IMetaStruct) error {
 	}
 
 	if len(fields) == 0 {
-		return errors.New("Fields list is empty")
+		err := errors.New("Fields list is empty")
+		span.RecordError(err)
+		span.SetStatus(codes.Error, err.Error())
+		return err
 	}
 
 	tableName := info.tableName
 	sqlSmt := createInsertSQLForFields(ctx, tableName, fields, 1 /*one_row*/)
 
 	span.SetAttributes(
+		semconv.DBSystemKey.String("mysql"),
 		semconv.DBSQLTableKey.String(tableName),
 		semconv.DBStatementKey.String(sqlSmt),
+		semconv.DBOperationKey.String("INSERT"),
 	)
 
 	updateBuilder := db.UpdateBySQL(sqlSmt, params...)
 
-	res, err := updateBuilder.Exec()
+	res, err := updateBuilder.ExecContext(ctx)
 	if err != nil {
 		if len(sqlSmt) > 200 {
 			sqlSmt = sqlSmt[0:200]
 		}
-		return errors.Errorf("%s (%s)", err.Error(), sqlSmt)
+
+		span.SetAttributes(
+			attribute.Int("sql_param_amount", len(params)),
+		)
+
+		// Convert SQL request parameters to slice of strings.
+		paramStrs := convertInterfacesToStrings(ctx, params)
+		if len(paramStrs) > 0 {
+			span.SetAttributes(
+				attribute.StringSlice("sql_params", paramStrs),
+			)
+		}
+
+		resultErr := errors.Errorf("Can not execute SaveRow. Got error from updateBuilder.ExecContext. %s (%s)", err.Error(), sqlSmt)
+		span.RecordError(resultErr)
+		span.SetStatus(codes.Error, resultErr.Error())
+		return resultErr
 	}
 
 	insertId, _ := res.LastInsertId()
@@ -105,6 +130,20 @@ func SaveRow(ctx context.Context, db *db.DBC, dataItem meta.IMetaStruct) error {
 	return nil
 }
 
+func convertInterfacesToStrings(ctx context.Context, items []interface{}) []string {
+	itemAmount := len(items)
+	if itemAmount == 0 {
+		return nil
+	}
+
+	strs := make([]string, itemAmount)
+	for i, item := range items {
+		strs[i] = fmt.Sprint(item)
+	}
+
+	return strs
+}
+
 func SaveMetaRootStruct(
 	ctx context.Context,
 	db *db.DBC,
@@ -114,7 +153,11 @@ func SaveMetaRootStruct(
 	deltaSave bool,
 ) error {
 
-	ctx, span := tracer.Start(ctx, "SaveMetaRootStruct")
+	spanAttrs := trace.WithAttributes(
+		attribute.Int64("owner.id", int64(ownerId)),
+	)
+
+	ctx, span := tracer.Start(ctx, "SaveMetaRootStruct", spanAttrs)
 	defer span.End()
 
 	dataItem := reflect.ValueOf(data)
@@ -164,11 +207,15 @@ func SaveMetaRootStruct(
 		switch tfield.Kind() {
 		case reflect.Slice:
 			if err := SaveMetaCollection(ctx, db, dataItem.Field(i), ownerId, removedIds, deltaSave); err != nil {
+				span.RecordError(err)
+				span.SetStatus(codes.Error, err.Error())
 				return errors.WithMessagef(err, "Can not execute SaveMetaRootStruct. Got error from SaveMetaCollection. ownerId: %d.", ownerId)
 			}
 			break
 		case reflect.Struct:
 			if err := saveStruct(ctx, db, dataItem.Field(i), ownerId); err != nil {
+				span.RecordError(err)
+				span.SetStatus(codes.Error, err.Error())
 				return errors.WithMessagef(err, "Can not execute SaveMetaRootStruct. Got error from saveStruct. ownerId: %d.", ownerId)
 			}
 			break
@@ -185,7 +232,12 @@ func SaveMetaRootStruct(
 	return nil
 }
 
-func saveStruct(ctx context.Context, db *db.DBC, dataItem reflect.Value, ownerId uint32) error {
+func saveStruct(
+	ctx context.Context,
+	db *db.DBC,
+	dataItem reflect.Value,
+	ownerId uint32,
+) error {
 
 	ctx, span := tracer.Start(ctx, "saveStruct")
 	defer span.End()
@@ -201,14 +253,20 @@ func saveStruct(ctx context.Context, db *db.DBC, dataItem reflect.Value, ownerId
 		row, _ = dataItem.Addr().Interface().(meta.IMetaStruct)
 	}
 	if row == nil {
-		return errors.Errorf("Couldn't convert to IMetaStruct: %s", mType.Name())
+		err := errors.Errorf("Couldn't convert to IMetaStruct: %s", mType.Name())
+		span.RecordError(err)
+		span.SetStatus(codes.Error, err.Error())
+		return err
 	}
 
 	props := *row.CLASS_PROPS()
 	if ownerField, ok := props["owner"]; ok {
 		field := dataItem.FieldByName(strings.Title(ownerField))
 		if !field.IsValid() {
-			return errors.Errorf("Owner field \"%s\" is not found in struct \"%s\"", ownerField, mType.Name())
+			err := errors.Errorf("Owner field \"%s\" is not found in struct \"%s\"", ownerField, mType.Name())
+			span.RecordError(err)
+			span.SetStatus(codes.Error, err.Error())
+			return err
 		}
 
 		// enforcing ownerId
@@ -218,17 +276,34 @@ func saveStruct(ctx context.Context, db *db.DBC, dataItem reflect.Value, ownerId
 
 	}
 
-	return SaveRow(ctx, db, row)
+	if err := SaveRow(ctx, db, row); err != nil {
+		span.RecordError(err)
+		span.SetStatus(codes.Error, err.Error())
+		return errors.WithMessagef(err, "Can not execute saveStruct. Got error from SaveRow. ownerId: %d.", ownerId)
+	}
+
+	return nil
 }
 
-func SaveMetaCollection(ctx context.Context, db *db.DBC, slice reflect.Value, ownerId uint32, removedIds meta.IRemovedIds, deltaSave bool) error {
+func SaveMetaCollection(
+	ctx context.Context,
+	db *db.DBC,
+	slice reflect.Value,
+	ownerId uint32,
+	removedIds meta.IRemovedIds,
+	deltaSave bool,
+) error {
 
 	ctx, span := tracer.Start(ctx, "SaveMetaCollection")
 	defer span.End()
 
 	if slice.Type().Kind() != reflect.Slice {
-		return errors.Errorf("It isn't slice: %s", slice.Type().Kind())
+		err := errors.Errorf("It isn't slice: %s", slice.Type().Kind())
+		span.RecordError(err)
+		span.SetStatus(codes.Error, err.Error())
+		return err
 	}
+
 	sliceItem := reflect.New(slice.Type().Elem().Elem())
 	if sliceItem.Type().Kind() != reflect.Ptr {
 		sliceItem = sliceItem.Addr()
@@ -240,29 +315,42 @@ func SaveMetaCollection(ctx context.Context, db *db.DBC, slice reflect.Value, ow
 	}
 
 	if row == nil {
-		return errors.Errorf("Couldn't convert to IMetaStruct: %s", sliceItem.Kind())
+		err := errors.Errorf("Couldn't convert to IMetaStruct: %s", sliceItem.Kind())
+		span.RecordError(err)
+		span.SetStatus(codes.Error, err.Error())
+		return err
 	}
 
 	item, _ := sliceItem.Interface().(meta.IMetaDataItem)
 	if item == nil {
-		return errors.Errorf("Couldn't convert to IMetaDataItem: %s", slice.Type())
+		err := errors.Errorf("Couldn't convert to IMetaDataItem: %s", slice.Type())
+		span.RecordError(err)
+		span.SetStatus(codes.Error, err.Error())
+		return err
 	}
 
 	if !deltaSave {
 		cond := fmt.Sprintf("`%s`=%d ", item.GetOwnerFieldName(), ownerId)
 		_, err := db.DeleteFrom(item.GetDbTableName()).Where(cond).Exec()
 		if err != nil {
+			span.RecordError(err)
+			span.SetStatus(codes.Error, err.Error())
 			return err
 		}
 	}
 
 	collection, err := NewDataCollection(db, ownerId, "", item)
 	if err != nil {
+		span.RecordError(err)
+		span.SetStatus(codes.Error, err.Error())
 		return err
 	}
+
 	for ind := 0; ind < slice.Len(); ind++ {
 		ind_item, err := convertToIdataItem(slice.Index(ind))
 		if err != nil {
+			span.RecordError(err)
+			span.SetStatus(codes.Error, err.Error())
 			return err
 		}
 		// NOTE: we don't check here for error on purpose, here it's considered to be OK
@@ -270,6 +358,8 @@ func SaveMetaCollection(ctx context.Context, db *db.DBC, slice reflect.Value, ow
 	}
 
 	if err := collection.Save(ctx); err != nil {
+		span.RecordError(err)
+		span.SetStatus(codes.Error, err.Error())
 		return err
 	}
 
@@ -279,6 +369,8 @@ func SaveMetaCollection(ctx context.Context, db *db.DBC, slice reflect.Value, ow
 		if removedIds.HasList(classId) {
 			err := deleteByIds(db, ownerId, item, removedIds.GetList(classId))
 			if err != nil {
+				span.RecordError(err)
+				span.SetStatus(codes.Error, err.Error())
 				return err
 			}
 		}