feat: update OpenTelemetry hook to use the latest semconv (#713)

Signed-off-by: Sahid Velji <[email protected]>

Author: sahidvelji

hooks/open-telemetry/go.mod

@@ -4,11 +4,11 @@ go 1.23.0
 
 require (
 	github.com/open-feature/go-sdk v1.15.1
-	go.opentelemetry.io/otel v1.36.0
-	go.opentelemetry.io/otel/metric v1.36.0
-	go.opentelemetry.io/otel/sdk v1.36.0
-	go.opentelemetry.io/otel/sdk/metric v1.36.0
-	go.opentelemetry.io/otel/trace v1.36.0
+	go.opentelemetry.io/otel v1.37.0
+	go.opentelemetry.io/otel/metric v1.37.0
+	go.opentelemetry.io/otel/sdk v1.37.0
+	go.opentelemetry.io/otel/sdk/metric v1.37.0
+	go.opentelemetry.io/otel/trace v1.37.0
 )
 
 require (

hooks/open-telemetry/go.sum

@@ -17,16 +17,16 @@ github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOf
 github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA=
 go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A=
-go.opentelemetry.io/otel v1.36.0 h1:UumtzIklRBY6cI/lllNZlALOF5nNIzJVb16APdvgTXg=
-go.opentelemetry.io/otel v1.36.0/go.mod h1:/TcFMXYjyRNh8khOAO9ybYkqaDBb/70aVwkNML4pP8E=
-go.opentelemetry.io/otel/metric v1.36.0 h1:MoWPKVhQvJ+eeXWHFBOPoBOi20jh6Iq2CcCREuTYufE=
-go.opentelemetry.io/otel/metric v1.36.0/go.mod h1:zC7Ks+yeyJt4xig9DEw9kuUFe5C3zLbVjV2PzT6qzbs=
-go.opentelemetry.io/otel/sdk v1.36.0 h1:b6SYIuLRs88ztox4EyrvRti80uXIFy+Sqzoh9kFULbs=
-go.opentelemetry.io/otel/sdk v1.36.0/go.mod h1:+lC+mTgD+MUWfjJubi2vvXWcVxyr9rmlshZni72pXeY=
-go.opentelemetry.io/otel/sdk/metric v1.36.0 h1:r0ntwwGosWGaa0CrSt8cuNuTcccMXERFwHX4dThiPis=
-go.opentelemetry.io/otel/sdk/metric v1.36.0/go.mod h1:qTNOhFDfKRwX0yXOqJYegL5WRaW376QbB7P4Pb0qva4=
-go.opentelemetry.io/otel/trace v1.36.0 h1:ahxWNuqZjpdiFAyrIoQ4GIiAIhxAunQR6MUoKrsNd4w=
-go.opentelemetry.io/otel/trace v1.36.0/go.mod h1:gQ+OnDZzrybY4k4seLzPAWNwVBBVlF2szhehOBB/tGA=
+go.opentelemetry.io/otel v1.37.0 h1:9zhNfelUvx0KBfu/gb+ZgeAfAgtWrfHJZcAqFC228wQ=
+go.opentelemetry.io/otel v1.37.0/go.mod h1:ehE/umFRLnuLa/vSccNq9oS1ErUlkkK71gMcN34UG8I=
+go.opentelemetry.io/otel/metric v1.37.0 h1:mvwbQS5m0tbmqML4NqK+e3aDiO02vsf/WgbsdpcPoZE=
+go.opentelemetry.io/otel/metric v1.37.0/go.mod h1:04wGrZurHYKOc+RKeye86GwKiTb9FKm1WHtO+4EVr2E=
+go.opentelemetry.io/otel/sdk v1.37.0 h1:ItB0QUqnjesGRvNcmAcU0LyvkVyGJ2xftD29bWdDvKI=
+go.opentelemetry.io/otel/sdk v1.37.0/go.mod h1:VredYzxUvuo2q3WRcDnKDjbdvmO0sCzOvVAiY+yUkAg=
+go.opentelemetry.io/otel/sdk/metric v1.37.0 h1:90lI228XrB9jCMuSdA0673aubgRobVZFhbjxHHspCPc=
+go.opentelemetry.io/otel/sdk/metric v1.37.0/go.mod h1:cNen4ZWfiD37l5NhS+Keb5RXVWZWpRE+9WyVCpbo5ps=
+go.opentelemetry.io/otel/trace v1.37.0 h1:HLdcFNbRQBE2imdSEgm/kwqmQj1Or1l/7bW6mxVK7z4=
+go.opentelemetry.io/otel/trace v1.37.0/go.mod h1:TlgrlQ+PtQO5XFerSPUYG0JSgGyryXewPGyayAWSBS0=
 go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
 go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
 go.uber.org/mock v0.5.2 h1:LbtPTcP8A5k9WPXj54PPPbjcI4Y6lhyOZXn+VS7wNko=

hooks/open-telemetry/pkg/common_test.go

@@ -7,35 +7,43 @@ import (
 
 // test commons
 
-var scopeKey = "scope"
-var scopeValue = "7c34165e-fbef-11ed-be56-0242ac120002"
-var scopeDescription = DimensionDescription{
-	Key:  scopeKey,
-	Type: String,
-}
+var (
+	scopeKey         = "scope"
+	scopeValue       = "7c34165e-fbef-11ed-be56-0242ac120002"
+	scopeDescription = DimensionDescription{
+		Key:  scopeKey,
+		Type: String,
+	}
+)
 
-var stageKey = "stage"
-var stageValue = 1
-var stageDescription = DimensionDescription{
-	Key:  stageKey,
-	Type: Int,
-}
+var (
+	stageKey         = "stage"
+	stageValue       = 1
+	stageDescription = DimensionDescription{
+		Key:  stageKey,
+		Type: Int,
+	}
+)
 
-var scoreKey = "score"
-var scoreValue = 4.5
-var scoreDescription = DimensionDescription{
-	Key:  scoreKey,
-	Type: Float,
-}
+var (
+	scoreKey         = "score"
+	scoreValue       = 4.5
+	scoreDescription = DimensionDescription{
+		Key:  scoreKey,
+		Type: Float,
+	}
+)
 
-var cachedKey = "cached"
-var cacheValue = false
-var cachedDescription = DimensionDescription{
-	Key:  cachedKey,
-	Type: Bool,
-}
+var (
+	cachedKey         = "cached"
+	cacheValue        = false
+	cachedDescription = DimensionDescription{
+		Key:  cachedKey,
+		Type: Bool,
+	}
+)
 
-var evalMetadata = map[string]interface{}{
+var evalMetadata = map[string]any{
 	scopeKey:  scopeValue,
 	stageKey:  stageValue,
 	scoreKey:  scoreValue,

hooks/open-telemetry/pkg/metrics.go

@@ -6,57 +6,55 @@ import (
 	"github.com/open-feature/go-sdk/openfeature"
 	"go.opentelemetry.io/otel"
 	"go.opentelemetry.io/otel/attribute"
-	api "go.opentelemetry.io/otel/metric"
-	semconv "go.opentelemetry.io/otel/semconv/v1.18.0"
+	"go.opentelemetry.io/otel/metric"
+	semconv "go.opentelemetry.io/otel/semconv/v1.34.0"
 )
 
 const (
-	meterName = "go.openfeature.dev"
-
 	evaluationActive   = "feature_flag.evaluation_active_count"
 	evaluationRequests = "feature_flag.evaluation_requests_total"
 	evaluationSuccess  = "feature_flag.evaluation_success_total"
 	evaluationErrors   = "feature_flag.evaluation_error_total"
 )
 
 type MetricsHook struct {
-	activeCounter  api.Int64UpDownCounter
-	requestCounter api.Int64Counter
-	successCounter api.Int64Counter
-	errorCounter   api.Int64Counter
+	activeCounter  metric.Int64UpDownCounter
+	requestCounter metric.Int64Counter
+	successCounter metric.Int64Counter
+	errorCounter   metric.Int64Counter
 
 	flagEvalMetadataDimensions []DimensionDescription
 	attributeMapperCallback    func(openfeature.FlagMetadata) []attribute.KeyValue
 }
 
 var _ openfeature.Hook = &MetricsHook{}
 
-// NewMetricsHook builds a metric hook backed by a globally set metric.MeterProvider.
-// Use otel.SetMeterProvider to set the global provider or use NewMetricsHookForProvider.
+// NewMetricsHook builds a metric hook backed by a globally set [metric.MeterProvider].
+// Use [otel.SetMeterProvider] to set the global provider or use [NewMetricsHookForProvider].
 func NewMetricsHook(opts ...MetricOptions) (*MetricsHook, error) {
 	return NewMetricsHookForProvider(otel.GetMeterProvider(), opts...)
 }
 
-// NewMetricsHookForProvider builds a metric hook backed by metric.MeterProvider.
-func NewMetricsHookForProvider(provider api.MeterProvider, opts ...MetricOptions) (*MetricsHook, error) {
-	meter := provider.Meter(meterName)
+// NewMetricsHookForProvider builds a metric hook backed by [metric.MeterProvider].
+func NewMetricsHookForProvider(provider metric.MeterProvider, opts ...MetricOptions) (*MetricsHook, error) {
+	meter := provider.Meter(ScopeName)
 
-	activeCounter, err := meter.Int64UpDownCounter(evaluationActive, api.WithDescription("active flag evaluations counter"))
+	activeCounter, err := meter.Int64UpDownCounter(evaluationActive, metric.WithDescription("active flag evaluations counter"))
 	if err != nil {
 		return nil, err
 	}
 
-	evalCounter, err := meter.Int64Counter(evaluationRequests, api.WithDescription("feature flag evaluation request counter"))
+	evalCounter, err := meter.Int64Counter(evaluationRequests, metric.WithDescription("feature flag evaluation request counter"))
 	if err != nil {
 		return nil, err
 	}
 
-	successCounter, err := meter.Int64Counter(evaluationSuccess, api.WithDescription("feature flag evaluation success counter"))
+	successCounter, err := meter.Int64Counter(evaluationSuccess, metric.WithDescription("feature flag evaluation success counter"))
 	if err != nil {
 		return nil, err
 	}
 
-	errorCounter, err := meter.Int64Counter(evaluationErrors, api.WithDescription("feature flag evaluation error counter"))
+	errorCounter, err := meter.Int64Counter(evaluationErrors, metric.WithDescription("feature flag evaluation error counter"))
 	if err != nil {
 		return nil, err
 	}
@@ -78,10 +76,10 @@ func NewMetricsHookForProvider(provider api.MeterProvider, opts ...MetricOptions
 func (h *MetricsHook) Before(ctx context.Context, hCtx openfeature.HookContext,
 	hint openfeature.HookHints,
 ) (*openfeature.EvaluationContext, error) {
-	h.activeCounter.Add(ctx, +1, api.WithAttributes(semconv.FeatureFlagKey(hCtx.FlagKey())))
+	h.activeCounter.Add(ctx, 1, metric.WithAttributes(semconv.FeatureFlagKey(hCtx.FlagKey())))
 
 	h.requestCounter.Add(ctx, 1,
-		api.WithAttributes(
+		metric.WithAttributes(
 			semconv.FeatureFlagKey(hCtx.FlagKey()),
 			semconv.FeatureFlagProviderName(hCtx.ProviderMetadata().Name)))
 
@@ -97,7 +95,7 @@ func (h *MetricsHook) After(ctx context.Context, hCtx openfeature.HookContext,
 	}
 
 	if details.Variant != "" {
-		attribs = append(attribs, semconv.FeatureFlagVariant(details.Variant))
+		attribs = append(attribs, semconv.FeatureFlagResultVariant(details.Variant))
 	}
 
 	if details.Reason != "" {
@@ -110,21 +108,23 @@ func (h *MetricsHook) After(ctx context.Context, hCtx openfeature.HookContext,
 		attribs = append(attribs, h.attributeMapperCallback(details.FlagMetadata)...)
 	}
 
-	h.successCounter.Add(ctx, 1, api.WithAttributes(attribs...))
+	h.successCounter.Add(ctx, 1, metric.WithAttributes(attribs...))
 
 	return nil
 }
 
 func (h *MetricsHook) Error(ctx context.Context, hCtx openfeature.HookContext, err error, hint openfeature.HookHints) {
 	h.errorCounter.Add(ctx, 1,
-		api.WithAttributes(
+		metric.WithAttributes(
 			semconv.FeatureFlagKey(hCtx.FlagKey()),
 			semconv.FeatureFlagProviderName(hCtx.ProviderMetadata().Name),
-			attribute.String(semconv.ExceptionEventName, err.Error())))
+			semconv.ErrorMessage(err.Error()),
+		),
+	)
 }
 
 func (h *MetricsHook) Finally(ctx context.Context, hCtx openfeature.HookContext, flagEvaluationDetails openfeature.InterfaceEvaluationDetails, hint openfeature.HookHints) {
-	h.activeCounter.Add(ctx, -1, api.WithAttributes(semconv.FeatureFlagKey(hCtx.FlagKey())))
+	h.activeCounter.Add(ctx, -1, metric.WithAttributes(semconv.FeatureFlagKey(hCtx.FlagKey())))
 }
 
 // Extra options for metrics hook
@@ -150,23 +150,23 @@ type DimensionDescription struct {
 }
 
 // WithFlagMetadataDimensions allows configuring extra dimensions for feature_flag.evaluation_success_total metric.
-// If provided, dimensions will be extracted from openfeature.FlagMetadata & added to the metric with the same key
+// If provided, dimensions will be extracted from [openfeature.FlagMetadata] & added to the metric with the same key.
 func WithFlagMetadataDimensions(descriptions ...DimensionDescription) MetricOptions {
 	return func(metricsHook *MetricsHook) {
 		metricsHook.flagEvalMetadataDimensions = descriptions
 	}
 }
 
-// WithMetricsAttributeSetter allows to set a extractionCallback which accept openfeature.FlagMetadata and returns
+// WithMetricsAttributeSetter allows to set a extractionCallback which accepts a [openfeature.FlagMetadata] and returns
 // []attribute.KeyValue derived from those metadata.
 func WithMetricsAttributeSetter(callback func(openfeature.FlagMetadata) []attribute.KeyValue) MetricOptions {
 	return func(metricsHook *MetricsHook) {
 		metricsHook.attributeMapperCallback = callback
 	}
 }
 
-// descriptionsToAttributes is a helper to extract dimensions from openfeature.FlagMetadata. Missing metadata
-// dimensions are ignore.
+// descriptionsToAttributes is a helper to extract dimensions from [openfeature.FlagMetadata]. Missing metadata
+// dimensions are ignored.
 func descriptionsToAttributes(metadata openfeature.FlagMetadata, descriptions []DimensionDescription) []attribute.KeyValue {
 	attribs := []attribute.KeyValue{}
 	for _, dimension := range descriptions {

hooks/open-telemetry/pkg/metrics_test.go

@@ -20,7 +20,7 @@ func TestMetricsHook_BeforeStage(t *testing.T) {
 
 	ctx := context.Background()
 
-	hookHints := openfeature.NewHookHints(map[string]interface{}{})
+	hookHints := openfeature.NewHookHints(map[string]any{})
 
 	metricsHook, err := NewMetricsHookForProvider(metric.NewMeterProvider(metric.WithReader(manualReader)))
 	if err != nil {
@@ -71,7 +71,7 @@ func TestMetricsHook_AfterStage(t *testing.T) {
 			ResolutionDetail: openfeature.ResolutionDetail{},
 		},
 	}
-	hookHints := openfeature.NewHookHints(map[string]interface{}{})
+	hookHints := openfeature.NewHookHints(map[string]any{})
 
 	metricsHook, err := NewMetricsHookForProvider(metric.NewMeterProvider(metric.WithReader(manualReader)))
 	if err != nil {
@@ -119,7 +119,7 @@ func TestMetricsHook_ErrorStage(t *testing.T) {
 	ctx := context.Background()
 
 	evalError := errors.New("some eval error")
-	hookHints := openfeature.NewHookHints(map[string]interface{}{})
+	hookHints := openfeature.NewHookHints(map[string]any{})
 
 	metricsHook, err := NewMetricsHookForProvider(metric.NewMeterProvider(metric.WithReader(manualReader)))
 	if err != nil {
@@ -181,7 +181,7 @@ func TestMetricsHook_FinallyStage(t *testing.T) {
 	}
 
 	hookContext := hookContext()
-	hookHints := openfeature.NewHookHints(map[string]interface{}{})
+	hookHints := openfeature.NewHookHints(map[string]any{})
 
 	metricsHook, err := NewMetricsHookForProvider(metric.NewMeterProvider(metric.WithReader(manualReader)))
 	if err != nil {
@@ -307,7 +307,7 @@ func TestMetricHook_MetadataExtractionOptions(t *testing.T) {
 			},
 		},
 	}
-	hookHints := openfeature.NewHookHints(map[string]interface{}{})
+	hookHints := openfeature.NewHookHints(map[string]any{})
 
 	t.Run("from dimensionDescriptions", func(t *testing.T) {
 		// when

hooks/open-telemetry/pkg/otel.go

@@ -0,0 +1,5 @@
+// Package otel provides OpenTelemetry instrumentation for the OpenFeature Go SDK.
+package otel
+
+// ScopeName is the instrumentation scope name.
+const ScopeName = "github.com/open-feature/go-sdk-contrib/hooks/open-telemetry"

hooks/open-telemetry/pkg/traces.go

@@ -3,21 +3,18 @@ package otel
 import (
 	"context"
 	"fmt"
+
 	"github.com/open-feature/go-sdk/openfeature"
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/codes"
-	semconv "go.opentelemetry.io/otel/semconv/v1.18.0"
+	semconv "go.opentelemetry.io/otel/semconv/v1.34.0"
 	"go.opentelemetry.io/otel/trace"
 )
 
-const (
-	EventName                 = "feature_flag"
-	EventPropertyFlagKey      = "feature_flag.key"
-	EventPropertyProviderName = "feature_flag.provider_name"
-	EventPropertyVariant      = "feature_flag.variant"
-)
+// EventName is the name of the span event.
+const EventName = "feature_flag.evaluation"
 
-// traceHook is the hook implementation for OTel traces
+// traceHook is the hook implementation for OTel traces.
 type traceHook struct {
 	setErrorStatus          bool
 	attributeMapperCallback func(openfeature.FlagMetadata) []attribute.KeyValue
@@ -27,7 +24,7 @@ type traceHook struct {
 
 var _ openfeature.Hook = &traceHook{}
 
-// NewTracesHook return a reference to a new instance of the OpenTelemetry Hook
+// NewTracesHook return a reference to a new instance of the OpenTelemetry Hook.
 func NewTracesHook(opts ...Options) *traceHook {
 	h := &traceHook{}
 
@@ -38,14 +35,14 @@ func NewTracesHook(opts ...Options) *traceHook {
 	return h
 }
 
-// After sets the feature_flag event and associated attributes on the span stored in the context
+// After sets the feature_flag event and associated attributes on the span stored in the context.
 func (h *traceHook) After(ctx context.Context, hookContext openfeature.HookContext, flagEvaluationDetails openfeature.InterfaceEvaluationDetails, hookHints openfeature.HookHints) error {
 	attribs := []attribute.KeyValue{
 		semconv.FeatureFlagKey(hookContext.FlagKey()),
 		semconv.FeatureFlagProviderName(hookContext.ProviderMetadata().Name),
 	}
 	if flagEvaluationDetails.Variant != "" {
-		attribs = append(attribs, semconv.FeatureFlagVariant(flagEvaluationDetails.Variant))
+		attribs = append(attribs, semconv.FeatureFlagResultVariant(flagEvaluationDetails.Variant))
 	}
 
 	if h.attributeMapperCallback != nil {
@@ -57,7 +54,7 @@ func (h *traceHook) After(ctx context.Context, hookContext openfeature.HookConte
 	return nil
 }
 
-// Error records the given error against the span and sets the span to an error status
+// Error records the given error against the span and sets the span to an error status.
 func (h *traceHook) Error(ctx context.Context, hookContext openfeature.HookContext, err error, hookHints openfeature.HookHints) {
 	span := trace.SpanFromContext(ctx)
 
@@ -76,16 +73,16 @@ func (h *traceHook) Error(ctx context.Context, hookContext openfeature.HookConte
 
 type Options func(*traceHook)
 
-// WithErrorStatusEnabled enable setting span status to codes.Error in case of an error. Default behavior is disabled
+// WithErrorStatusEnabled enable setting span status to codes.Error in case of an error. Default behavior is disabled.
 func WithErrorStatusEnabled() Options {
 	return func(h *traceHook) {
 		h.setErrorStatus = true
 	}
 }
 
-// WithTracesAttributeSetter allows to set a extractionCallback which accept openfeature.FlagMetadata and returns
+// WithTracesAttributeSetter allows to set a extractionCallback which accept [openfeature.FlagMetadata] and returns
 // []attribute.KeyValue derived from those metadata.
-// If present, returned attributes will be added to successful evaluation traces
+// If present, returned attributes will be added to successful evaluation traces.
 func WithTracesAttributeSetter(callback func(openfeature.FlagMetadata) []attribute.KeyValue) Options {
 	return func(tracesHook *traceHook) {
 		tracesHook.attributeMapperCallback = callback