Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Starfish] Add db attributes to database span's span data #2088

Closed
Tracked by #19
AbhiPrasad opened this issue Aug 9, 2023 · 0 comments · Fixed by #2100
Closed
Tracked by #19

[Starfish] Add db attributes to database span's span data #2088

AbhiPrasad opened this issue Aug 9, 2023 · 0 comments · Fixed by #2100
Assignees

Comments

@AbhiPrasad
Copy link
Member

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

Parent issue: getsentry/team-sdks#19

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.

Attribute Type Description Examples Requirement Level
db.system string An identifier for the database management system (DBMS) product being used. mysql Required
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.
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.

These values should be set on span.data.

Motivation

This is being done for the Sentry's new performance views for databases. See a WIP example of the view below:

image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants