Skip to content

Commit fc08be9

Browse files
authored
Fix X-Ray DB subsegment name with JDBC Connection String (#33225)
**Description:** <Describe what has changed.> 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([email protected]) ``` **Link to tracking Issue:** <Issue number if applicable> **Testing:** <Describe what testing was performed and which tests were added.> local tests
1 parent f17d5cc commit fc08be9

File tree

3 files changed

+32
-2
lines changed

3 files changed

+32
-2
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: bug_fix
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: awsxrayexporter
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Fix the DB subsegment(client span) name with JDBC conn string starts with "jdbc:"
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [33225]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: []

exporter/awsxrayexporter/internal/translator/segment.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,10 @@ func MakeSegment(span ptrace.Span, resource pcommon.Resource, indexedAttrs []str
418418
// For database queries, the segment name convention is <db name>@<db host>
419419
name = dbInstance.Str()
420420
if dbURL, ok := attributes.Get(conventions.AttributeDBConnectionString); ok {
421-
if parsed, _ := url.Parse(dbURL.Str()); parsed != nil {
421+
// Trim JDBC connection string if starts with "jdbc:", otherwise no change
422+
// jdbc:mysql://db.dev.example.com:3306
423+
dbURLStr := strings.TrimPrefix(dbURL.Str(), "jdbc:")
424+
if parsed, _ := url.Parse(dbURLStr); parsed != nil {
422425
if parsed.Hostname() != "" {
423426
name += "@" + parsed.Hostname()
424427
}

exporter/awsxrayexporter/internal/translator/segment_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ func TestClientSpanWithDbComponent(t *testing.T) {
226226
attributes[conventions.AttributeDBName] = "customers"
227227
attributes[conventions.AttributeDBStatement] = spanName
228228
attributes[conventions.AttributeDBUser] = "userprefsvc"
229-
attributes[conventions.AttributeDBConnectionString] = "mysql://db.dev.example.com:3306"
229+
attributes[conventions.AttributeDBConnectionString] = "jdbc:mysql://db.dev.example.com:3306"
230230
attributes[conventions.AttributeNetPeerName] = "db.dev.example.com"
231231
attributes[conventions.AttributeNetPeerPort] = "3306"
232232
attributes["enterprise.app.id"] = enterpriseAppID

0 commit comments

Comments
 (0)