Extract the function as a common function.

Signed-off-by: Jared Tan <[email protected]>

Author: JaredTan95

.chloggen/refactoring_dimenssion_func_as_util_func.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: exceptionsconnector,servicegraphconnector,spanmetricsconnector
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Extract the `getDimensionValue` function as a common function.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [34627]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: []

connector/exceptionsconnector/connector.go

@@ -6,6 +6,8 @@ package exceptionsconnector // import "github.com/open-telemetry/opentelemetry-c
 import (
 	"go.opentelemetry.io/collector/pdata/pcommon"
 	conventions "go.opentelemetry.io/collector/semconv/v1.18.0"
+
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatautil"
 )
 
 const (
@@ -20,21 +22,16 @@ const (
 	eventNameExc  = "exception"   // OpenTelemetry non-standard constant.
 )
 
-type dimension struct {
-	name  string
-	value *pcommon.Value
-}
-
-func newDimensions(cfgDims []Dimension) []dimension {
+func newDimensions(cfgDims []Dimension) []pdatautil.Dimension {
 	if len(cfgDims) == 0 {
 		return nil
 	}
-	dims := make([]dimension, len(cfgDims))
+	dims := make([]pdatautil.Dimension, len(cfgDims))
 	for i := range cfgDims {
-		dims[i].name = cfgDims[i].Name
+		dims[i].Name = cfgDims[i].Name
 		if cfgDims[i].Default != nil {
 			val := pcommon.NewValueStr(*cfgDims[i].Default)
-			dims[i].value = &val
+			dims[i].Value = &val
 		}
 	}
 	return dims
@@ -47,21 +44,21 @@ func newDimensions(cfgDims []Dimension) []dimension {
 //
 // The ok flag indicates if a dimension value was fetched in order to differentiate
 // an empty string value from a state where no value was found.
-func getDimensionValue(d dimension, spanAttrs pcommon.Map, eventAttrs pcommon.Map, resourceAttr pcommon.Map) (v pcommon.Value, ok bool) {
+func getDimensionValue(d pdatautil.Dimension, spanAttrs pcommon.Map, eventAttrs pcommon.Map, resourceAttr pcommon.Map) (v pcommon.Value, ok bool) {
 	// The more specific span attribute should take precedence.
-	if attr, exists := spanAttrs.Get(d.name); exists {
+	if attr, exists := spanAttrs.Get(d.Name); exists {
 		return attr, true
 	}
-	if attr, exists := eventAttrs.Get(d.name); exists {
+	if attr, exists := eventAttrs.Get(d.Name); exists {
 		return attr, true
 	}
 	// falling back to searching in resource attributes
-	if attr, exists := resourceAttr.Get(d.name); exists {
+	if attr, exists := resourceAttr.Get(d.Name); exists {
 		return attr, true
 	}
 	// Set the default if configured, otherwise this metric will have no value set for the dimension.
-	if d.value != nil {
-		return *d.value, true
+	if d.Value != nil {
+		return *d.Value, true
 	}
 	return v, ok
 }

connector/exceptionsconnector/connector_logs.go

@@ -6,6 +6,8 @@ package exceptionsconnector // import "github.com/open-telemetry/opentelemetry-c
 import (
 	"context"
 
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatautil"
+
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/consumer"
 	"go.opentelemetry.io/collector/pdata/pcommon"
@@ -21,7 +23,7 @@ type logsConnector struct {
 	config Config
 
 	// Additional dimensions to add to logs.
-	dimensions []dimension
+	dimensions []pdatautil.Dimension
 
 	logsConsumer consumer.Logs
 	component.StartFunc
@@ -113,20 +115,13 @@ func (c *logsConnector) attrToLogRecord(sl plog.ScopeLogs, serviceName string, s
 
 	// Add configured dimension attributes to the log record.
 	for _, d := range c.dimensions {
-		if v, ok := getDimensionValue(d, spanAttrs, eventAttrs, resourceAttrs); ok {
-			logRecord.Attributes().PutStr(d.name, v.Str())
+		if v, ok := pdatautil.GetDimensionValue(d, spanAttrs, eventAttrs, resourceAttrs); ok {
+			logRecord.Attributes().PutStr(d.Name, v.Str())
 		}
 	}
 
 	// Add stacktrace to the log record.
-	logRecord.Attributes().PutStr(exceptionStacktraceKey, getValue(eventAttrs, exceptionStacktraceKey))
+	attrVal, _ := pdatautil.GetAttributeValue(exceptionStacktraceKey, eventAttrs)
+	logRecord.Attributes().PutStr(exceptionStacktraceKey, attrVal)
 	return logRecord
 }
-
-// getValue returns the value of the attribute with the given key.
-func getValue(attr pcommon.Map, key string) string {
-	if attrVal, ok := attr.Get(key); ok {
-		return attrVal.Str()
-	}
-	return ""
-}

connector/exceptionsconnector/connector_metrics.go

@@ -9,6 +9,8 @@ import (
 	"sync"
 	"time"
 
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatautil"
+
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/consumer"
 	"go.opentelemetry.io/collector/pdata/pcommon"
@@ -29,7 +31,7 @@ type metricsConnector struct {
 	config Config
 
 	// Additional dimensions to add to metrics.
-	dimensions []dimension
+	dimensions []pdatautil.Dimension
 
 	keyBuf *bytes.Buffer
 
@@ -175,16 +177,16 @@ func (c *metricsConnector) addExemplar(exc *exception, traceID pcommon.TraceID,
 	e.SetDoubleValue(float64(exc.count))
 }
 
-func buildDimensionKVs(dimensions []dimension, serviceName string, span ptrace.Span, eventAttrs pcommon.Map, resourceAttrs pcommon.Map) pcommon.Map {
+func buildDimensionKVs(dimensions []pdatautil.Dimension, serviceName string, span ptrace.Span, eventAttrs pcommon.Map, resourceAttrs pcommon.Map) pcommon.Map {
 	dims := pcommon.NewMap()
 	dims.EnsureCapacity(3 + len(dimensions))
 	dims.PutStr(serviceNameKey, serviceName)
 	dims.PutStr(spanNameKey, span.Name())
 	dims.PutStr(spanKindKey, traceutil.SpanKindStr(span.Kind()))
 	dims.PutStr(statusCodeKey, traceutil.StatusCodeStr(span.Status().Code()))
 	for _, d := range dimensions {
-		if v, ok := getDimensionValue(d, span.Attributes(), eventAttrs, resourceAttrs); ok {
-			v.CopyTo(dims.PutEmpty(d.name))
+		if v, ok := pdatautil.GetDimensionValue(d, span.Attributes(), eventAttrs, resourceAttrs); ok {
+			v.CopyTo(dims.PutEmpty(d.Name))
 		}
 	}
 	return dims
@@ -195,7 +197,7 @@ func buildDimensionKVs(dimensions []dimension, serviceName string, span ptrace.S
 // or resource attributes. If the dimension exists in both, the span's attributes, being the most specific, takes precedence.
 //
 // The metric key is a simple concatenation of dimension values, delimited by a null character.
-func buildKey(dest *bytes.Buffer, serviceName string, span ptrace.Span, optionalDims []dimension, eventAttrs pcommon.Map, resourceAttrs pcommon.Map) {
+func buildKey(dest *bytes.Buffer, serviceName string, span ptrace.Span, optionalDims []pdatautil.Dimension, eventAttrs pcommon.Map, resourceAttrs pcommon.Map) {
 	concatDimensionValue(dest, serviceName, false)
 	concatDimensionValue(dest, span.Name(), true)
 	concatDimensionValue(dest, traceutil.SpanKindStr(span.Kind()), true)

connector/exceptionsconnector/connector_metrics_test.go

@@ -9,6 +9,8 @@ import (
 	"testing"
 	"time"
 
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatautil"
+
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"go.opentelemetry.io/collector/component/componenttest"
@@ -277,7 +279,7 @@ func TestBuildKeyWithDimensions(t *testing.T) {
 	defaultFoo := pcommon.NewValueStr("bar")
 	for _, tc := range []struct {
 		name            string
-		optionalDims    []dimension
+		optionalDims    []pdatautil.Dimension
 		resourceAttrMap map[string]any
 		spanAttrMap     map[string]any
 		wantKey         string
@@ -288,22 +290,22 @@ func TestBuildKeyWithDimensions(t *testing.T) {
 		},
 		{
 			name: "neither span nor resource contains key, dim provides default",
-			optionalDims: []dimension{
-				{name: "foo", value: &defaultFoo},
+			optionalDims: []pdatautil.Dimension{
+				{Name: "foo", Value: &defaultFoo},
 			},
 			wantKey: "ab\u0000c\u0000SPAN_KIND_UNSPECIFIED\u0000STATUS_CODE_UNSET\u0000bar",
 		},
 		{
 			name: "neither span nor resource contains key, dim provides no default",
-			optionalDims: []dimension{
-				{name: "foo"},
+			optionalDims: []pdatautil.Dimension{
+				{Name: "foo"},
 			},
 			wantKey: "ab\u0000c\u0000SPAN_KIND_UNSPECIFIED\u0000STATUS_CODE_UNSET",
 		},
 		{
 			name: "span attribute contains dimension",
-			optionalDims: []dimension{
-				{name: "foo"},
+			optionalDims: []pdatautil.Dimension{
+				{Name: "foo"},
 			},
 			spanAttrMap: map[string]any{
 				"foo": 99,
@@ -312,8 +314,8 @@ func TestBuildKeyWithDimensions(t *testing.T) {
 		},
 		{
 			name: "resource attribute contains dimension",
-			optionalDims: []dimension{
-				{name: "foo"},
+			optionalDims: []pdatautil.Dimension{
+				{Name: "foo"},
 			},
 			resourceAttrMap: map[string]any{
 				"foo": 99,
@@ -322,8 +324,8 @@ func TestBuildKeyWithDimensions(t *testing.T) {
 		},
 		{
 			name: "both span and resource attribute contains dimension, should prefer span attribute",
-			optionalDims: []dimension{
-				{name: "foo"},
+			optionalDims: []pdatautil.Dimension{
+				{Name: "foo"},
 			},
 			spanAttrMap: map[string]any{
 				"foo": 100,

connector/exceptionsconnector/factory_test.go

@@ -7,6 +7,8 @@ import (
 	"context"
 	"testing"
 
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatautil"
+
 	"github.com/stretchr/testify/assert"
 	"go.opentelemetry.io/collector/connector/connectortest"
 	"go.opentelemetry.io/collector/consumer/consumertest"
@@ -19,7 +21,7 @@ func TestNewConnector(t *testing.T) {
 	for _, tc := range []struct {
 		name           string
 		dimensions     []Dimension
-		wantDimensions []dimension
+		wantDimensions []pdatautil.Dimension
 	}{
 		{
 			name: "simplest config (use defaults)",
@@ -30,8 +32,8 @@ func TestNewConnector(t *testing.T) {
 				{Name: "http.method", Default: &defaultMethod},
 				{Name: "http.status_code"},
 			},
-			wantDimensions: []dimension{
-				{name: "http.method", value: &defaultMethodValue},
+			wantDimensions: []pdatautil.Dimension{
+				{Name: "http.method", Value: &defaultMethodValue},
 				{"http.status_code", nil},
 			},
 		},

connector/servicegraphconnector/connector.go

@@ -13,6 +13,8 @@ import (
 	"sync"
 	"time"
 
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatautil"
+
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/consumer"
 	"go.opentelemetry.io/collector/pdata/pcommon"
@@ -262,7 +264,7 @@ func (p *serviceGraphConnector) aggregateMetrics(ctx context.Context, td ptrace.
 
 						// A database request will only have one span, we don't wait for the server
 						// span but just copy details from the client span
-						if dbName, ok := findAttributeValue(p.config.DatabaseNameAttribute, rAttributes, span.Attributes()); ok {
+						if dbName, ok := pdatautil.GetAttributeValue(p.config.DatabaseNameAttribute, rAttributes, span.Attributes()); ok {
 							e.ConnectionType = store.Database
 							e.ServerService = dbName
 							e.ServerLatencySec = spanDuration(span)
@@ -310,15 +312,15 @@ func (p *serviceGraphConnector) aggregateMetrics(ctx context.Context, td ptrace.
 
 func (p *serviceGraphConnector) upsertDimensions(kind string, m map[string]string, resourceAttr pcommon.Map, spanAttr pcommon.Map) {
 	for _, dim := range p.config.Dimensions {
-		if v, ok := findAttributeValue(dim, resourceAttr, spanAttr); ok {
+		if v, ok := pdatautil.GetAttributeValue(dim, resourceAttr, spanAttr); ok {
 			m[kind+"_"+dim] = v
 		}
 	}
 }
 
 func (p *serviceGraphConnector) upsertPeerAttributes(m []string, peers map[string]string, spanAttr pcommon.Map) {
 	for _, s := range m {
-		if v, ok := findAttributeValue(s, spanAttr); ok {
+		if v, ok := pdatautil.GetAttributeValue(s, spanAttr); ok {
 			peers[s] = v
 			break
 		}

connector/servicegraphconnector/util.go

@@ -6,17 +6,10 @@ package servicegraphconnector // import "github.com/open-telemetry/opentelemetry
 import (
 	"go.opentelemetry.io/collector/pdata/pcommon"
 	semconv "go.opentelemetry.io/collector/semconv/v1.9.0"
-)
 
-func findAttributeValue(key string, attributes ...pcommon.Map) (string, bool) {
-	for _, attr := range attributes {
-		if v, ok := attr.Get(key); ok {
-			return v.AsString(), true
-		}
-	}
-	return "", false
-}
+	"github.com/open-telemetry/opentelemetry-collector-contrib/pkg/pdatautil"
+)
 
 func findServiceName(attributes pcommon.Map) (string, bool) {
-	return findAttributeValue(semconv.AttributeServiceName, attributes)
+	return pdatautil.GetAttributeValue(semconv.AttributeServiceName, attributes)
 }