Merge branch 'main' into cgo_0

open-telemetry · Oct 31, 2024 · b35b7c0 · b35b7c0
2 parents 963e6db + 77e8de9
commit b35b7c0
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,12 @@ OpenTelemetry Go Automatic Instrumentation adheres to [Semantic Versioning](http
 
 ## [Unreleased]
 
+### Changed
+
+- The SDK provided in `go.opentelemtry.io/auto/sdk` now defaults to NoOp behavior for unimplemented methods of the OpenTelemetry API.
+  This is changed from causing a compilation error for unimplemented methods. ([#1230](https://github.com/open-telemetry/opentelemetry-go-instrumentation/pull/1230))
+- The `GetTracerProvider` fucntion in `go.opentelemtry.io/auto/sdk` is renamed to `TracerProvider`. ([#1231](https://github.com/open-telemetry/opentelemetry-go-instrumentation/pull/1231))
+
 ### Fixed
 
 - Sporadic shutdown deadlock. ([#1220](https://github.com/open-telemetry/opentelemetry-go-instrumentation/pull/1220))

diff --git a/internal/test/e2e/autosdk/main.go b/internal/test/e2e/autosdk/main.go
@@ -79,7 +79,7 @@ func main() {
 	// give time for auto-instrumentation to start up
 	time.Sleep(5 * time.Second)
 
-	provider := sdk.GetTracerProvider()
+	provider := sdk.TracerProvider()
 	tracer := provider.Tracer(
 		pkgName,
 		trace.WithInstrumentationVersion(pkgVer),

diff --git a/sdk/example_test.go b/sdk/example_test.go
@@ -5,10 +5,10 @@ package sdk
 
 import "context"
 
-func ExampleGetTracerProvider() {
+func ExampleTracerProvider() {
 	// Get a Tracer from an auto-instrumented TracerProvider so all spans
 	// created will be passed to the auto-instrumentation telemetry pipeline.
-	tracer := GetTracerProvider().Tracer("my.pkg/name")
+	tracer := TracerProvider().Tracer("my.pkg/name")
 
 	// The tracer is used normally to create spans to encapsulate work.
 	_, span := tracer.Start(context.Background(), "do.work")

diff --git a/sdk/trace.go b/sdk/trace.go
@@ -15,23 +15,23 @@ import (
 	"go.opentelemetry.io/otel/codes"
 	semconv "go.opentelemetry.io/otel/semconv/v1.26.0"
 	"go.opentelemetry.io/otel/trace"
-	"go.opentelemetry.io/otel/trace/embedded"
+	"go.opentelemetry.io/otel/trace/noop"
 
 	"go.opentelemetry.io/auto/sdk/telemetry"
 )
 
-// GetTracerProvider returns an auto-instrumentable [trace.TracerProvider].
+// TracerProvider returns an auto-instrumentable [trace.TracerProvider].
 //
 // If an [go.opentelemetry.io/auto.Instrumentation] is configured to instrument
 // the process using the returned TracerProvider, all of the telemetry it
 // produces will be processed and handled by that Instrumentation. By default,
 // if no Instrumentation instruments the TracerProvider it will not generate
 // any trace telemetry.
-func GetTracerProvider() trace.TracerProvider { return tracerProviderInstance }
+func TracerProvider() trace.TracerProvider { return tracerProviderInstance }
 
 var tracerProviderInstance = tracerProvider{}
 
-type tracerProvider struct{ embedded.TracerProvider }
+type tracerProvider struct{ noop.TracerProvider }
 
 var _ trace.TracerProvider = tracerProvider{}
 
@@ -45,7 +45,7 @@ func (p tracerProvider) Tracer(name string, opts ...trace.TracerOption) trace.Tr
 }
 
 type tracer struct {
-	embedded.Tracer
+	noop.Tracer
 
 	name, schemaURL, version string
 }
@@ -140,7 +140,7 @@ func spanKind(kind trace.SpanKind) telemetry.SpanKind {
 }
 
 type span struct {
-	embedded.Span
+	noop.Span
 
 	sampled     bool
 	spanContext trace.SpanContext
@@ -383,4 +383,4 @@ func (s *span) SetName(name string) {
 	s.span.Name = name
 }
 
-func (*span) TracerProvider() trace.TracerProvider { return GetTracerProvider() }
+func (*span) TracerProvider() trace.TracerProvider { return TracerProvider() }
diff --git a/sdk/trace_test.go b/sdk/trace_test.go
@@ -111,7 +111,7 @@ func TestSpanCreation(t *testing.T) {
 
 	ts := time.Now()
 
-	tracer := GetTracerProvider().Tracer(
+	tracer := TracerProvider().Tracer(
 		tracerName,
 		trace.WithInstrumentationVersion(tracerVer),
 		trace.WithSchemaURL(semconv.SchemaURL),