comments

CHANGELOG.md

@@ -1,3 +1,4 @@
+* Added experimental package `spans` with tracing adapter interfaces for OpenTelemetry, OpenTracing, etc.
 * Added `db.Topic().DescribeTopicConsumer()` method for displaying consumer information
 * Marked as deprecated options `ydb.WithDatabase(database)` and `ydb.WithEndpoint(endpoint)`
 

spans/spans.go

@@ -8,8 +8,13 @@ import (
 )
 
 type (
+	// KeyValue is key-value attribute for attaching into span
 	KeyValue = kv.KeyValue
-	Span     interface {
+
+	// Span is an interface of spans in specific tracing system
+	//
+	// Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
+	Span interface {
 		TraceID() (_ string, valid bool)
 
 		Link(link Span, attributes ...KeyValue)
@@ -20,6 +25,10 @@ type (
 
 		End(attributes ...KeyValue)
 	}
+
+	// Adapter is interface of specific tracing system adapters
+	//
+	// Experimental: https://github.com/ydb-platform/ydb-go-sdk/blob/master/VERSIONING.md#experimental
 	Adapter interface {
 		trace.Detailer