From fc08be9e4ef3a3ee5bb1786aa7fbc65b235c83f1 Mon Sep 17 00:00:00 2001 From: Min Xia Date: Thu, 30 May 2024 09:44:09 -0700 Subject: [PATCH] Fix X-Ray DB subsegment name with JDBC Connection String (#33225) **Description:** Using the DB span example below, X-Ray exporter failed to generate the expected DB call subsegment names because it could not parse JDBC connection strings that start with the `jdbc:` prefix. ``` Span #1 Trace ID : 663a0b68a5e3849c09c07f914b3df738 Parent ID : 1052e2a4a2516884 ID : 374de78b552e23c2 Name : orders@no-appsignals-mysql-1.cnkqok6c8mo1.eu-west-1.rds.amazonaws.com Kind : Client Start time : 2024-05-07 11:07:20.62 +0000 UTC End time : 2024-05-07 11:07:20.624 +0000 UTC Status code : Unset Status message : Attributes: -> db.connection_string: Str(jdbc:mysql://no-appsignals-mysql-1.cnkqok6c8mo1.eu-west-1.rds.amazonaws.com:3306) -> db.name: Str(orders) -> db.system: Str(MySQL) -> db.user: Str(myuser@10.0.149.233) ``` **Link to tracking Issue:** **Testing:** local tests --- .chloggen/awsxrayexporter_jdbc_fix.yaml | 27 +++++++++++++++++++ .../internal/translator/segment.go | 5 +++- .../internal/translator/segment_test.go | 2 +- 3 files changed, 32 insertions(+), 2 deletions(-) create mode 100644 .chloggen/awsxrayexporter_jdbc_fix.yaml diff --git a/.chloggen/awsxrayexporter_jdbc_fix.yaml b/.chloggen/awsxrayexporter_jdbc_fix.yaml new file mode 100644 index 000000000000..c160f14badf1 --- /dev/null +++ b/.chloggen/awsxrayexporter_jdbc_fix.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: bug_fix + +# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) +component: awsxrayexporter + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Fix the DB subsegment(client span) name with JDBC conn string starts with "jdbc:" + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +issues: [33225] + +# (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: [] diff --git a/exporter/awsxrayexporter/internal/translator/segment.go b/exporter/awsxrayexporter/internal/translator/segment.go index 5fe72117aeeb..9460f1ce5c67 100644 --- a/exporter/awsxrayexporter/internal/translator/segment.go +++ b/exporter/awsxrayexporter/internal/translator/segment.go @@ -418,7 +418,10 @@ func MakeSegment(span ptrace.Span, resource pcommon.Resource, indexedAttrs []str // For database queries, the segment name convention is @ name = dbInstance.Str() if dbURL, ok := attributes.Get(conventions.AttributeDBConnectionString); ok { - if parsed, _ := url.Parse(dbURL.Str()); parsed != nil { + // Trim JDBC connection string if starts with "jdbc:", otherwise no change + // jdbc:mysql://db.dev.example.com:3306 + dbURLStr := strings.TrimPrefix(dbURL.Str(), "jdbc:") + if parsed, _ := url.Parse(dbURLStr); parsed != nil { if parsed.Hostname() != "" { name += "@" + parsed.Hostname() } diff --git a/exporter/awsxrayexporter/internal/translator/segment_test.go b/exporter/awsxrayexporter/internal/translator/segment_test.go index 7acd7428084d..8426e2e976ac 100644 --- a/exporter/awsxrayexporter/internal/translator/segment_test.go +++ b/exporter/awsxrayexporter/internal/translator/segment_test.go @@ -226,7 +226,7 @@ func TestClientSpanWithDbComponent(t *testing.T) { attributes[conventions.AttributeDBName] = "customers" attributes[conventions.AttributeDBStatement] = spanName attributes[conventions.AttributeDBUser] = "userprefsvc" - attributes[conventions.AttributeDBConnectionString] = "mysql://db.dev.example.com:3306" + attributes[conventions.AttributeDBConnectionString] = "jdbc:mysql://db.dev.example.com:3306" attributes[conventions.AttributeNetPeerName] = "db.dev.example.com" attributes[conventions.AttributeNetPeerPort] = "3306" attributes["enterprise.app.id"] = enterpriseAppID