[connector/servicegraph] Change database_name_attribute to accept a list of values (#39133)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
Supporting a prioritized list of attribute names for database
identification (e.g., db.name, db.system, db.system.name, database.name,
sql.database)

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes
#37777

<!--Describe what testing was performed and which tests were added.-->
#### Testing

<!--Describe the documentation added.-->
#### Documentation

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Signed-off-by: Jared Tan <[email protected]>
Co-authored-by: Antoine Toulme <[email protected]>

Author: JaredTan95

.chloggen/change_database_name_attribute_to_accept_a_list_of_values.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: servicegraphconnector
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Change database_name_attribute to accept a list of values.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [37777]
+
+# (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/servicegraphconnector/README.md

@@ -140,8 +140,10 @@ The following settings can be optionally configured:
   - Default: `false`
 - `metrics_flush_interval`: the interval at which metrics are flushed to the exporter.
   - Default: `60s`
-- `database_name_attribute`: the attribute name used to identify the database name from span attributes.
+- `database_name_attribute`(DEPRECATED): the attribute name used to identify the database name from span attributes.
   - Default: `db.name`
+- `database_name_attributes`: the list of attribute names used to identify the database name from span attributes. The attributes are tried in order, selecting the first match.
+  - Default: `[db.name]`
 
 ## Example configurations
 

connector/servicegraphconnector/config.go

@@ -49,7 +49,12 @@ type Config struct {
 
 	// DatabaseNameAttribute is the attribute name used to identify the database name from span attributes.
 	// The default value is db.name.
+	// Deprecated: [v0.124.0] Use database_name_attributes instead.
 	DatabaseNameAttribute string `mapstructure:"database_name_attribute"`
+
+	// DatabaseNameAttributes is the attribute name list of attributes need to match used to identify the database name from span attributes, the higher the front, the higher the priority.
+	// The default value is {"db.name"}.
+	DatabaseNameAttributes []string `mapstructure:"database_name_attributes"`
 }
 
 type StoreConfig struct {

connector/servicegraphconnector/connector.go

@@ -48,7 +48,7 @@ var (
 		semconv.AttributePeerService, semconv.AttributeDBName, semconv.AttributeDBSystem,
 	}
 
-	defaultDatabaseNameAttribute = semconv.AttributeDBName
+	defaultDatabaseNameAttributes = []string{semconv.AttributeDBName}
 
 	defaultMetricsFlushInterval = 60 * time.Second // 1 DPM
 )
@@ -115,8 +115,10 @@ func newConnector(set component.TelemetrySettings, config component.Config, next
 		pConfig.VirtualNodePeerAttributes = defaultPeerAttributes
 	}
 
-	if pConfig.DatabaseNameAttribute == "" {
-		pConfig.DatabaseNameAttribute = defaultDatabaseNameAttribute
+	if pConfig.DatabaseNameAttribute != "" {
+		pConfig.DatabaseNameAttributes = append(pConfig.DatabaseNameAttributes, pConfig.DatabaseNameAttribute)
+	} else if len(pConfig.DatabaseNameAttributes) == 0 {
+		pConfig.DatabaseNameAttributes = defaultDatabaseNameAttributes
 	}
 
 	if pConfig.MetricsFlushInterval == nil {
@@ -273,7 +275,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 := pdatautil.GetAttributeValue(p.config.DatabaseNameAttribute, rAttributes, span.Attributes()); ok {
+						if dbName, ok := getFirstMatchingValue(p.config.DatabaseNameAttributes, rAttributes, span.Attributes()); ok {
 							e.ConnectionType = store.Database
 							e.ServerService = dbName
 							e.ServerLatencySec = spanDuration(span)

connector/servicegraphconnector/util.go

@@ -13,3 +13,14 @@ import (
 func findServiceName(attributes pcommon.Map) (string, bool) {
 	return pdatautil.GetAttributeValue(semconv.AttributeServiceName, attributes)
 }
+
+func getFirstMatchingValue(keys []string, attributes ...pcommon.Map) (string, bool) {
+	for _, key := range keys {
+		for _, attr := range attributes {
+			if v, ok := pdatautil.GetAttributeValue(key, attr); ok {
+				return v, true
+			}
+		}
+	}
+	return "", false
+}

connector/servicegraphconnector/util_test.go

@@ -0,0 +1,52 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package servicegraphconnector
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"go.opentelemetry.io/collector/pdata/pcommon"
+)
+
+func TestGetFirstMatchingValue(t *testing.T) {
+	attr1 := pcommon.NewMap()
+	attr1.PutStr("key1", "value1")
+	attr1.PutStr("key2", "value2")
+	attrs := []pcommon.Map{attr1}
+
+	tests := []struct {
+		name      string
+		keys      []string
+		want      string
+		wantFound bool
+	}{
+		{
+			name:      "Found in first attribute",
+			keys:      []string{"key1"},
+			want:      "value1",
+			wantFound: true,
+		},
+		{
+			name:      "Found in second attribute",
+			keys:      []string{"key2"},
+			want:      "value2",
+			wantFound: true,
+		},
+		{
+			name:      "Not found",
+			keys:      []string{"key3"},
+			want:      "",
+			wantFound: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, gotFound := getFirstMatchingValue(tt.keys, attrs...)
+			assert.Equal(t, tt.want, got)
+			assert.Equal(t, tt.wantFound, gotFound)
+		})
+	}
+}