add clarifying comments and describe this in package docs

DataDog · Oct 24, 2023 · de0e0d5 · de0e0d5
1 parent b8a38a6
commit de0e0d5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/ddtrace/opentelemetry/span.go b/ddtrace/opentelemetry/span.go
@@ -25,7 +25,7 @@ import (
 var _ oteltrace.Span = (*span)(nil)
 
 type span struct {
-	noop.Span
+	noop.Span  // https://pkg.go.dev/go.opentelemetry.io/otel/trace#hdr-API_Implementations
 	DD         tracer.Span
 	finished   bool
 	finishOpts []tracer.FinishOption

diff --git a/ddtrace/opentelemetry/tracer.go b/ddtrace/opentelemetry/tracer.go
@@ -23,9 +23,9 @@ var _ oteltrace.Tracer = (*oteltracer)(nil)
 var telemetryTags = []string{`"integration_name":"otel"`}
 
 type oteltracer struct {
-	noop.Tracer
-	provider *TracerProvider
-	DD       ddtrace.Tracer
+	noop.Tracer // https://pkg.go.dev/go.opentelemetry.io/otel/trace#hdr-API_Implementations
+	provider    *TracerProvider
+	DD          ddtrace.Tracer
 }
 
 func (t *oteltracer) Start(ctx context.Context, spanName string, opts ...oteltrace.SpanStartOption) (context.Context, oteltrace.Span) {

diff --git a/ddtrace/opentelemetry/tracer_provider.go b/ddtrace/opentelemetry/tracer_provider.go
@@ -19,7 +19,9 @@
 //	yourCode(ctx)
 //	sp.End()
 //
-// Not every feature provided by OpenTelemetry is supported with this wrapper today.
+// Not every feature provided by OpenTelemetry is supported with this wrapper today, and any new API methods
+// added to the OpenTelemetry API will default to being a no-op until implemented by this library. See the
+// OpenTelemetry package docs for more details: https://pkg.go.dev/go.opentelemetry.io/otel/trace#hdr-API_Implementations.
 // This package seeks to implement a minimal set of functions within
 // the OpenTelemetry Tracing API (https://opentelemetry.io/docs/reference/specification/trace/api)
 // to allow users to send traces to Datadog using existing OpenTelemetry code with minimal changes to the application.
@@ -46,9 +48,9 @@ var _ oteltrace.TracerProvider = (*TracerProvider)(nil)
 // trace computational workflows.
 // WithInstrumentationVersion and WithSchemaURL TracerOptions are not supported.
 type TracerProvider struct {
-	noop.TracerProvider
-	tracer  *oteltracer
-	stopped uint32 // stopped indicates whether the tracerProvider has been shutdown.
+	noop.TracerProvider // https://pkg.go.dev/go.opentelemetry.io/otel/trace#hdr-API_Implementations
+	tracer              *oteltracer
+	stopped             uint32 // stopped indicates whether the tracerProvider has been shutdown.
 	sync.Once
 }