feat: database/sql integration

[aldy505]

Queries insights tracing for Go.

[codecov]

Codecov Report

Attention: Patch coverage is 70.71823% with 106 lines in your changes missing coverage. Please review.

Project coverage is 82.48%. Comparing base (9b8b7be) to head (31ef60f).
Report is 15 commits behind head on master.

Files with missing lines	Patch %	Lines
sentrysql/conn.go	65.00%	54 Missing and 2 partials ⚠️
sentrysql/stmt.go	68.26%	30 Missing and 3 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   83.21%   82.48%   -0.73%     
==========================================
  Files          55       62       +7     
  Lines        5897     6259     +362     
==========================================
+ Hits         4907     5163     +256     
- Misses        820      919      +99     
- Partials      170      177       +7     

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

[aldy505]

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

[aldy505]

Should be good by now.

[ribice]

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

[ribice]

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

[aldy505]

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.

[ribice]

LGTM Overall. Still misses some tests for the coverage, entry in CHANGELOG.MD and documentation in main repo and sentry-docs.

[aldy505]

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]

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]

• 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.

[aldy505]

This section is not covered by tests, yet I don't know how to make it so.

I've added this check beforehand:

if s.ctx == nil && ctx != nil {
  s.ctx = ctx
}

But it doesn't seem to help anyway.

[jazzido]

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