feat: database/sql integration #893

aldy505 · 2024-10-18T10:21:52Z

Queries insights tracing for Go.

sentrysql/conn.go

sentrysql/stmt.go

codecov · 2024-10-19T02:29:18Z

Codecov Report

Attention: Patch coverage is 82.30563% with 66 lines in your changes missing coverage. Please review.

Project coverage is 83.89%. Comparing base (7996759) to head (9b12d0a).
Report is 4 commits behind head on master.

Files with missing lines	Patch %	Lines
sentrysql/conn.go	81.65%	25 Missing and 6 partials ⚠️
sentrysql/stmt.go	83.01%	13 Missing and 5 partials ⚠️
sentrysql/driver.go	63.15%	13 Missing and 1 partial ⚠️
sentrysql/sentrysql.go	90.90%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #893      +/-   ##
==========================================
- Coverage   84.00%   83.89%   -0.12%     
==========================================
  Files          50       57       +7     
  Lines        5171     5544     +373     
==========================================
+ Hits         4344     4651     +307     
- Misses        673      726      +53     
- Partials      154      167      +13

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

aldy505 · 2024-10-19T02:29:52Z

I really don't like golangci-lint, it's so pedantic :(

aldy505 · 2024-10-19T05:20:24Z

Should be good by now.

sentrysql/operation.go

sentrysql/operation_test.go

ribice · 2024-10-22T10:55:42Z

I'll test this locally myself this week and report back. We should also update the docs and main repository with this integration.

ribice · 2024-10-25T11:48:33Z

You're missing examples in _examples. These should also include example on how to set the DSN.

aldy505 · 2024-10-25T12:25:30Z

You're missing examples in _examples. These should also include example on how to set the DSN.

@ribice I've been occupied so much with work this week. Will find the time to work on this later.

aldy505 · 2024-10-27T12:47:49Z

LGTM Overall. Still misses some tests for the coverage

To be honest, I don't know how to make some of that as covered other than using old Go versions. But I might try creating another database driver implementation that does not implement XXXContext method.

...documentation in main repo and sentry-docs.

I might be able to help with the sentry-docs one, since I also need to update some of the self-hosted docs.

cleptric · 2024-10-28T08:25:58Z

I haven't reviewed this PR in full yet, but some things I would like to be changed:

I would suggest we start with https://pkg.go.dev/database only, I'm not keen to add support for 3rd party libraries right away.
If we end up adding 3rd party dependencies, we should publish this as it's own package. See https://github.com/getsentry/sentry-go/tree/master/otel for prior art.
We also support Mongo DB in our Insights query module, so the naming of the package could be more generic, such as sentrydatabase
nolint is an immediate code smell.

aldy505 · 2024-11-02T12:05:55Z

I would suggest we start with https://pkg.go.dev/database only, I'm not keen to add support for 3rd party libraries right away.

If we end up adding 3rd party dependencies, we should publish this as it's own package. See https://github.com/getsentry/sentry-go/tree/master/otel for prior art.

We are not supporting 3rd party libraries here. We only import the database driver since Go does not bring built-in database drivers and rely on third party drivers. The database drivers we're using should not going to be compiled to the resulting binary since it's only used in tests.

Although it seems like we're using it as a library here, it is not, it's still considered a database driver:

sentry-go/_examples/sql/main.go

Lines 40 to 45 in c5fa49d

	// Create a database connection for read database.
	connector, err := pq.NewConnector("postgres://postgres:[email protected]:5432/postgres")
	if err != nil {
	fmt.Printf("failed to create a postgres connector: %s\n", err.Error())
	return
	}

We also support Mongo DB in our Insights query module, so the naming of the package could be more generic, such as sentrydatabase

MongoDB does not have and does not conform to the database/sql driver. So we're not going to add it into the enum here. Instrumentation for MongoDB should be specific for the Go MongoDB library.

nolint is an immediate code smell.

Since we're wrapping a database driver and thus making us another database driver, we are required to implement multiple methods that are considered duplicates by the linter, yet again, from the driver documentation, we're still required to implement those.

sentrysql/stmt.go

jazzido · 2024-11-28T18:09:48Z

Don't let this die! :) I'm sure many of us in the community will be grateful for an officially supported DB integration

…xecContext

go.mod

giortzisg

Overall looks good with the most recent changes and should be functionally correct. Just wanna be sure that the context is passed correctly and also add some minor improvements

sentrysql/conn.go

giortzisg

some test changes.

sentrysql/sentrysql_legacy_test.go

sentrysql/go.mod

…he diff

giortzisg · 2025-05-14T07:46:32Z

sentrysql/sentrysql_connector_test.go

+			// if WantSpan is nil, yet we got some spans, it should be an error
+			if tt.WantSpan == nil {
+				t.Errorf("Expecting no spans, but got %d spans: %v", len(gotSpans), gotSpans)
+				continue
+			}
+
+			// if WantSpan is not nil, we should have at least one span
+			if len(gotSpans) == 0 {
+				t.Errorf("Expecting at least one span, but got %d spans: %v", len(gotSpans), gotSpans)
+				continue
+			}
+


Can we not have tt.WantSpans as a []Span so that we can compare immediately with gotSpans? I'd say that it's not very readable.

Did some rounds with this, I can't get []Span comparison working (problems with google/go-cmp package). Is it okay if we backlog this somehow?

giortzisg · 2025-05-14T07:48:12Z

sentrysql/sentrysql_test.go

+func TestMain(m *testing.M) {
+	sql.Register("sentrysql-sqlite", sentrysql.NewSentrySQL(&sqlite.Driver{}, sentrysql.WithDatabaseName("memory"), sentrysql.WithDatabaseSystem(sentrysql.DatabaseSystem("sqlite")), sentrysql.WithServerAddress("localhost", "5432")))
+	// sentrysql-legacy is used by `sentrysql_legacy_test.go`
+	sql.Register("sentrysql-legacy", sentrysql.NewSentrySQL(ldriver, sentrysql.WithDatabaseSystem(sentrysql.DatabaseSystem("legacydb")), sentrysql.WithDatabaseName("fake")))
+
+	os.Exit(m.Run())
+}


This is obfuscated from the other tests. Should probably be an init statement on each file that registers whatever we need only for the tests on the file.

From the docs: If Register is called twice with the same name or if driver is nil, it panics.

I believe setting this here is the "right" way to do so, since it'll be run after any library's init invocation.

giortzisg · 2025-05-14T07:56:11Z

sentrysql/sentrysql_test.go

+			var foundMatch = false
+			gotSpans := got[i]
+
+			var diffs []string
+			for _, gotSpan := range gotSpans {
+				if diff := cmp.Diff(tt.WantSpan, gotSpan, optstrans); diff != "" {
+					diffs = append(diffs, diff)
+				} else {
+					foundMatch = true
+					break
+				}
+			}
+
+			if !foundMatch {
+				t.Errorf("Span mismatch (-want +got):\n%s", strings.Join(diffs, "\n"))
+			}


Same thing applies here. We should probably use a []Span for WantSpans

Copilot

Pull Request Overview

Adds Sentry tracing integration to Go’s database/sql by wrapping drivers, connectors, connections, statements, and transactions to automatically start spans for SQL operations.

Introduce sentrySQLConfig and Option functions to attach metadata (db system, name, host, port).
Wrap driver.Driver, driver.Connector, driver.Conn, and driver.Stmt to emit spans on Exec/Query (including context versions).
Add parseDatabaseOperation helper to extract SQL operation names and tests for it.

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
sentrysql/tx.go	Added `sentryTx` wrapper for `driver.Tx` (currently no spans).
sentrysql/stmt.go	Implemented `sentryStmt` with Exec/Query and ExecContext/QueryContext tracing.
sentrysql/sentrysql.go	Defined `DatabaseSystem`, config struct, and constructors (`NewSentrySQL`, `NewSentrySQLConnector`).
sentrysql/options.go	Added `Option` functions to set database metadata.
sentrysql/operation.go	Added `parseDatabaseOperation` to derive operation names.
sentrysql/operation_test.go	Added tests for `parseDatabaseOperation`.
sentrysql/driver.go	Wrapped `driver.Driver` and `driver.Connector` for injection.
sentrysql/conn.go	Implemented `sentryConn` with span creation for Exec/Query/Ping/Tx.
sentrysql/go.mod	Initialized module and dependencies.
sentrysql/example_test.go	Added examples for `NewSentrySQL` and `NewSentrySQLConnector`.
_examples/sql/main.go	End-to-end example demonstrating tracing of queries and transactions.

Comments suppressed due to low confidence (1)

sentrysql/stmt.go:75

There are no unit tests covering ExecContext and QueryContext in sentryStmt. Adding tests would verify span creation and fallback behavior.

func (s *sentryStmt) ExecContext(ctx context.Context, args []driver.NamedValue) (driver.Result, error)

Copilot · 2025-06-17T11:06:28Z

sentrysql/stmt.go

+		return s.Exec(values)
+	}
+
+	parentSpan := sentry.SpanFromContext(s.ctx)


