Project: Starfish Module: Queries

[AbhiPrasad]

Project Board

To get an overview of this work across all SDKs, please visit:
https://github.com/orgs/getsentry/projects/135

Description

For the starfish db module it was determined that we need extra database attributes, specifically about the database connection attributes.

We're going to matching the otel db conventions. Either one of server.address or server.socket.address is required. If server.address is set, then server.port should be set. If server.port is different than server.socket.port, than server.socket.port should also be set. In addition, db.name should be set if possible. db.system should match the list in OpenTelemetry's well known conventions.

The main priority items are db.name and db.system

Attribute	Type	Description	Examples	Requirement Level
db.system	string	An identifier for the database management system (DBMS) product being used.	mysql	Required
db.name	string	This attribute is used to report the name of the database being accessed. For commands that switch the database, this should be set to the target database (even if the command fails).	customers; main	Conditionally Required: If applicable.
server.address	string	Name of the database host.	example.com	Conditionally Required: See alternative attributes below.
server.port	int	Logical server port number	80; 8080; 443	Conditionally Required: [1]
server.socket.address	string	Physical server IP address or Unix socket address.	10.5.3.2	See below
server.socket.port	int	Physical server port.	16456	Recommended: If different than server.port.

These values should be set on span.data.

NOTE: For the Mobile SDKs only db.name and db.system is required

SDKs to update

Beta Give feedback

1. Add db connection attributes to database span's span data sentry-python#2270
   +0
   
2. [Starfish] Add db attributes to database span's span data sentry-javascript#8771
   4 of 4
   Feature: Performance +1
   
3. [Starfish] Add db attributes to database span's span data sentry-laravel#765
   Type: Improvement +1
   
4. [Starfish] Add db attributes to database span's span data sentry-dotnet#2536
   +0
   
5. [Starfish] Add db attributes to database span's span data sentry-ruby#2088
   enhancement +1
   
6. [Starfish] Add db attributes to database span's span data sentry-java#2893
   Platform: Android Platform: Java +2
   
7. [Starfish] Add db attributes to database span's span data sentry-dart#1594
   Platform: Dart performance +2
   
8. [Starfish] Add db attributes to database span's span data sentry-cocoa#3212
   Platform: Cocoa +1
   
9. Go SDK

RFC

No response

Slack-Channel

#discuss-starfish

Notion Document(s)

No response

Stakeholder(s)

@alexjillard and @gggritso

Team(s)

Web Backend, Web Frontend, Starfish

[marandaneto]

db.name applies to Mobile SDKs as well, added the Mobile label.

[AbhiPrasad]

We've updated https://develop.sentry.dev/sdk/performance/span-data-conventions/#database to better reflect the new attributes we are setting here.

[AbhiPrasad]

Opened getsentry/sentry-java#2930 as a follow up but does not block the starfish DB module so closing this issue.