In ExecContext, you’re calling SpanFromContext on s.ctx instead of the passed-in ctx. This can attach spans to a stale context. Use sentry.SpanFromContext(ctx) instead.

Suggested change

parentSpan := sentry.SpanFromContext(s.ctx)

parentSpan := sentry.SpanFromContext(ctx)

This is wrong. ctx provided from the function argument does not have sentry span context. SInce what matters is the context in which the statement was started.

Copilot · 2025-06-17T11:06:28Z

sentrysql/stmt.go

+		return s.Query(values)
+	}
+
+	parentSpan := sentry.SpanFromContext(s.ctx)


In QueryContext, you’re using s.ctx for the parent span lookup instead of the method’s ctx parameter. Update to sentry.SpanFromContext(ctx) to ensure the correct context is used.

Suggested change

parentSpan := sentry.SpanFromContext(s.ctx)

parentSpan := sentry.SpanFromContext(ctx)

This is wrong. ctx provided from the function argument does not have sentry span context. SInce what matters is the context in which the statement was started.

Copilot · 2025-06-17T11:06:29Z

sentrysql/tx.go

+type sentryTx struct {
+	originalTx driver.Tx
+	ctx        context.Context
+	config     *sentrySQLConfig


[nitpick] The config field in sentryTx is never used. Consider removing it or adding tracing for Commit/Rollback to leverage the config metadata.

Tracing on Commit / Rollback would be useless.

aldy505 added 5 commits October 18, 2024 17:21

feat: initial sentrysql implementation

e544314

chore: resolve a few lint issues

92e3a6b

chore: another attempt at resolving lint issues

aa4acb2

chore: wrong method name

a6b5de8

chore: another attempt of fixing lint issues

c6ebbda

ribice reviewed Oct 18, 2024

View reviewed changes

sentrysql/conn.go Outdated Show resolved Hide resolved

ribice reviewed Oct 18, 2024

View reviewed changes

sentrysql/stmt.go Outdated Show resolved Hide resolved

ribice reviewed Oct 18, 2024

View reviewed changes

sentrysql/stmt.go Outdated Show resolved Hide resolved

ribice reviewed Oct 18, 2024

View reviewed changes

sentrysql/stmt.go Outdated Show resolved Hide resolved

aldy505 added 3 commits October 19, 2024 08:51

feat: implement missing bits from driver interfaces

63413f3

chore: missing a period on comment

b77e392

test: replace ramsql with in-memory sqlite

9b59328

aldy505 added 8 commits October 19, 2024 10:22

test: common queries

7ecd868

chore: avoid cyclo errors

19c97df

test: no parent span

d9073aa

test: db.Driver

05d699b

chore: trailing newline

0fc642e

test: using mysql server for connector

7b5fbb5

test: remove mysql server, stay on go1.18

93198bd

chore: another go1.18 rollback

ab1d3bf

aldy505 marked this pull request as ready for review October 19, 2024 05:20

aldy505 requested a review from ribice October 19, 2024 05:20

ribice reviewed Oct 20, 2024

View reviewed changes

sentrysql/operation.go Outdated Show resolved Hide resolved

ribice reviewed Oct 20, 2024

View reviewed changes

sentrysql/operation_test.go Show resolved Hide resolved

Merge remote-tracking branch 'origin/master' into feat/sentrysql

a6e4fd4

test(sentrysql): test against legacy driver

1f38b9f

aldy505 commented Nov 2, 2024

View reviewed changes

sentrysql/stmt.go Show resolved Hide resolved

aldy505 added 4 commits November 2, 2024 20:39

chore(sentrysql): remove unvisited context check

f173533

chore: lint

bcc99fc

chore(sentrysql): make sure we implement required interfaces

38ba84c

Merge branch 'master' into feat/sentrysql

31ef60f

cleptric self-assigned this Dec 6, 2024

cleptric added the Type: Feature label Dec 6, 2024

cleptric assigned giortzisg Apr 17, 2025

stephanie-anderson added Feature Issue type and removed Type: Feature labels Apr 25, 2025

aldy505 added 2 commits April 25, 2025 21:33

Merge remote-tracking branch 'origin/master' into feat/sentrysql

2802546

ref(sentrysql): don't return ErrSkip for conn.QueryContext and conn.E…

0020dcc

…xecContext

giortzisg reviewed Apr 25, 2025

View reviewed changes

go.mod Outdated Show resolved Hide resolved

ref: move sentrysql to dedicated module

7cd3b58

giortzisg reviewed Apr 25, 2025

View reviewed changes

sentrysql/conn.go Outdated Show resolved Hide resolved

sentrysql/conn.go Outdated Show resolved Hide resolved

sentrysql/conn.go Show resolved Hide resolved

sentrysql/conn.go Show resolved Hide resolved

ref(sentrysql): set context before accesing non-context methods

3178fa9

giortzisg requested changes Apr 28, 2025

View reviewed changes

sentrysql/sentrysql_legacy_test.go Show resolved Hide resolved

sentrysql/sentrysql_legacy_test.go Show resolved Hide resolved

cleptric reviewed May 6, 2025

View reviewed changes

sentrysql/go.mod Outdated Show resolved Hide resolved

test(sentrysql): check for received and want spans before observing t…

9b12d0a

…he diff

aldy505 requested a review from giortzisg May 7, 2025 03:40

giortzisg reviewed May 14, 2025

View reviewed changes

cleptric requested review from Copilot and cleptric June 17, 2025 11:03

Copilot AI reviewed Jun 17, 2025

View reviewed changes

	parentSpan := sentry.SpanFromContext(s.ctx)
	parentSpan := sentry.SpanFromContext(ctx)

feat: database/sql integration #893

Are you sure you want to change the base?

feat: database/sql integration #893

Uh oh!

Conversation

aldy505 commented Oct 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Oct 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

aldy505 commented Oct 19, 2024

Uh oh!

aldy505 commented Oct 19, 2024

Uh oh!

Uh oh!

Uh oh!

ribice commented Oct 22, 2024

Uh oh!

ribice commented Oct 25, 2024

Uh oh!

aldy505 commented Oct 25, 2024

Uh oh!

aldy505 commented Oct 27, 2024

Uh oh!

cleptric commented Oct 28, 2024

Uh oh!

aldy505 commented Nov 2, 2024

Uh oh!

Uh oh!

jazzido commented Nov 28, 2024

Uh oh!

Uh oh!

giortzisg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

giortzisg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

aldy505 commented Oct 18, 2024 •

edited

Loading

codecov bot commented Oct 19, 2024 •

edited

Loading